KeyArgo
/
seedbox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Typos + additions in doc

This commit is contained in:
Jean Froment 2022-03-07 00:38:30 +01:00
parent 7ce8e0cf61
commit 5eefdb0e99
3 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
config.sample.yaml
View File

@ -19,7 +19,7 @@ services:
# Uncomment to specify custom schme (http by default) # Uncomment to specify custom schme (http by default)
# internalScheme: http # internalScheme: http
# Uncomment to *NOT* generate LetsEncrypt certificate (useful for local domains) # Uncomment to *NOT* generate LetsEncrypt certificate (useful for local domains)
# disableCertificateGeneration: true # httpOnly: true
- name: flood - name: flood
enabled: true enabled: true
vpn: false vpn: false
@ -221,7 +221,8 @@ services:
httpAuth: true httpAuth: true
internalPort: 8384 internalPort: 8384
- name: heimdall - name: heimdall
enabled: true # Beware to the host when enabling it!
enabled: false
vpn: false vpn: false
traefik: traefik:
enabled: true enabled: true

1
doc/UPGRADE_V2.md
View File

@ -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) * ``Readarr``: [Ebook and comic monitor](https://github.com/Readarr/Readarr)
* ``Komga``: [Comic Book Manager](https://github.com/gotson/komga) * ``Komga``: [Comic Book Manager](https://github.com/gotson/komga)
* ``Kavita``: [Comic / Book Manager](https://github.com/Kareadita/Kavita) * ``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 * ⚠️ Docker compose v2.2+ is now required
And also: And also:

4
doc/configuration.md
View File

@ -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. 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 ```yaml
services: 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. * 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. * 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. * Edit your ``config.yaml`` and add ``customFile: custom/gluetun-custom.yaml`` in the ``gluetun`` section.
* Enable vn (``vpn: true``) on any service. * Enable vn (``vpn: true``) on any service.
* Run ``./run-seedbox.sh``. * Run ``./run-seedbox.sh``.