Skip to main content

​
Prerequisites

Before installing Fluxend, ensure you have the following tools installed and available via your command line interface:
  • Docker: Container platform for running applications
  • Docker Compose: Tool for defining multi-container applications
  • Make: Build automation tool for making your life easier
  • Git: Version control system
You can verify these tools are installed by running docker --version, docker-compose --version, make --version, and git --version in your terminal.

​
Installation

​
Step 1: Clone the Repository

Download the latest version of Fluxend from GitHub: 
git clone https://github.com/fluxend/fluxend.git fluxend
cd fluxend

​
Step 2: Configure Environment

If you want to edit any configs, open the .env.example file and make changes. Otherwise, just press Enter for defaults Some of the values you might want to change are:
  • BASE_DOMAIN It defaults to localhost on porn :80You can change to your real address once on server
  • JWT_SECRET This must be changed to a different string of minimum 32 characters
  • SUPERUSER_USERNAMESuperuser’s username
  • SUPERUSER_EMAIL Superuser’s email address
  • SUPERUSER_PASSWORD Superuser’s password

​
Step 3: Initialize Setup

Run the automated setup command: 
make setup
This process may take several minutes as it downloads and builds the required Docker images. Please be patient and ensure you have a stable internet connection.

​
Verification

Once the setup completes successfully, you should see a confirmation message in your terminal. Verify that all services are running correctly: 
docker-compose ps
You should see four containers running:
ContainerServiceDescription
🐘 fluxend_dbPostgreSQLApplication database
🧠 fluxend_appAPI ServerBackend engine
🌐 fluxend_frontendFrontendAdmin panel interface
🚦 fluxend_traefikTraefikReverse proxy for routing

​
Access the Application

Your Fluxend installation is now ready! Access the login at: 
http://console.localhost
You may see unsafe browser warning because it is running HTTP locally. You can ignore this because SSL won’t work with localhost as domain. When you run this on an actual server, you can modify URL_SCHEME in .env file and change it to https. Your SSL certificate is taken care of automatically

​
Troubleshooting

If you encounter issues during installation:
  1. Port conflicts: Ensure ports 80 and 443 are not in use by other applications
  2. Docker permissions: Make sure your user has permission to run Docker commands
  3. Network issues: Check your internet connection for downloading Docker images
⌘I