update: enhance README with detailed service descriptions and quick start guide; remove deprecated Calibre service from docker compose

This commit is contained in:
Nikholas Pcenicni
2025-12-28 04:29:36 -05:00
parent d5fed6f297
commit 32fdba5fcf
23 changed files with 484 additions and 2 deletions

View 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

View 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

View File

@@ -0,0 +1,4 @@
# Flink - No environment variables required
# This service uses the default configuration
# Access the web UI at http://localhost:8080

View 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

View 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

View 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

View 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

View 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