Updated docs

Minituff · Oct 28, 2023 · b4ad6b2 · b4ad6b2
1 parent 58f62cb
commit b4ad6b2
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ services:
       - CRON_SCHEDULE=0 4 * * *
       - SKIP_CONTAINERS=example1,example2,example3
 ```
-Docker Run
+Docker CLI
 ```bash
 docker run -d \
   --name nautical-backup \

diff --git a/docs/arguments.md b/docs/arguments.md
@@ -74,26 +74,26 @@ Allows a source directory and container-name that do not match.
 Normally a container is backed up *only* when the `container-name` is the exact same as the `source folder name`.
 
 === "Example 1"
+    !!! note ""
+        For example, a container named `Pi.Alert` will be skipped with a source directory name of `pialert`.
+        To fix this, we can override the source directory name so that it does not need to match the container name.
 
-    For example, a container named `Pi.Alert` will be skipped with a source directory name of `pialert`.
-    To fix this, we can override the source directory name so that it does not need to match the container name.
-
-    ```properties
-    OVERRIDE_SOURCE_DIR=Pi.Alert:pialert
-    ```
+        ```properties
+        OVERRIDE_SOURCE_DIR=Pi.Alert:pialert
+        ```
 
 === "Example 2"
-
-    We can override multiple containers if we separate them with a comma.
-    ```properties
-    OVERRIDE_SOURCE_DIR=example1:example1-new-source-data,ctr2:ctr2-new-source
-    ```
-    <small> The example above would yield the following results:</small>
-
-    | Container Name | Old Source Directory | New Source Directory         |
-    | -------------- | -------------------- | ---------------------------- |
-    | example1       | `src/example1`       | `src/example1-new-dest-data` |
-    | ctr2           | `src/ctr2`           | `src/newdest`                |
+    !!! note ""
+        We can override multiple containers if we separate them with a comma.
+        ```properties
+        OVERRIDE_SOURCE_DIR=example1:example1-new-source-data,ctr2:ctr2-new-source
+        ```
+        <small> The example above would yield the following results:</small>
+
+        | Container Name | Old Source Directory | New Source Directory           |
+        |----------------|----------------------|--------------------------------|
+        | example1       | `src/example1`       | `src/example1-new-source-data` |
+        | ctr2           | `src/ctr2`           | `src/ctr2-new-source`          |
 
 <small>🔄 This is the same action as the [Override Source Directory](./labels.md#override-source-directory-name) label, but applied globally.</small>
 
@@ -107,27 +107,27 @@ Changes the destination backup name to be something other than the container nam
 Normally, a container is backed to a folder with the ^^same name^^ as the `container-name`. 
 
 === "Example 1"
+    !!! note ""
+        For example, let's say we have a container named `Pi.Alert`. By default, the container will be backed up to a folder named `Pi.Alert`.
+        If we want to change this destination folder name to be `pialert`, we can do that using overrides.
 
-    For example, let's say we have a container named `Pi.Alert`. By default, the container will be backed up to a folder named `Pi.Alert`.
-    If we want to change this destination folder name to be `pialert`, we can do that using overrides.
-
-    ```properties
-    OVERRIDE_DEST_DIR=Pi.Alert:pialert
-    ```
+        ```properties
+        OVERRIDE_DEST_DIR=Pi.Alert:pialert
+        ```
 
 
 === "Example 2"
+    !!! note ""
+        ```properties
+        OVERRIDE_DEST_DIR=example1:example1-new-dest-data,ctr2:newdest
+        ```
 
-    ```properties
-    OVERRIDE_DEST_DIR=example1:example1-new-dest-data,ctr2:newdest
-    ```
-
-    <small> The example above would yield the following results:</small>
+        <small> The example above would yield the following results:</small>
 
-    | Container Name | Old Destination Directory | New Destination Directory     |
-    | -------------- | ------------------------- | ----------------------------- |
-    | example1       | `dest/example1`           | `dest/example1-new-dest-data` |
-    | ctr2           | `dest/ctr2`               | `dest/newdest`                |
+        | Container Name | Old Destination Directory | New Destination Directory     |
+        |----------------|---------------------------|-------------------------------|
+        | example1       | `dest/example1`           | `dest/example1-new-dest-data` |
+        | ctr2           | `dest/ctr2`               | `dest/newdest`                |
 
 <small>🔄 This is the same action as the [Override Destination Directory](./labels.md#override-destination-directory-name) label, but applied globally.</small>
 
@@ -178,7 +178,7 @@ RUN_ONCE=true
 Without [Backup on Start](#backup-on-start), the [CRON Schedule](#cron-schedule) will call the backup and then Nautical will exit.
 
 ## Mirror Source Directory Name to Destination
-Mirror the source folder name to the destination folder name. By default <small>(without any [overrides](#override-source-directory))</small>, this means both the `source` and `destination` folder names are the ^^same as the container name^^.
+Mirror the source folder name to the destination folder name. 
 
 When using a [source directory override](#override-source-directory), then the `KEEP_SRC_DIR_NAME=true` setting <small> (which is the default) </small>will mean the destination directory will be the same as the source directory, without using a [destination directory override](#override-destination-directory).
 
@@ -190,6 +190,47 @@ If a [destination directory override](#override-destination-directory) is applie
 KEEP_SRC_DIR_NAME=false
 ```
 
+=== "Example 1"
+    !!! note ""
+        ```properties
+        OVERRIDE_SOURCE_DIR=Pi.Alert:pialert
+        ```
+
+        Here we override the `source` folder to `Pi.Alert` to `pialert`, and since `KEEP_SRC_DIR_NAME=true` <small> (which is the default) </small> the `destination` folder will also be named `pialert`.
+
+        | Container Name | Source Directory | Destination Directory |
+        |----------------|------------------|-----------------------|
+        | Pi.Alert       | `src/pialert`    | `destination/pialert` |
+
+=== "Example 2"
+    !!! note ""
+        ```properties
+        KEEP_SRC_DIR_NAME=false
+        OVERRIDE_SOURCE_DIR=Pi.Alert:pialert
+        ```
+
+        Here we override the `source` folder to `Pi.Alert` to `pialert`, and since `KEEP_SRC_DIR_NAME=false` the `destination` folder will not be mirrored, so the *container-name* `Pi.Alert` will be used.
+
+        | Container Name | Source Directory | Destination Directory  |
+        |----------------|------------------|------------------------|
+        | Pi.Alert       | `src/pialert`    | `destination/Pi.Alert` |
+
+=== "Example 3"
+    !!! note ""
+        ```properties
+        OVERRIDE_SOURCE_DIR=Pi.Alert:pialert
+        OVERRIDE_DEST_DIR=Pi.Alert:pialert-backup
+        ```
+
+        Here we override the `source` folder to `Pi.Alert` to `pialert`.
+
+        We also override the `destination` folder to `pialert-backup`.
+
+        Since a *destination override* is used, the `KEEP_SRC_DIR_NAME` setting is *not* used for this container.
+
+        | Container Name | Source Directory | Destination Directory        |
+        |----------------|------------------|------------------------------|
+        | Pi.Alert       | `src/Pi.Alert`   | `destination/pialert-backup` |
 <small>🔄 This is the same action as the [Mirror Source Directory Name to Destination](./labels.md#mirror-source-directory-name-to-destination) label, but applied globally.</small>
 
 ## Console Log Level

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -17,12 +17,11 @@ Nautical requires almost no configuration when container volumes are all in a fo
 
 Let's take a look at an example:
 
-| Container Name | Source Data Directory                 | Destination Data Directory                    |
-| -------------- | ------------------------------------- | --------------------------------------------- |
-| homeassistant  | `/opt/docker-volumes/homeassistant`   | `/mnt/nfs-share/backups/homeassistant`        |
-| homepage       | `/opt/docker-volumes/homepage`        | `/mnt/nfs-share/backups/homepage`             |
-| trilium        | `/opt/docker-volumes/trilium`         | `/mnt/nfs-share/backups/trilium`              |
-| dozzle         | *N/A* <small>(no data folder)</small> | *N/A*       <small>(no backup needed)</small> |
+| Container Name                                      | Source Data Directory                 | Destination Data Directory                    |
+| --------------------------------------------------- | ------------------------------------- | --------------------------------------------- |
+| [homepage](https://github.com/gethomepage/homepage) | `/opt/docker-volumes/homepage`        | `/mnt/nfs-share/backups/homepage`             |
+| [trilium](https://github.com/zadam/trilium)         | `/opt/docker-volumes/trilium`         | `/mnt/nfs-share/backups/trilium`              |
+| [dozzle](https://github.com/amir20/dozzle)          | *N/A* <small>(no data folder)</small> | *N/A*       <small>(no backup needed)</small> |
 
 !!! example "Here is how Nautical fits into the *Sample Configuration*"
     === "Docker Compose"

diff --git a/docs/labels.md b/docs/labels.md
@@ -75,6 +75,7 @@ nautical-backup.enable=true
 
 === "Example 1 (Opt out)"
     !!! note ""
+        With the [Require Label](./arguments.md#require-label) environment variable *not set* or set to `false`.
         ```yaml
         services: # Example Service #1 config ...
           labels:
@@ -99,7 +100,8 @@ nautical-backup.enable=true
 
 
 === "Example 2 (Opt in)"
-    !!! note " With [Require Label](./arguments.md#require-label) environment variable set to `true`"
+    !!! note ""
+        With the [Require Label](./arguments.md#require-label) environment variable set to `true`
         ```yaml title=""
         services: # Example Service #1 config ...
           labels:

diff --git a/docs/updates.md b/docs/updates.md
@@ -43,7 +43,7 @@ This will need to be done each time a new version is released.
 
 
 ## Automatic Updates
-[Watchtower](https://github.com/containrrr/watchtower/) is an excellent tool to keep your Docker containers update.
+[Watchtower](https://github.com/containrrr/watchtower/) is an excellent tool to keep your Docker containers updated.
 
 While convenient, automatic updates may break things. For this reason we recommend only automatically updating to the latest `PATCH` version.