Documentation update

sethsteenken · May 29, 2023 · f47fc6d · f47fc6d
1 parent 55fe23d
commit f47fc6d
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 11 deletions.
diff --git a/docker_compose.md b/docker_compose.md
@@ -0,0 +1,15 @@
+# Docker Compose Setup
+
+Copy contents of [docker-compose.yaml](/main_server/docker-compose.yaml) into home folder, optionally into a sub folder.
+
+Create .env file. Note: the file will be hidden.
+
+```bash
+touch .env
+```
+
+Supply required environment variables needed by the docker-compose.yaml file. Format is
+
+`
+key=value
+`
diff --git a/main_server/readme.md b/main_server/readme.md
@@ -35,13 +35,7 @@ docker login
 
 ### Docker Compose Setup
 
-Copy contents of [docker-compose.yaml](/main_server/docker-compose.yaml) into home folder, optionally into a sub folder.
-
-Create .env file. Note: the file will be hidden.
-
-```bash
-touch .env
-```
+Follow [instructions here](/docker_compose.md) to setup docker-compose.yaml.
 
 Environment variables for .env file:
 

diff --git a/private_server/docker-compose.yaml b/private_server/docker-compose.yaml
@@ -11,14 +11,14 @@ services:
       - TZ=${TIMEZONE}
     ports:
       - 8112:8112
-      - 6881:6881
+      - 6881:6881/tcp
       - 6881:6881/udp
     volumes:
       - auto_download_watch:/downloads-watch
       - active_downloads:/downloads-active
       - deluge_config:/config
       - nas_downloads:/downloads-completed
-  
+
   jackett:
     container_name: jackett
     image: linuxserver/jackett:latest
@@ -52,7 +52,7 @@ services:
 
   portainer_agent:
     container_name: "portainer_agent"
-    image: portainer/agent:2.18.3
+    image: portainer/agent:latest
     restart: always
     network_mode: "bridge"
     ports:
@@ -63,12 +63,17 @@ services:
 
 volumes:
   auto_download_watch:
+    name: "auto_download_watch"
   active_downloads:
+    name: "active_downloads"
   nas_downloads:
+    name: "nas_downloads"
     driver: local
     driver_opts:
       type: "nfs"
       o: "addr=${NAS_IP_ADDRESS},rw,noatime,rsize=8192,wsize=8192,tcp,timeo=14,nfsvers=4"
-      device: "	:/mnt/default_pool/downloads"
+      device: ":/mnt/default_pool/downloads"
   deluge_config: 
+    name: "deluge_config"
   jackett_config:
+    name: "jackett_config"
diff --git a/private_server/readme.md b/private_server/readme.md
@@ -26,3 +26,19 @@ sudo apt install traceroute
 ```bash
 traceroute google.com
 ```
+
+### Docker Compose Setup
+
+Follow [instructions here](/docker_compose.md) to setup docker-compose.yaml.
+
+Environment variables for .env file:
+
+`
+NAS_IP_ADDRESS=
+PUID=
+PGID=
+TIMEZONE=
+WATCHTOWER_SCHEDULE=
+WATCHTOWER_DEBUG=
+`
+