diff --git a/Docker-Environment-Variables.md b/Docker-Environment-Variables.md new file mode 100644 index 0000000..f4bfc85 --- /dev/null +++ b/Docker-Environment-Variables.md @@ -0,0 +1,26 @@ +The following variables can be used in the `environment` section of your `docker-compose` file: + +| Attribute| Default | Description | +|--|--|--| +| APP_KEY | - | Used for internal encryption - must be set, see [Installation](Installation) | +| APP_TIMEZONE | UTC | Timezone of the application | +| APP_URL | http://localhost | Web URL to clrghouz | +| AWS_ACCESS_KEY_ID | [not defined] | S3 Access key to store/retrieve files | +| AWS_SECRET_ACCESS_KEY | [not defined] | S3 Secret key to store/retrieve files | +| AWS_ENDPOINT | http://minio:9000 | URL to S3 Server | +| AWS_BUCKET | clrghouz | S3 Bucket to save files in | +| DB_DATABASE | clrghouz | Database name used to store data | +| DB_PASSWORD | [not defined] | Database password | +| DB_USERNAME | clrghouz | Database username | +| FIDO_DNS_NS | [not defined] | NS record returned for DNS queries | +| FIDO_DEFAULT_PACKET | 2+ | Packet to use for systems, when a packet format hasnt been selected | +| FIDO_HAPROXY | FALSE | Use the HAPROXY protocol, useful to get the true clients IP address | +| FIDO_PACKET_KEEP | FALSE | Dont delete incoming packets and tic files after successful processing | +| FIDO_QUEUE_MSGS | 50 | Number of messages in packet to force it to be sent to the queue for processing | +| FIDO_QUEUE_SIZE | 1000000 | Size in bytes of incoming mail to force to be sent to the queue for processing | +| LOG_LEVEL | info | Logging mode, options are: DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT | +| MAIL_FROM_ADDRESS | [not defined] | From address used in any system generated outgoing email | +| MAIL_FROM_NAME | [not defined] | From name used in any system generated outgoing email | +| MEMCACHED_START | FALSE | Start internal memcached server | +| ZEROTIER_START | FALSE | Start ZeroTier VPN | +