From 1c638133ae15fcc253d9ab1b3f3dd000ef73b3f5 Mon Sep 17 00:00:00 2001 From: Alex Zaw Date: Mon, 6 Apr 2026 18:10:47 +0000 Subject: [PATCH] Update .env.example with standalone-friendly variables --- .env.example | 63 ++++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 32 deletions(-) diff --git a/.env.example b/.env.example index 46468eb..ec3a7d1 100644 --- a/.env.example +++ b/.env.example @@ -2,60 +2,42 @@ # Copy this file to .env and customize for your deployment # ============================================================================= -# REQUIRED SETTINGS +# STANDALONE DEPLOYMENT (docker-compose.standalone.yml) # ============================================================================= +# Use these variables when running ONLYOFFICE Docs independently without Runtipi # JWT Secret Key (REQUIRED) # Generate a strong random string: openssl rand -hex 32 -ONLYOFFICE_JWT_SECRET=change-me-to-a-secure-random-string +JWT_SECRET=change-me-to-a-secure-random-string -# ============================================================================= -# RUNTIPI VARIABLES (auto-populated by Runtipi) -# ============================================================================= - -# App port - change if 8044 is already in use -APP_PORT=8044 - -# App data directory (set by Runtipi) -# APP_DATA_DIR=/path/to/runtipi/app-data/onlyoffice-docs - -# Domain configuration (set by Runtipi) -# APP_DOMAIN=onlyoffice-docs.yourdomain.com -# LOCAL_DOMAIN=tipi.lan - -# ============================================================================= -# OPTIONAL: JWT SETTINGS -# ============================================================================= +# Port to expose (default: 8044) +ONLYOFFICE_PORT=8044 # Enable JWT authentication (recommended: true) -ONLYOFFICE_JWT_ENABLED=true +JWT_ENABLED=true # JWT HTTP header name -ONLYOFFICE_JWT_HEADER=Authorization +JWT_HEADER=Authorization # Allow JWT token in request body -ONLYOFFICE_JWT_IN_BODY=false - -# ============================================================================= -# OPTIONAL: STORAGE & INTEGRATION -# ============================================================================= +JWT_IN_BODY=false # Accept self-signed SSL certificates from storage server # Enable this if using self-signed certs with Nextcloud/ownCloud -ONLYOFFICE_USE_UNAUTHORIZED_STORAGE=false +USE_UNAUTHORIZED_STORAGE=false # Enable WOPI protocol for Microsoft Office integration -ONLYOFFICE_WOPI_ENABLED=false +WOPI_ENABLED=false # ============================================================================= -# OPTIONAL: EXTERNAL DATABASE (for docker-compose.external-db.yml) +# STANDALONE WITH EXTERNAL DB (docker-compose.standalone-external-db.yml) # ============================================================================= -# PostgreSQL password for external database setup -ONLYOFFICE_DB_PASSWORD=onlyoffice +# PostgreSQL password +DB_PASSWORD=onlyoffice # ============================================================================= -# OPTIONAL: LETS ENCRYPT (for standalone HTTPS, not needed with Traefik) +# LETS ENCRYPT (for standalone HTTPS) # ============================================================================= # Domain for Let's Encrypt certificate @@ -63,3 +45,20 @@ ONLYOFFICE_DB_PASSWORD=onlyoffice # Admin email for Let's Encrypt # LETS_ENCRYPT_MAIL=admin@yourdomain.com + +# ============================================================================= +# RUNTIPI DEPLOYMENT (docker-compose.yml) +# ============================================================================= +# These variables are auto-populated by Runtipi when installed via the app store. +# You don't need to set these manually for standalone deployments. + +# ONLYOFFICE_JWT_SECRET= +# ONLYOFFICE_JWT_ENABLED=true +# ONLYOFFICE_JWT_HEADER=Authorization +# ONLYOFFICE_JWT_IN_BODY=false +# ONLYOFFICE_USE_UNAUTHORIZED_STORAGE=false +# ONLYOFFICE_WOPI_ENABLED=false +# APP_PORT=8044 +# APP_DATA_DIR=/path/to/runtipi/app-data/onlyoffice-docs +# APP_DOMAIN=onlyoffice-docs.yourdomain.com +# LOCAL_DOMAIN=tipi.lan