Skip to main content

Docker Compose

This guide will help you install and run Maxun with Docker Compose. Docker Compose is a tool that helps you define and share multi-container applications. You don't need to install each dependency used by Maxun separately as Docker Compose will automatically do it for you.

Prerequisites​

SoftwareDownload Link
Docker DesktopDownload Docker Desktop

Installation Steps​

  1. Create a root folder for your project (e.g. 'maxun')

  2. Generate secure secrets by running these commands and saving the output:

openssl rand -base64 48  # For JWT_SECRET
openssl rand -base64 48  # For SESSION_SECRET
openssl rand -hex 32     # For ENCRYPTION_KEY

  1. Create a file named .env in the root folder of the project

  2. Copy all content of example env file to your .env file.

  3. Replace the placeholder values for JWT_SECRET, SESSION_SECRET, and ENCRYPTION_KEY with the secrets you generated in step 2.

  4. Create a file named docker-compose.yml in the root folder of the project

  5. Copy all content from project's docker-compose.yml to your docker-compose.yml file.

  6. Run

docker-compose up -d

Docker Compose successful start

You can access the frontend at PUBLIC_URL (eg: http://localhost:5173/) and backend at BACKEND_URL (eg: http://localhost:8080/)

To set the PUBLIC_URL & BACKEND_URL environment variables, refer Environment Variables section.