diff --git a/docs/installation.md b/docs/installation.md index 9a5ab523..c2bb3e87 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -11,9 +11,9 @@ services: hostname: nautical-backup restart: unless-stopped volumes: - - /var/run/docker.sock:/var/run/docker.sock #(1)! - - /source:/app/source #(2)! - - /destination:/app/destination #(3)! + - /var/run/docker.sock:/var/run/docker.sock #(1)! + - /source:/app/source #(2)! + - /destination:/app/destination #(3)! environment: # Optional variables (4) - TZ=America/Los_Angeles @@ -36,13 +36,13 @@ services: ```bash docker run -d \ ---name nautical-backup:0.0.3 \ #(7)! +--name nautical-backup \ -v /var/run/docker.sock:/var/run/docker.sock \ #(1)! -v /source:/app/source \ #(2)! -v /destination:/app/destination \ #(3)! -e CRON_SCHEDULE="* 4 * * *" \ #(5)! -e SKIP_CONTAINERS="example1,example2,example3" \ #(6)! -minituff/nautical-backup +minituff/nautical-backup:0.0.3 #(7)! ``` 1. Mount the docker socket. Used to start and stop containers. diff --git a/docs/todo.md b/docs/todo.md index 43fbf711..5d5b4364 100644 --- a/docs/todo.md +++ b/docs/todo.md @@ -1,5 +1,7 @@ This project is not complete, and is still under active development. Below are a few examples of things we would like to add: +* [ ] Config file `yml` + * Used in addition to enviornment variables to configure Nautical. * [ ] Backup file exclusions * For example, you could exclude `*.log` file from only the Trilium container. * [ ] Custmizable container directories