From 4ea1e233610e78a6ad6b7af6bef1f2dce9b673f5 Mon Sep 17 00:00:00 2001 From: Philipp Heckel Date: Sat, 3 Sep 2022 15:34:34 -0400 Subject: [PATCH] Docker install docs --- docs/install.md | 5 +++++ docs/releases.md | 3 +++ 2 files changed, 8 insertions(+) diff --git a/docs/install.md b/docs/install.md index 4a2bc7ac..efbd2fb2 100644 --- a/docs/install.md +++ b/docs/install.md @@ -228,6 +228,11 @@ The server exposes its web UI and the API on port 80, so you need to expose that [message cache](config.md#message-cache), you also need to map a volume to `/var/cache/ntfy`. To change other settings, you should map `/etc/ntfy`, so you can edit `/etc/ntfy/server.yml`. +!!! info + Note that the Docker image **does not contain a `/etc/ntfy/server.yml` file**. If you'd like to use a config file, + please manually create one outside the image and map it as a volume, e.g. via `-v /etc/ntfy:/etc/ntfy`. You may + use the [`server.yml` file on GitHub](https://github.com/binwiederhier/ntfy/blob/main/server/server.yml) as a template. + Basic usage (no cache or additional config): ``` docker run -p 80:80 -it binwiederhier/ntfy serve diff --git a/docs/releases.md b/docs/releases.md index 7dd24fc5..c52a9d6f 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -42,10 +42,13 @@ Thank you to [@wunter8](https://github.com/wunter8) for proactively picking up s * `ntfy user` commands don't work with `auth_file` but works with `auth-file` ([#344](https://github.com/binwiederhier/ntfy/issues/344), thanks to [@Histalek](https://github.com/Histalek) for reporting) * Ignore new draft HTTP `Priority` header ([#351](https://github.com/binwiederhier/ntfy/issues/351), thanks to [@ksurl](https://github.com/ksurl) for reporting) * Delete expired attachments based on mod time instead of DB entry to avoid races (no ticket) +* Better logging for Matrix push key errors ([#384](https://github.com/binwiederhier/ntfy/pull/384), thanks to [@christophehenry](https://github.com/christophehenry)) **Documentation:** * Fix some PowerShell publish docs ([#345](https://github.com/binwiederhier/ntfy/pull/345), thanks to [@noahpeltier](https://github.com/noahpeltier)) +* Clarified Docker install instructions ([#361](https://github.com/binwiederhier/ntfy/issues/361), thanks to [@barart](https://github.com/barart) for reporting) +* Mismatched quotation marks ([#392](https://github.com/binwiederhier/ntfy/pull/392)], thanks to [@connorlanigan](https://github.com/connorlanigan)) -->