update: enhance README with detailed service descriptions and quick start guide; remove deprecated Calibre service from docker compose
This commit is contained in:
12
komodo/arr/arrs/env.example
Normal file
12
komodo/arr/arrs/env.example
Normal file
@@ -0,0 +1,12 @@
|
||||
# Common paths - adjust these to match your server setup
|
||||
CONFIG_PATH=/path/to/config
|
||||
DATA_PATH=/path/to/data
|
||||
|
||||
# User and Group IDs - run `id` command to find your IDs
|
||||
PUID=1000
|
||||
PGID=100
|
||||
|
||||
# Timezone - adjust to your timezone (e.g., America/New_York, Europe/London)
|
||||
# Used by: radarr, sonarr, lidarr, bookshelf, bazarr, jellyseerr, prowlarr, profilarr
|
||||
TZ=Canada/Eastern
|
||||
|
||||
4
komodo/arr/dispatcharr/env.example
Normal file
4
komodo/arr/dispatcharr/env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# Dispatcharr - No environment variables required
|
||||
# This service uses a named volume for data persistence
|
||||
# Access the web UI at http://localhost:1866
|
||||
|
||||
4
komodo/arr/dizquetv/env.example
Normal file
4
komodo/arr/dizquetv/env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# DizqueTV - No environment variables required
|
||||
# This service uses named volumes for data persistence
|
||||
# Access the web UI at http://localhost:8000
|
||||
|
||||
18
komodo/arr/download-clients/env.example
Normal file
18
komodo/arr/download-clients/env.example
Normal file
@@ -0,0 +1,18 @@
|
||||
# Common paths
|
||||
DATA_PATH=/path/to/data
|
||||
|
||||
# User and Group IDs - run `id` command to find your IDs
|
||||
PUID=1000
|
||||
PGID=100
|
||||
|
||||
# Private Internet Access (PIA) VPN Configuration
|
||||
# Required for transmission-openvpn and pia-qbittorrent
|
||||
PIA_OPENVPN_CONFIG=CA Toronto
|
||||
PIA_REGION=ca-toronto
|
||||
PIA_USERNAME=your_pia_username
|
||||
PIA_PASSWORD=your_pia_password
|
||||
|
||||
# Network configuration for transmission-openvpn
|
||||
# Adjust to match your local network subnet
|
||||
LOCAL_NETWORK=192.168.50.0/24
|
||||
|
||||
8
komodo/automate/n8n/env.example
Normal file
8
komodo/automate/n8n/env.example
Normal file
@@ -0,0 +1,8 @@
|
||||
# n8n - Timezone configuration
|
||||
TZ=ETC
|
||||
GENERIC_TIMEZONE=America/New_York
|
||||
|
||||
# Optional: Additional n8n configuration
|
||||
# N8N_RUNNERS_ENABLED=true
|
||||
# N8N_ENFORCE_SETTINGS_FILE_PERMISSIONS=true
|
||||
|
||||
4
komodo/automate/node-red/env.example
Normal file
4
komodo/automate/node-red/env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# Node-RED - No environment variables required
|
||||
# This service uses a named volume for data persistence
|
||||
# Access the web UI at http://localhost:1880
|
||||
|
||||
18
komodo/automate/semaphore/env.example
Normal file
18
komodo/automate/semaphore/env.example
Normal file
@@ -0,0 +1,18 @@
|
||||
# User and Group IDs
|
||||
PUID=1000
|
||||
PGID=100
|
||||
|
||||
# Database Configuration
|
||||
SEMAPHORE_DB_HOST=semaphore_db
|
||||
SEMAPHORE_DB_NAME=semaphore
|
||||
SEMAPHORE_DB_USER=semaphore_user
|
||||
SEMAPHORE_DB_PASS=your_secure_db_password
|
||||
|
||||
# Email Configuration (for notifications)
|
||||
SEMAPHORE_EMAIL_SENDER=semaphore@yourdomain.com
|
||||
SEMAPHORE_EMAIL_HOST=smtp.yourdomain.com
|
||||
SEMAPHORE_EMAIL_PORT=587
|
||||
SEMAPHORE_EMAIL_USERNAME=smtp_username
|
||||
SEMAPHORE_EMAIL_PASSWORD=smtp_password
|
||||
SEMAPHORE_EMAIL_SECURE=false
|
||||
|
||||
5
komodo/common/newt/env.example
Normal file
5
komodo/common/newt/env.example
Normal file
@@ -0,0 +1,5 @@
|
||||
# Newt Configuration
|
||||
PANGOLIN_ENDPOINT=your_pangolin_endpoint_url
|
||||
NEWT_ID=your_newt_id
|
||||
NEWT_SECRET=your_newt_secret
|
||||
|
||||
4
komodo/general-purpose/actual-budget/env.example
Normal file
4
komodo/general-purpose/actual-budget/env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# Actual Budget - No environment variables required
|
||||
# This service uses a named volume for data persistence
|
||||
# Access the web UI at http://localhost:5006
|
||||
|
||||
45
komodo/general-purpose/bookstack/env.example
Normal file
45
komodo/general-purpose/bookstack/env.example
Normal file
@@ -0,0 +1,45 @@
|
||||
# User and Group IDs
|
||||
PUID=1000
|
||||
PGID=100
|
||||
|
||||
# Timezone
|
||||
TZ=Etc/UTC
|
||||
|
||||
# Application URL - set to the base URL where BookStack will be accessed
|
||||
APP_URL=http://localhost:6875
|
||||
|
||||
# Application Key - Generate using:
|
||||
# docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey
|
||||
API_KEY=base64:your_generated_app_key_here
|
||||
|
||||
# Database Configuration
|
||||
DB_DATABASE=bookstack
|
||||
DB_USERNAME=bookstack_user
|
||||
DB_PASSWORD=your_secure_db_password
|
||||
DB_ROOTPASS=your_secure_root_password
|
||||
|
||||
# Authentication Method (optional, defaults to standard)
|
||||
# Options: standard, saml2
|
||||
AUTH_METHOD=saml2
|
||||
AUTH_AUTO_INITIATE=false
|
||||
|
||||
# SAML2 Configuration (for Authentik or other SAML providers)
|
||||
SAML2_NAME=Authentik
|
||||
SAML2_EMAIL_ATTRIBUTE=email
|
||||
SAML2_EXTERNAL_ID_ATTRIBUTE=sub
|
||||
SAML2_USER_TO_GROUPS=true
|
||||
SAML2_GROUP_ATTRIBUTE=groups
|
||||
SAML2_DISPLAY_NAME_ATTRIBUTES=displayName
|
||||
SAML2_IDP_ENTITYID=https://authentik.yourdomain.com/application/saml/bookstack/sso/binding/
|
||||
SAML2_AUTOLOAD_METADATA=https://authentik.yourdomain.com/application/saml/bookstack/sso/binding/
|
||||
|
||||
# SMTP Configuration (for email notifications)
|
||||
MAIL_DRIVER=smtp
|
||||
MAIL_HOST=smtp.yourdomain.com
|
||||
MAIL_PORT=587
|
||||
MAIL_ENCRYPTION=tls
|
||||
MAIL_USERNAME=smtp_username
|
||||
MAIL_PASSWORD=smtp_password
|
||||
MAIL_FROM=noreply@yourdomain.com
|
||||
MAIL_FROM_NAME=BookStack
|
||||
|
||||
4
komodo/general-purpose/flink/env.example
Normal file
4
komodo/general-purpose/flink/env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# Flink - No environment variables required
|
||||
# This service uses the default configuration
|
||||
# Access the web UI at http://localhost:8080
|
||||
|
||||
9
komodo/general-purpose/grocy/env.example
Normal file
9
komodo/general-purpose/grocy/env.example
Normal file
@@ -0,0 +1,9 @@
|
||||
# User and Group IDs
|
||||
PUID=1000
|
||||
PGID=100
|
||||
|
||||
# Timezone
|
||||
TZ=Etc/UTC
|
||||
|
||||
# Access the web UI at http://localhost:9283
|
||||
|
||||
9
komodo/general-purpose/hortusfox/env.example
Normal file
9
komodo/general-purpose/hortusfox/env.example
Normal file
@@ -0,0 +1,9 @@
|
||||
# Database Configuration
|
||||
DB_USERNAME=hortusfox
|
||||
DB_PASSWORD=your_secure_db_password
|
||||
DB_ROOT_PASSWORD=your_secure_root_password
|
||||
|
||||
# Application Configuration
|
||||
APP_ADMIN_EMAIL=admin@yourdomain.com
|
||||
APP_ADMIN_PASSWORD=your_secure_admin_password
|
||||
|
||||
4
komodo/general-purpose/it-tools/env.example
Normal file
4
komodo/general-purpose/it-tools/env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# IT Tools - No environment variables required
|
||||
# This is a simple web-based tool collection
|
||||
# Access the web UI at http://localhost:1234
|
||||
|
||||
21
komodo/general-purpose/mealie/env.example
Normal file
21
komodo/general-purpose/mealie/env.example
Normal file
@@ -0,0 +1,21 @@
|
||||
# User and Group IDs
|
||||
PUID=1000
|
||||
PGID=100
|
||||
|
||||
# Timezone
|
||||
TZ=America/Toronto
|
||||
|
||||
# Base URL - set to the base URL where Mealie will be accessed
|
||||
BASE_URL=http://localhost:9925
|
||||
|
||||
# Database Configuration (PostgreSQL)
|
||||
POSTGRES_PASSWORD=your_secure_postgres_password
|
||||
|
||||
# OIDC/OAuth Configuration (for Authentik or other OIDC providers)
|
||||
OIDC_CONFIGURATION_URL=https://authentik.yourdomain.com/application/o/mealie/.well-known/openid-configuration
|
||||
OIDC_CLIENT_ID=your_oidc_client_id
|
||||
OIDC_CLIENT_SECRET=your_oidc_client_secret
|
||||
|
||||
# OpenAI API Key (optional, for AI features)
|
||||
OPENAI_API_KEY=your_openai_api_key
|
||||
|
||||
17
komodo/general-purpose/open-webui/env.example
Normal file
17
komodo/general-purpose/open-webui/env.example
Normal file
@@ -0,0 +1,17 @@
|
||||
# API Keys
|
||||
OPEN_API_KEY=your_openai_api_key
|
||||
ANTHROPIC_API_KEY=your_anthropic_api_key
|
||||
|
||||
# OAuth Configuration (for Authentik or other OIDC providers)
|
||||
OPENID_PROVIDER_URL=https://authentik.yourdomain.com/application/o/open-webui/.well-known/openid-configuration
|
||||
OAUTH_CLIENT_ID=your_oauth_client_id
|
||||
OAUTH_CLIENT_SECRET=your_oauth_client_secret
|
||||
OPENID_REDIRECT_URI=http://localhost:11674/auth/oidc/callback
|
||||
|
||||
# OAuth Settings (optional, defaults shown)
|
||||
# ENABLE_OAUTH_SIGNUP=true
|
||||
# OAUTH_MERGE_ACCOUNTS_BY_EMAIL=true
|
||||
# OAUTH_PROVIDER_NAME=Authentik
|
||||
# OAUTH_SCOPES=openid email profile
|
||||
# ENABLE_OAUTH_GROUP_MANAGEMENT=true
|
||||
|
||||
9
komodo/media-server/audio-bookshelf/env.example
Normal file
9
komodo/media-server/audio-bookshelf/env.example
Normal file
@@ -0,0 +1,9 @@
|
||||
# AudioBookShelf - No environment variables required in compose file
|
||||
# Data volumes are mounted directly in the compose.yaml
|
||||
# Access the web UI at http://localhost:13378
|
||||
#
|
||||
# Note: Media paths are hardcoded in compose.yaml, adjust there if needed:
|
||||
# - /mnt/media/books:/ebooks
|
||||
# - /mnt/media/audiobooks:/audiobooks
|
||||
# - /mnt/media/podcasts:/podcasts
|
||||
|
||||
21
komodo/media-server/booklore/env.example
Normal file
21
komodo/media-server/booklore/env.example
Normal file
@@ -0,0 +1,21 @@
|
||||
# User and Group IDs for the application
|
||||
APP_USER_ID=1000
|
||||
APP_GROUP_ID=100
|
||||
|
||||
# User and Group IDs for the database
|
||||
DB_USER_ID=1000
|
||||
DB_GROUP_ID=100
|
||||
|
||||
# Timezone
|
||||
TZ=UTC
|
||||
|
||||
# Database Configuration
|
||||
DATABASE_URL=mysql://db_user:db_password@mariadb:3306/booklore
|
||||
DB_USER=booklore
|
||||
DB_PASSWORD=your_secure_db_password
|
||||
MYSQL_ROOT_PASSWORD=your_secure_root_password
|
||||
MYSQL_DATABASE=booklore
|
||||
|
||||
# Booklore Application Port
|
||||
BOOKLORE_PORT=8090
|
||||
|
||||
4
komodo/media-server/calibre/env.example
Normal file
4
komodo/media-server/calibre/env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
# Calibre - No environment variables in compose file
|
||||
# If you need to add environment variables, add them here
|
||||
# Access the web UI at the configured port
|
||||
|
||||
3
komodo/media-server/deprecated/calibre/env.example
Normal file
3
komodo/media-server/deprecated/calibre/env.example
Normal file
@@ -0,0 +1,3 @@
|
||||
# Calibre - No environment variables in compose file
|
||||
# If you need to add environment variables, add them here
|
||||
# Access the web UI at the configured port
|
||||
13
komodo/monitor/tracearr/env.example
Normal file
13
komodo/monitor/tracearr/env.example
Normal file
@@ -0,0 +1,13 @@
|
||||
# Port - default is 3000
|
||||
PORT=3000
|
||||
|
||||
# Timezone
|
||||
TZ=UTC
|
||||
|
||||
# Log Level - options: debug, info, warn, error
|
||||
LOG_LEVEL=info
|
||||
|
||||
# Optional: Override auto-generated secrets (usually not needed)
|
||||
# JWT_SECRET=your_jwt_secret
|
||||
# COOKIE_SECRET=your_cookie_secret
|
||||
|
||||
Reference in New Issue
Block a user