FLUXLIXDocs

Installation

Fluxlix is distributed as a set of Docker images orchestrated with Docker Compose. The recommended installation method uses the Fluxlix installer, which generates a ready-to-use Compose file and walks you through initial configuration.

Before you begin

Confirm that your server meets the system requirements before proceeding.

Step 1: Download the installer

Fetch the installer script from the Fluxlix release page or use the following command:

curl -fsSL https://get.fluxlix.io/install.sh -o install.sh
chmod +x install.sh

Step 2: Run the installer

./install.sh

The installer will prompt you for:

  • Install directory — Where to place the Compose file and data volumes (default: /opt/fluxlix)
  • Domain or IP address — The public address your team will use to access Fluxlix
  • Port — The port to expose the web interface on (default: 80/443)
  • Database settings — Whether to use the bundled PostgreSQL container or an external managed database
  • Redis settings — Whether to use the bundled Redis container or an external managed instance
  • Initial admin account — Email and password for the first administrator

The installer writes a .env file and a docker-compose.yml to your install directory.

Step 3: Start Fluxlix

cd /opt/fluxlix
docker compose up -d

Docker will pull the required images and start all services. On first boot, the database schema is created automatically. This may take a minute or two.

Step 4: Access the web interface

Open a browser and navigate to the domain or IP address you specified. Log in with the admin credentials you set during installation.

Step 5: Activate your license

After logging in, go to Admin > License and enter your license key. See Licensing for details.

Running without the installer

If you prefer to configure everything manually, copy the example Compose file from the Fluxlix documentation repository and edit the accompanying .env file directly. See Configuration for a full list of environment variables.

Verifying the installation

Once the services are running, the admin dashboard at Admin > System shows the health status of each service. All services should show a green status within a few minutes of startup.

Next steps

Previous
System Requirements
Next
Configuration