Skip to main content
This guide covers the secondary installation method for Figranium, which is suitable for all architectures (x86_64, ARM64, etc.) by building the Docker image locally. While the primary and recommended installation method is using the pre-built images from GitHub Container Registry (GHCR), this method provides a reliable fallback for environments where pre-built images might not be optimal or available.

​
Prerequisites

​
Step-by-Step Installation

​
1. Clone the Repository

Clone the Figranium repository to your local machine: 
git clone https://github.com/figranium/figranium.git
cd figranium

​
2. Build and Start with Docker Compose

Run the following command to build the image locally and start the application in detached mode: 
docker compose up --build -d
This command will:
  1. Download the necessary base images.
  2. Compile the Figranium source code and build the Docker image for your specific architecture.
  3. Start the containers as defined in the docker-compose.yml file.

​
3. Access the Application

Once the build is complete and the containers are running, open your browser and navigate to: http://localhost:11345

​
Updating the Installation

To update your installation to the latest version, pull the latest changes from the repository and rebuild the image: 
git pull
docker compose up --build -d

​
Comparison with GHCR (Primary Method)

FeatureGHCR (Primary)Git Clone (Secondary)
SpeedFaster (Downloads pre-built image)Slower (Builds image locally)
Ease of UseHigh (Single docker-compose.yml)Medium (Requires git clone)
ArchitectureSupports common architecturesSupports all architectures
CustomizationLimited to environment variablesFull access to source code
We recommend using the GHCR method whenever possible, as it is faster and more streamlined. Use this Git Clone method if you encounter architecture-related issues or need to modify the source code.