mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-01-06 04:09:40 -06:00
241 lines
9.8 KiB
Bash
241 lines
9.8 KiB
Bash
## Basic Settings ##
|
|
# Define the docker compose log driver used.
|
|
# Defaults to local
|
|
LOG_DRIVER=
|
|
# If you're on an internet facing server, comment out following line.
|
|
# It skips certificate validation for various parts of Infinite Scale and is
|
|
# needed when self signed certificates are used.
|
|
INSECURE=true
|
|
|
|
|
|
## Traefik Settings ##
|
|
# Note: Traefik is always enabled and can't be disabled.
|
|
# Serve Traefik dashboard.
|
|
# Defaults to "false".
|
|
TRAEFIK_DASHBOARD=
|
|
# Domain of Traefik, where you can find the dashboard.
|
|
# Defaults to "traefik.opencloud.test"
|
|
TRAEFIK_DOMAIN=
|
|
# Basic authentication for the traefik dashboard.
|
|
# Defaults to user "admin" and password "admin" (written as: "admin:admin").
|
|
TRAEFIK_BASIC_AUTH_USERS=
|
|
# Email address for obtaining LetsEncrypt certificates.
|
|
# Needs only be changed if this is a public facing server.
|
|
TRAEFIK_ACME_MAIL=
|
|
# Set to the following for testing to check the certificate process:
|
|
# "https://acme-staging-v02.api.letsencrypt.org/directory"
|
|
# With staging configured, there will be an SSL error in the browser.
|
|
# When certificates are displayed and are emitted by # "Fake LE Intermediate X1",
|
|
# the process went well and the envvar can be reset to empty to get valid certificates.
|
|
TRAEFIK_ACME_CASERVER=
|
|
|
|
|
|
## Infinite Scale Settings ##
|
|
# Beside Traefik, this service must stay enabled.
|
|
# Disable only for testing purposes.
|
|
# Note: the leading colon is required to enable the service.
|
|
OPENCLOUD=:opencloud.yml
|
|
# The opencloud container image.
|
|
# For production releases: "opencloud-eu/opencloud"
|
|
# For rolling releases: "opencloud-eu/opencloud-rolling"
|
|
# Defaults to production if not set otherwise
|
|
OC_DOCKER_IMAGE=opencloud-eu/opencloud
|
|
# The openCloud container version.
|
|
# Defaults to "latest" and points to the latest stable tag.
|
|
OC_DOCKER_TAG=dev
|
|
# Domain of openCloud, where you can find the frontend.
|
|
# Defaults to "cloud.opencloud.test"
|
|
OC_DOMAIN=
|
|
# openCloud admin user password. Defaults to "admin".
|
|
ADMIN_PASSWORD=
|
|
# Demo users should not be created on a production instance,
|
|
# because their passwords are public. Defaults to "false".
|
|
# Also see: https://doc.opencloud.eu/opencloud/latest/deployment/general/general-info.html#demo-users-and-groups
|
|
DEMO_USERS=
|
|
# Define the openCloud loglevel used.
|
|
# For more details see:
|
|
# https://doc.opencloud.eu/opencloud/latest/deployment/services/env-vars-special-scope.html
|
|
LOG_LEVEL=
|
|
# Define the kind of logging.
|
|
# The default log can be read by machines.
|
|
# Set this to true to make the log human readable.
|
|
# LOG_PRETTY=true
|
|
#
|
|
# Define the openCloud storage location. Set the paths for config and data to a local path.
|
|
# Note that especially the data directory can grow big.
|
|
# Leaving it default stores data in docker internal volumes.
|
|
# For more details see:
|
|
# https://doc.opencloud.eu/opencloud/next/deployment/general/general-info.html#default-paths
|
|
# OC_CONFIG_DIR=/your/local/opencloud/config
|
|
# OC_DATA_DIR=/your/local/opencloud/data
|
|
|
|
# S3 Storage configuration - optional
|
|
# Infinite Scale supports S3 storage as primary storage.
|
|
# Per default, S3 storage is disabled and the local filesystem is used.
|
|
# To enable S3 storage, uncomment the following line and configure the S3 storage.
|
|
# For more details see:
|
|
# https://doc.opencloud.eu/opencloud/next/deployment/storage/s3.html
|
|
# Note: the leading colon is required to enable the service.
|
|
#S3NG=:s3ng.yml
|
|
# Configure the S3 storage endpoint. Defaults to "http://minio:9000" for testing purposes.
|
|
S3NG_ENDPOINT=
|
|
# S3 region. Defaults to "default".
|
|
S3NG_REGION=
|
|
# S3 access key. Defaults to "opencloud"
|
|
S3NG_ACCESS_KEY=
|
|
# S3 secret. Defaults to "opencloud-secret-key"
|
|
S3NG_SECRET_KEY=
|
|
# S3 bucket. Defaults to "opencloud"
|
|
S3NG_BUCKET=
|
|
#
|
|
# For testing purposes, add local minio S3 storage to the docker-compose file.
|
|
# The leading colon is required to enable the service.
|
|
#S3NG_MINIO=:minio.yml
|
|
# Minio domain. Defaults to "minio.opencloud.test".
|
|
MINIO_DOMAIN=
|
|
|
|
# Define SMPT settings if you would like to send Infinite Scale email notifications.
|
|
# For more details see:
|
|
# https://doc.opencloud.eu/opencloud/latest/deployment/services/s-list/notifications.html
|
|
# NOTE: when configuring Inbucket, these settings have no effect, see inbucket.yml for details.
|
|
# SMTP host to connect to.
|
|
SMTP_HOST=
|
|
# Port of the SMTP host to connect to.
|
|
SMTP_PORT=
|
|
# An eMail address that is used for sending Infinite Scale notification eMails
|
|
# like "opencloud notifications <noreply@yourdomain.com>".
|
|
SMTP_SENDER=
|
|
# Username for the SMTP host to connect to.
|
|
SMTP_USERNAME=
|
|
# Password for the SMTP host to connect to.
|
|
SMTP_PASSWORD=
|
|
# Authentication method for the SMTP communication.
|
|
SMTP_AUTHENTICATION=
|
|
# Allow insecure connections to the SMTP server. Defaults to false.
|
|
SMTP_INSECURE=
|
|
|
|
# Addititional services to be started on opencloud startup
|
|
# The following list of services is not startet automatically and must be
|
|
# manually defined for startup:
|
|
# IMPORTANT: The notification service is MANDATORY, do not delete!
|
|
# IMPORTANT: Add any services to the startup list comma separated like "notifications,antivirus" etc.
|
|
START_ADDITIONAL_SERVICES="notifications"
|
|
|
|
|
|
## openCloud Web Extensions ##
|
|
# It is possible to use the openCloud Web Extensions to add custom functionality to the openCloud frontend.
|
|
# For more details see https://github.com/opencloud-eu/web-extensions/blob/main/README.md
|
|
# Note: the leading colon is required to enable the service.
|
|
# Enable this to create a new named volume
|
|
#EXTENSIONS=:web_extensions/extensions.yml
|
|
# Enable the desired extensions by uncommenting the following lines.
|
|
# Note: the leading colon is required to enable the service.
|
|
# Note: if you want to remove a web extension, you must delete the opencloud-apps volume. It will be properly recreated on docker compose startup.
|
|
#UNZIP=:web_extensions/unzip.yml
|
|
#DRAWIO=:web_extensions/drawio.yml
|
|
#JSONVIEWER=:web_extensions/jsonviewer.yml
|
|
#PROGRESSBARS=:web_extensions/progressbars.yml
|
|
#EXTERNALSITES=:web_extensions/externalsites.yml
|
|
# External Sites needs additional config, see the following files for more details.
|
|
# - config/opencloud/apps.yaml
|
|
# - config/opencloud/csp.yaml
|
|
#IMPORTER=:web_extensions/importer.yml
|
|
# The importer needs additional config, see the following lines for more details.
|
|
## The docker image to be used for uppy companion.
|
|
# opencloud has built a container with public link import support.
|
|
COMPANION_IMAGE=
|
|
# Domain of Uppy Companion. Defaults to "companion.opencloud.test".
|
|
COMPANION_DOMAIN=
|
|
# Provider settings, see https://uppy.io/docs/companion/#provideroptions for reference.
|
|
# Empty by default, which disables providers.
|
|
COMPANION_ONEDRIVE_KEY=
|
|
COMPANION_ONEDRIVE_SECRET=
|
|
|
|
|
|
## Default Enabled Services ##
|
|
|
|
### Apache Tika Content Analysis Toolkit ###
|
|
# Tika (search) is enabled by default, comment if not required.
|
|
# Note: the leading colon is required to enable the service.
|
|
#TIKA=:tika.yml
|
|
# Set the desired docker image tag or digest.
|
|
# Defaults to "latest"
|
|
TIKA_IMAGE=
|
|
|
|
### IMPORTANT Note for Online Office Apps ###
|
|
# To avoid app interlocking issues, you should select only one app to be active/configured.
|
|
# This is due the fact that there is currently no app interlocking for the same file and one
|
|
# has to wait for a lock release to open the file with another app.
|
|
|
|
### Collabora Settings ###
|
|
# Collabora web office is default enabled, comment if not required.
|
|
# Note: the leading colon is required to enable the service.
|
|
COLLABORA=:collabora.yml
|
|
# Domain of Collabora, where you can find the frontend.
|
|
# Defaults to "collabora.opencloud.test"
|
|
COLLABORA_DOMAIN=
|
|
# Domain of the wopiserver which handles OnlyOffice.
|
|
# Defaults to "wopiserver.opencloud.test"
|
|
WOPISERVER_DOMAIN=
|
|
# Admin user for Collabora.
|
|
# Defaults to "admin".
|
|
# Collabora Admin Panel URL:
|
|
# https://{COLLABORA_DOMAIN}/browser/dist/admin/admin.html
|
|
COLLABORA_ADMIN_USER=
|
|
# Admin password for Collabora.
|
|
# Defaults to "admin".
|
|
COLLABORA_ADMIN_PASSWORD=
|
|
# Set to true to enable SSL for Collabora Online. Default is true if not specified.
|
|
COLLABORA_SSL_ENABLE=false
|
|
# If you're on an internet-facing server, enable SSL verification for Collabora Online.
|
|
# Please comment out the following line:
|
|
COLLABORA_SSL_VERIFICATION=false
|
|
|
|
|
|
## Supplemental Configurations ##
|
|
# If you want to use supplemental configurations,
|
|
# you need to uncomment lines containing :path/file.yml
|
|
# and configure the service as required.
|
|
|
|
|
|
### Debugging - Monitoring ###
|
|
# Please see documentation at: https://opencloud.dev/opencloud/deployment/monitoring-tracing/
|
|
# Note: the leading colon is required to enable the service.
|
|
#MONITORING=:monitoring_tracing/monitoring.yml
|
|
|
|
|
|
### Virusscanner Settings ###
|
|
# IMPORTANT: If you enable antivirus, you also MUST configure the START_ADDITIONAL_SERVICES
|
|
# envvar in the Infinite Scale Settings above by adding 'antivirus' to the list.
|
|
# Note: the leading colon is required to enable the service.
|
|
#CLAMAV=:clamav.yml
|
|
# Image version of the ClamAV container.
|
|
# Defaults to "latest"
|
|
CLAMAV_DOCKER_TAG=
|
|
|
|
|
|
### OnlyOffice Settings ###
|
|
# Note: the leading colon is required to enable the service.
|
|
#ONLYOFFICE=:onlyoffice.yml
|
|
# Domain for OnlyOffice. Defaults to "onlyoffice.opencloud.test".
|
|
ONLYOFFICE_DOMAIN=
|
|
# Domain for the wopiserver which handles OnlyOffice.
|
|
WOPISERVER_ONLYOFFICE_DOMAIN=
|
|
|
|
|
|
### Inbucket Settings ###
|
|
# Inbucket is a mail catcher tool for testing purposes.
|
|
# DO NOT use in Production.
|
|
# Note: the leading colon is required to enable the service.
|
|
#INBUCKET=:inbucket.yml
|
|
# email server (in this case inbucket acts as mail catcher).
|
|
# Domain for Inbucket. Defaults to "mail.opencloud.test".
|
|
INBUCKET_DOMAIN=
|
|
|
|
|
|
## IMPORTANT ##
|
|
# This MUST be the last line as it assembles the supplemental compose files to be used.
|
|
# ALL supplemental configs must be added here, whether commented or not.
|
|
# Each var must either be empty or contain :path/file.yml
|
|
COMPOSE_FILE=docker-compose.yml${OPENCLOUD:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}
|