docker compose

Overview

Docker Compose uses environment variables to customize container configurations. These variables can be defined in multiple ways to support different deployment scenarios.

Deploy Atomic Blend via docker-compose

1. Clone the backend repository locally:

git clone https://github.com/atomic-blend/backend.git atomic-blend-backend
cd atomic-blend-backend/docker

There's a script named ab-manager.sh that will take care of:

• fetching the latest version of each components on the GitHub Container Registry (requires GitHub PAT)

• create .env and docker-compose.yaml if not present

• update .env with the latest version fetched for each components

• help you set-up the necessary configurations to run Atomic Blend (public domain, ...)

1. Run the ab-manager.sh script:

export GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxxxxxxxx"
./ab-manager.sh

The script will show you:

1. Missing files

Missing files that need to be downloaded:
  - .env.example → /root/atomic-blend-backend/docker/.env

Repository: atomic-blend/backend
Branch: main

Enter 'y' or 'yes' to download missing files: y

1. Check for latest versions

Checking for latest versions...

IMAGE                                    CURRENT         LATEST          STATUS
---------------------------------------- --------------- --------------- ----------
auth                                     latest          0.12.0          OUTDATED
mail-server                              latest          0.3.0           OUTDATED
mail                                     latest          0.3.0           OUTDATED
productivity                             latest          0.12.1          OUTDATED
task-app                                 latest          0.13.1          OUTDATED
notes-app                                latest          0.4.1           OUTDATED
mail-app                                 latest          0.3.0           OUTDATED

Summary:
==========
Add these to your .env.versions file:

AUTH_SERVICE_VERSION=0.12.0
MAIL_SERVER_SERVICE_VERSION=0.3.0
MAIL_SERVICE_VERSION=0.3.0
PRODUCTIVITY_SERVICE_VERSION=0.12.1
TASK_APP_VERSION=0.13.1
NOTES_APP_VERSION=0.4.1
MAIL_APP_VERSION=0.3.0

Would you like to automatically update the .env file with these new versions?
Enter 'y' or 'yes' to proceed: y

1. Configure Atomic Blend

Would you like to configure atomic-blend settings?
Enter 'y' or 'yes' to proceed:

Environment Configuration
=========================

SSO_SECRET is empty or missing. Generating a new one...
Updated SSO_SECRET with newly generated value

Public Domain Configuration
============================
PUBLIC_ADDRESS and ACCOUNT_DOMAINS define where your service will be accessible.

Current value: atomic-blend.com
Example: app.example.com

Would you like to update the public domain? (y/n): y
Enter public domain: brandonguigo.com
Updated PUBLIC_ADDRESS to brandonguigo.com
Added ACCOUNT_DOMAINS="brandonguigo.com"


User Account Limit Configuration
==================================
AUTH_MAX_NB_USER defines the maximum number of user accounts allowed.

Current value: 10

Would you like to update the maximum number of users? (y/n): n
Skipped AUTH_MAX_NB_USER configuration.

Script completed successfully!

1. Generate the DKIM Key inside the `docker` direco

# generate the private key for DKIM
openssl genrsa -out private.key 2048

# export the public key to set inside your DNS
openssl ec -in private.key -pubout -outform der | openssl base64 -A

1. Start the platform

docker compose up -d

1. Update your DNS records and reverse_proxy

6.1 Update the DNS:

This example shows you the DNS records to create, in the case where Atomic Blend in running on a single server via `docker-compose`

record type	name	content	comment
A	*	IP_OF_SERVER
A	smtp	IP_OF_SERVER
PTR	IP_OF_SERVER	smtp	reverse DNS, needs to be set-up on the public IP address of the server
MX	domain.com	inbound.domain.com	inbound emails go to platform server via wildcard A record
TXT	domain.com	"v=spf1 ip4:IP_OF_SERVER include:smtp.domain.com -all"	allow IP_OF_SERVER to send emails for domain.com
TXT	_dmarc	"v=DMARC1; p=quarantine; rua=mailto:[e-mail]"	tell the other mail servers what to do when email is flagged as SPAM
TXT	prod._domainkey	"v=DKIM1; k=rsa; p=PUBLIC_KEY_AS_BASE_64"	Public RSA key, generated from step 4

6.2 Update your reverse proxy

If you have a reverse proxy in front of your atomic blend server (for example, on a home network where only a single local device can receive inbound requests), you'll need to configure the following in your proxy:

subdomain	port	host port
api.domain.com	80	80
mail.domain.com	80	8081
notes.domain.com	80	8082
task.domain.com	80	8083