better conf instructions

audiobookshelf/docker-compose.yml

@@ -1,3 +1,6 @@
+# TODO set volume directories
+# TODO set timezone (TZ)
+
 volumes:
   audiobooks:
     driver: local

calibre-web-automated/ReadMe.md

@@ -0,0 +1,2 @@
+# Calibre Web Automated (CWA)
+Modified from [official instructions](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#using-docker-compose-recommended).

calibre-web-automated/docker-compose.yml

@@ -0,0 +1,65 @@
+# TODO set volume directories
+# TODO set user/group IDs
+# TODO set timezone (TZ)
+
+volumes:
+  config:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/config
+  ingest:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/ingest
+  library:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/library
+  plugins:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/plugins
+
+services:
+  calibre-web-automated:
+    image: crocodilestick/calibre-web-automated:latest
+    container_name: calibre-web-automated
+    environment:
+      # Only change these if you know what you're doing
+      - PUID=1004
+      - PGID=1004
+      # Edit to match your current timezone https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+      - TZ=America/Denver
+      # Hardcover API Key required for Hardcover as a Metadata Provider, get one here: https://docs.hardcover.app/api/getting-started/
+      - HARDCOVER_TOKEN=your_hardcover_api_key_here
+      # If your library is on a network share (e.g., NFS/SMB), disable WAL to reduce locking issues
+      # Accepts: true/false (default: false)
+      - NETWORK_SHARE_MODE=false
+      # Override the default port (8083) for the web server.
+      # Accepts any valid port number.
+      - CWA_PORT_OVERRIDE=8083
+    volumes:
+      # CW users migrating should stop their existing CW instance, make a copy of the config folder, and bind that here to carry over all of their user settings ect.
+      - config:/config
+      # This is an ingest dir, NOT a library one. Anything added here will be automatically added to your library according to the settings you have configured in CWA Settings page. All files placed here are REMOVED AFTER PROCESSING
+      - ingest:/cwa-book-ingest
+      # If you don't have an existing library, CWA will automatically create one at the bind provided here
+      - library:/calibre-library
+      # If you use calibre plugins, you can bind your plugins folder here to have CWA attempt to add them to its workflow (WIP)
+      # If you are starting with a fresh install, you also need to copy customize.py.json to the Calibre config volume above, in /path/to/config/folder/.config/calibre/customize.py.json, see the note below for more info
+      - plugins:/config/.config/calibre/plugins
+    # ports:
+    #   # Change the first number to change the port you want to access the Web UI, not the second
+    #   - 8083:8083
+    # If you set CWA_PORT_OVERRIDE to a port below 1024, you may need to uncomment the following line:
+    # cap_add:
+    #   - NET_BIND_SERVICE
+    restart: unless-stopped

gitea/docker-compose.yml

@@ -1,5 +1,5 @@
-# todo change data path
+# TODO set volume directories
-# todo change user and group IDs
+# TODO set user/group IDs
 
 version: "3"
 

immich/docker-compose.yml

@@ -1,5 +1,6 @@
-# WARNING: Environment file doesn't work.
+# TODO set volume directories
-# While not strictly necessary, you should change PASSWORD.
+# TODO change ALL_CAPS environment variables in all locations
+# note: environment files won't work here
 
 volumes:
   UPLOAD_LOCATION:
@@ -37,11 +38,11 @@ services:
     environment:
       TZ: America/Denver
       IMMICH_VERSION: v2
-      DB_PASSWORD: PASSWORD
+      DB_PASSWORD: YOUR_PASSWORD
       DB_USERNAME: postgres
       DB_DATABASE_NAME: immich
-    ports:
+    # ports:
-      - '2283:2283'
+    #   - '2283:2283'
     depends_on:
       - redis
       - database
@@ -77,7 +78,7 @@ services:
     container_name: immich_postgres
     image: ghcr.io/immich-app/postgres:14-vectorchord0.4.3-pgvectors0.2.0@sha256:bcf63357191b76a916ae5eb93464d65c07511da41e3bf7a8416db519b40b1c23
     environment:
-      POSTGRES_PASSWORD: PASSWORD
+      POSTGRES_PASSWORD: YOUR_PASSWORD
       POSTGRES_USER: postgres
       POSTGRES_DB: immich
       POSTGRES_INITDB_ARGS: '--data-checksums'

peertube/docker-compose.yml

@@ -1,6 +1,6 @@
-# TODO change volumes to match local path(s)
+# TODO set volume directories
-# TODO change environment variables, make sure all instances match
+# TODO change ALL_CAPS environment variables in all locations
-# TODO To generate PeerTube secret, run: openssl rand -hex 32
+#      For PEERTUBE_SECRET, run : openssl rand -hex 32
 
 volumes:
   config:
@@ -64,9 +64,9 @@ services:
       PEERTUBE_SMTP_TLS: false
       PEERTUBE_SMTP_DISABLE_STARTTLS: false
       PEERTUBE_ADMIN_EMAIL: EMAIL_ADDRESS
-    ports:
+    # ports:
-      - "1935:1935" # Comment if you don't want to use the live feature
+    #   - "1935:1935" # Comment if you don't want to use the live feature
-      - "9000:9000" # Uncomment if you use another webserver/proxy or test PeerTube in local, otherwise not suitable for production
+    #   - "9000:9000" # Uncomment if you use another webserver/proxy or test PeerTube in local, otherwise not suitable for production
     volumes:
       - data:/data
       - config:/config

vikunja/docker-compose.yml

@@ -29,8 +29,8 @@ services:
       VIKUNJA_REDIS_HOST: 'redis:6379'
       VIKUNJA_CACHE_ENABLED: 1
       VIKUNJA_CACHE_TYPE: redis
-    ports:
+    # ports:
-      - 3456:3456
+    #   - 3456:3456
     volumes:
       - files:/app/vikunja/files
     depends_on: