Download & Installation Guide

Garlic-Hub is a free and open-source Digital Signage CMS for the SMIL compatible player like garlic-player.

Choose Your Installation Method

Install Garlic-Hub via Docker in minutes. Choose either the pre-built image or build from source.

Build your own Docker image: Ideal for those who prefer to build directly from the source.
Use a pre-built image from Docker Hub: A convenient option for a faster setup.

Select the method that best suits your needs. Both methods get you running in minutes.

Using Docker for Installation

This method allows you to build and run Garlic-Hub using Docker Compose.

Prerequisites

Before you begin, make sure you have:

Docker Compose installed on your system.
An active internet connection to clone the repository.

Building and Running with Docker Compose

Clone the repository and navigate to the directory:

git clone https://github.com/garlic-signage/garlic-hub.git
cd garlic-hub

Build and run the containers in detached mode:
```
docker compose up -d --build
```

Accessing the Application

Once the container is successfully built and running, open your web browser and go to: http://localhost:8090

Installing from Docker Hub

For a quicker setup, you can use the pre-built Garlic-Hub image from Docker Hub.

Running the Container

Execute the following command to run the container with the necessary volume mounts:

docker run -p 8090:80 --name garlic-hub-container \
-v garlic-hub-public-var:/var/www/public/var \
-v garlic-hub-var:/var/www/var sagiadinos/garlic-hub:latest

Accessing the Application

After the container starts, open your web browser and navigate to: http://localhost:8090

Container Management

You can easily manage your Garlic-Hub container using standard Docker commands:

Start the container:
```
docker start garlic-hub-container
```
Stop the container:
```
docker stop garlic-hub-container
```
Restart the container:
```
docker restart garlic-hub-container
```

Admin User

After installation, you create a default administrator account to begin configuration:

Docker Volume Structure

Garlic-Hub uses two Docker-managed named volumes for its var directories:

One located in the system root.
Another within the htdocs (public) root.