Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Minituff committed Oct 9, 2023
1 parent c7dce2d commit 4ed9e99
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/todo.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 4ed9e99

Please sign in to comment.