installation.md

Installation

With Docker

Docker images are available for each release :

docker pull ghcr.io/thomiceli/opengist:1

It can be used in a docker-compose.yml file :

1. Create a docker-compose.yml file with the following content
2. Run docker compose up -d
3. Opengist is now running on port 6157, you can browse http:https://localhost:6157

version: "3"

services:
  opengist:
    image: ghcr.io/thomiceli/opengist:1
    container_name: opengist
    restart: unless-stopped
    ports:
      - "6157:6157" # HTTP port
      - "2222:2222" # SSH port, can be removed if you don't use SSH
    volumes:
      - "$HOME/.opengist:/opengist"

You can define which user/group should run the container and own the files by setting the UID and GID environment variables :

services:
  opengist:
    # ...
    environment:
      UID: 1001
      GID: 1001

Via binary

Download the archive for your system from the release page here, and extract it.

# example for linux amd64
wget https://github.com/thomiceli/opengist/releases/download/v1.5.1/opengist1.5.1-linux-amd64.tar.gz

tar xzvf opengist1.5.1-linux-amd64.tar.gz
cd opengist
chmod +x opengist
./opengist # with or without `--config config.yml`

From source

Requirements :

• Git (2.20+)
• Go (1.20+)
• Node.js (16+)

git clone https://github.com/thomiceli/opengist
cd opengist
make
./opengist

Opengist is now running on port 6157, you can browse http:https://localhost:6157