Files
gh-christianlouis-docuelevate/docs/ConfigurationMaster.md
Christian Krakau-Louis d79652b494 feat: Add authentication configuration and validation
- Introduced new authentication settings in config.py including `auth_enabled`, `admin_username`, `admin_password`, and `session_secret`.
- Added validation for `session_secret` to ensure it meets security requirements when authentication is enabled.
- Updated main.py to conditionally mount static files and log warnings if the directory is not found.
- Removed unused email template files and added new authentication and notification setup documentation.
- Implemented authentication configuration validation in validators.py and updated settings display.
- Enhanced the user interface with a new login template and SVG assets for branding.
- Added comprehensive guides for setting up authentication and notifications in the documentation.
2025-04-11 03:44:08 +02:00

1.6 KiB

DocuElevate Configuration

This section contains detailed documentation about configuring DocuElevate for your environment.

Configuration Overview

DocuElevate is designed to be highly configurable through environment variables, typically set in a .env file. This allows you to enable only the services and integrations you need for your specific use case.

Documentation Sections

Configuration File Location

The .env file should be placed at the root of the project directory. When using Docker Compose, you can reference it with the env_file directive in your docker-compose.yml.

Example Configuration

Below is a minimal example configuration to get started:

# Core settings
DATABASE_URL=sqlite:///./app/database.db
REDIS_URL=redis://redis:6379/0
WORKDIR=/workdir
GOTENBERG_URL=http://gotenberg:3000
EXTERNAL_HOSTNAME=docuelevate.example.com

# Enable only the services you need
# For detailed parameters, see the Configuration Guide

For a complete example with all possible parameters, see the Configuration Guide.