From 5eefdb0e99c817fe46adf67afe8510a9075223dc Mon Sep 17 00:00:00 2001 From: Jean Froment Date: Mon, 7 Mar 2022 00:38:30 +0100 Subject: [PATCH] Typos + additions in doc --- config.sample.yaml | 5 +++-- doc/UPGRADE_V2.md | 1 + doc/configuration.md | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/config.sample.yaml b/config.sample.yaml index 82eb600..c300c54 100644 --- a/config.sample.yaml +++ b/config.sample.yaml @@ -19,7 +19,7 @@ services: # Uncomment to specify custom schme (http by default) # internalScheme: http # Uncomment to *NOT* generate LetsEncrypt certificate (useful for local domains) - # disableCertificateGeneration: true + # httpOnly: true - name: flood enabled: true vpn: false @@ -221,7 +221,8 @@ services: httpAuth: true internalPort: 8384 - name: heimdall - enabled: true + # Beware to the host when enabling it! + enabled: false vpn: false traefik: enabled: true diff --git a/doc/UPGRADE_V2.md b/doc/UPGRADE_V2.md index 15b1b74..7e2562a 100644 --- a/doc/UPGRADE_V2.md +++ b/doc/UPGRADE_V2.md @@ -39,6 +39,7 @@ Since there are some breaking changes and a configuration structure migration, a * ``Readarr``: [Ebook and comic monitor](https://github.com/Readarr/Readarr) * ``Komga``: [Comic Book Manager](https://github.com/gotson/komga) * ``Kavita``: [Comic / Book Manager](https://github.com/Kareadita/Kavita) + * ``Syncthing``: [P2P files synchronization](https://github.com/linuxserver/docker-syncthing) * ⚠️ Docker compose v2.2+ is now required And also: diff --git a/doc/configuration.md b/doc/configuration.md index 104d98c..d5bc28d 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -95,7 +95,7 @@ Also, do not forget to edit your ``.env`` file, which is where all the data whic Let's say you want to add a container nginx without interfering or creating conflicts in this git repository. That's possible. -Start by creating a files named nginx.yaml in the [services/custom/](services/custom/) directory: +Start by creating a file named nginx.yaml in the [services/custom/](services/custom/) directory: ```yaml services: @@ -230,7 +230,7 @@ By default, the file used is [gluetun.yaml](../services/gluetun.yaml), which is * Create a ``gluetun-custom.yaml`` in the [services/custom/](../services/custom/) directory. You can duplicate [this one](../services/gluetun.yaml) to avoid starting from scratch. * Adapt it to your needs (variables, mode...) according to your provider. - * Add all variables you may need (used in your custom yaml file in your ``.env`` file (replacing the wireguard ones). + * Add all variables you may need (used in your custom yaml file) in your ``.env`` file (replacing the wireguard ones). * Edit your ``config.yaml`` and add ``customFile: custom/gluetun-custom.yaml`` in the ``gluetun`` section. * Enable vn (``vpn: true``) on any service. * Run ``./run-seedbox.sh``.