Pre-deployment preparation

Please check Getting Started

Prerequisites

• Docker and Docker Compose are installed.

• Currently only the Linux operating systems that support amd64 and arm64 architectures.

Docker install

Please install it according to your operating system refer to the official documentation: https://docs.docker.com/engine/install/

Start installation

Please modify during installation.envfile default information BILLIONMAIL_HOSTNAME for your domain, such e.g., mail.domain.com

Docker Compose

cd /opt && git clone https://github.com/aaPanel/BillionMail && cd BillionMail && cp env_init .env && docker compose up -d || docker-compose up -d

View access address:

bash bm.sh default

Docker Compose .env Configuration Explanation

.env file

Configuration Item	Value	Description
ADMIN_USERNAME	billion	Default admin username
ADMIN_PASSWORD	billion	Default admin password
SafePath	billion	Management secure entry path
HTTPS_PORT	443	Management interface port
BILLIONMAIL_HOSTNAME	mail.example.com	Postfix hostname configuration
DBNAME	billionmail	PostgreSQL database name
DBUSER	billionmail	PostgreSQL username
DBPASS	NauF7ysRYyt9HTOiOn4JjIAL3QcRZnzj	PostgreSQL password
REDISPASS	zKLnZQr3riFpcS2lEy3MOtfncztaCGKp	Redis password
SMTP_PORT	25	SMTP protocol port (unencrypted)
SMTPS_PORT	465	Encrypted SMTP port (SSL/TLS)
SUBMISSION_PORT	587	Mail submission port (STARTTLS)
IMAP_PORT	143	IMAP protocol port
IMAPS_PORT	993	Encrypted IMAP port
POP_PORT	110	POP3 protocol port
POPS_PORT	995	Encrypted POP3 port
HTTP_PORT	80	Free Certificate Verification Port
TZ	Etc/UTC	Timezone setting (UTC)
IPV4_NETWORK	172.66.1	Container internal IPv4 network segment
FAIL2BAN_INIT	y	Enable fail2ban access restrictions

HTTP_PORT: To apply for Let's Encrypt free certificates, port 80 must be used. Using other ports will cause the apply to fail.