📝 Update / fix of the doc

config/seedboxsync.yml.example

@@ -2,11 +2,11 @@
 ---
 
 #
-# Informations about your seedbox
+# Information about your seedbox
 #
 seedbox:
 
-  ### Informations about your seedbox connection
+  ### Information about your seedbox connection
   # host: my-seedbox.ltd
   # port: 22
   # login: me
@@ -40,7 +40,7 @@ seedbox:
 
 
 #
-# Informations about local environment (NAS ?)
+# Information about local environment (NAS ?)
 #
 local:
 
@@ -55,7 +55,7 @@ local:
 
 
 #
-# PID and lock management to prevent several launch
+# PID and lock management to prevent several launches
 #
 pid:
 
@@ -89,7 +89,7 @@ healthchecks:
 
 
 #
-# SeedboxSync tunning
+# SeedboxSync tuning
 #
 seedboxsync:
 
@@ -123,5 +123,5 @@ log.colorlog:
   ### Max size in bytes that a log file can grow until it is rotated.
   # max_bytes: 512000
 
-  ### The maximun number of log files to maintain when rotating
+  ### The maximum number of log files to maintain when rotating
   # max_files: 4

docs/configuration.md

@@ -35,7 +35,7 @@ You can put your configuration in:
 
 ### Configuration about your seedbox and your BitTorrent client
 
-* First, set informations about the connection to your Seedbox. Currently, only sftp is supported.
+* First, set information about the connection to your Seedbox. Currently, only sftp is supported.
 
 ```yml
 #
@@ -48,6 +48,7 @@ seedbox:
   port: 22
   login: me
   password: p4sw0rd
+  timeout: false
 
   ### For the moment, only sftp
   protocol: sftp
@@ -61,7 +62,7 @@ seedbox:
     chmod: false
 ```
 
-* To prevent that your BitTorrent client watch (and use) an incomplete torrent file, SeedboxSync transfer torrent file in a tmp directory (```tmp\_path```) and move it in the watch folder after full transfert and chmod. The tmp folder must also be used in your BitTorrent client to download unfinished torrent.
+* To prevent that your BitTorrent client watch (and use) an incomplete torrent file, SeedboxSync transfer torrent file in a tmp directory (```tmp_path```) and move it in the watch folder after full transfer and chmod. The tmp folder must also be used in your BitTorrent client to download unfinished torrent.
 
 ![ruTorrent settings / Downloads](images/rutorrent_1.png)
 
@@ -70,14 +71,14 @@ seedbox:
     tmp_path: /tmp
 ```
 
-* The blackhole folder of your BitTorrent client. Only used by blackhole synchronisation.
+* The blackhole folder of your BitTorrent client. Only used by blackhole synchronization.
 
 ```yml
     # Your "watch" folder you must create it!)
     watch_path: /watch
 ```
 
-* The folder of your Bittorrent client with finished file. You can configure your client to move finished file in a specific folder.
+* The folder of your Bittorrent client with finished file. You can configure your client to move the finished file in a specific folder.
 
 ![ruTorrent settings / Autotools](images/rutorrent_2.png)
 
@@ -93,7 +94,7 @@ seedbox:
     prefixed_path: /files
 ```
 
-* You can also specified extension used by your torrent client for downloads in progress to exclude it from synchronisation.
+* You can also specify the extension used by your torrent client for downloads in progress to exclude it from synchronisation.
 
 ```yml
     # Exclude part files
@@ -146,7 +147,7 @@ pid:
 
 Ping service is called by `--ping` argument.
 
-Currently only [Healthchecks](https://github.com/healthchecks/healthchecks) ping service is supported.
+Currently, only [Healthchecks](https://github.com/healthchecks/healthchecks) ping service is supported.
 
 #### Healthchecks
 

docs/developers.md

@@ -25,18 +25,18 @@ The following demonstrates setting up and working with a development environment
 
 ```bash
 ### create a virtualenv for development
-
 make virtualenv
-
 source env/bin/activate
 
-
 ### run seedboxsync cli application
-
 seedboxsync --help
 
-
 ### run pytest / coverage
-
 make test
+
+### Build package
+make dist
+
+### Build docker image
+make docker
 ```

docs/docker.md

@@ -5,27 +5,43 @@ description: How to install SeedboxSync with Docker
 order: 1
 ---
 
+## Pull image
+
+From Docker Hub:
+
+```bash
+docker pull llaumgui/seedboxsync
+```
+
+Or from GitHub Packages:
+
+```bash
+docker pull ghcr.io/llaumgui/seedboxsync
+```
+
+## Use image
+
 * Setup your `configuration.yml` (see [configuration](https://llaumgui.github.io/seedboxsync/configuration.html)).
-* Run `docker` and mount your configuration.yml.
+* Run `docker` and mount your configuration.yml and others path
 
 ```bash
 docker run --rm \
-  --volume /data/seedboxsync/seedboxsync.yml:/config/seedboxsync.yml \
+  --volume /data/seedboxsync/config:/config/seedboxsync.yml \
   --volume /data/seedboxsync/watch:/watch \
   --volume /data/seedboxsync/download:/download \
   ghcr.io/llaumgui/seedboxsync:latest --help
 ```
 
-* Use a script to shortcur the call:
+* Use a script to shortcut the call:
 
 ```bash
 #!/bin/bash
 
 CONTAINER_NAME="ghcr.io/llaumgui/seedboxsync:latest"
-ARGV="$@"
+COMMAND="$@"
 
 docker run --rm \
-  --volume /data/seedboxsync/seedboxsync.yml:/config/seedboxsync.yml \
+  --volume /data/seedboxsync:/config \
   --volume /data/seedboxsync/watch:/watch \
   --volume /data/seedboxsync/download:/download \
   ${CONTAINER_NAME} ${COMMAND}

docs/install.md

@@ -5,6 +5,8 @@ description: How to install SeedboxSync
 order: 1
 ---
 
+## With pip
+
 In root:
 
 ```bash
@@ -16,3 +18,7 @@ Or with simple user privileges:
 ```bash
 pip install --user seedboxsync
 ```
+
+## With docker
+
+See [documentation](https://llaumgui.github.io/seedboxsync/docker.html).