Configuration

Braumeister pretty much only uses environment variables for configuration possibilities. You can use the export command to set them or even use .env file in src/bmapi directory.

Environment variables

Variable Name	Description	Value(s)	Default
BRAUMEISTER_DB	Database Connection String	postgresql://user:pwd@address:port/bm	postgresql://bm:bm@localhost:5432/bm
BRAUMEISTER_AMPQ	RabbitMQ Connection String	amqp://user:pwd@address:port/	amqp://bm:bm@localhost:5672/
BRAUMEISTER_ENVIRONMENT	Runtime environment	development, production, desktop-shell	production
BRAUMEISTER_QUEUE_TYPE	Back-end queue to use	postgresql, rabbitmq	rabbitmq
BRAUMEISTER_ADMIN_PANEL_ENABLED	Is Admin panel enabled	true, false	false
BRAUMEISTER_EMAIL_ENABLED	Is Email sending enabled	true, false	false
BRAUMEISTER_SMTP_SERVER_ADDR	SMTP Server Address	mail.myserver.com	None
BRAUMEISTER_SMTP_SERVER_PORT	SMTP Server Port	587	587
BRAUMEISTER_SERVER_EMAIL	Email to use as sender	user@myaddress.com	None
BRAUMEISTER_SERVER_EMAIL_PASSWORD	Email password	mypassw0rd	None
BRAUMEISTER_UI_URI	Braumeister App URI	http://localhost:8080	http://localhost:8080
BRAUMEISTER_API_URI	Braumeister Api URI	http://localhost:5000/	http://localhost:5000/
BRAUMEISTER_BETA_MODE	Enable Beta Mode	true, false	false
BRAUMEISTER_CORS_ORIGIN	CORS Origin allowed for the API	http://localhost:8080,https://second.com	http://localhost:8080
BRAUMEISTER_LOG_PATH	Path where save logs file	/path/logs/	/opt/logs/
BRAUMEISTER_IMAGE_UPLOAD_PATH	Path where image are saved	/path/image_upload/	/opt/images/
BRAUMEISTER_USER_FILES_PATH	Path where user file are saved	/path/files/	/opt/files/
BRAUMEISTER_USER_FILES_PATH	Path where user file are saved	/path/files/	/opt/files/
BRAUMEISTER_TASK_STATE_FILE_PATH	Task state path for scheduler	/path/task-state.json	task-state.json
BRAUMEISTER_BACKUP_ENABLED	Is Backup enabled	true, false	false
BRAUMEISTER_BACKUP_PATH	Path where back-up are saved	/path/backup/	/opt/backup/
BRAUMEISTER_SOURCE_ROOT	Path where source are located	/path/to/bmapi/	/opt/bmapi/

User Email verification

To enable user verification, you must set 5 environment variables.

• BRAUMEISTER_EMAIL_ENABLED: true or false. This enable the feature.

• BRAUMEISTER_SMTP_SERVER_ADDR: Smtp Server address.

• BRAUMEISTER_SMTP_SERVER_PORT: Smtp Server port.

• BRAUMEISTER_SERVER_EMAIL: Email used as sender. Also the username for the smtp server.

• BRAUMEISTER_SERVER_EMAIL_PASSWORD: Password for the sender email.

Application URI and CORS

Addresses to some part of the applications.

• BRAUMEISTER_UI_URI: Address to bmui instance.

• BRAUMEISTER_API_URI: Address to bmapi flask server.

To enable CORS, set this environment variable, you can use multiple values separated by a comma.

Beta Mode

When Beta Mode is enabled, a key is needed to create a new account.