max/README.md

Max

A small little program to manage emails.

The proxy should add X-Real-IP to get a better logging.

Setup

Requirements: Docker, Make

Start with make run-dev

Configuration

• MAX_ORIGIN (required in production): The public origin of MAX, e.g. https://max.finn.st
• MAX_PRODUCTION=1 is set in the Docker image and makes MAX refuse to start in debug mode (FLASK_DEBUG). Do not override it.

Dependencies

Direct dependencies are listed in requirements.in (production) and requirements-dev.in (development tools). requirements.txt and requirements-dev.txt are lockfiles with exact versions and hashes

• After changing a .in file: make lock-deps and make sync-deps
• Update all dependencies: make update-deps and make sync-deps
• Check for known vulnerabilities: make audit (before every release)