Skip to main content

Installation

Only two installation methods are currently available to install Onloc. Either with Docker or Podman. Both methods use the Onloc images hosted on Docker Hub.

Docker​

info

Before proceeding, you need to install Docker.

  1. Create a new directory.
mkdir ./onloc-app
cd ./onloc-app
  1. Install the necessary files from the latest release.
curl -L -O https://github.com/onloc-app/onloc/releases/latest/download/docker-compose.yml
  1. Start the containers.
docker compose pull && docker compose up -d

Podman​

info

Before proceeding, you need to install Podman.

  1. Create a new directory.
mkdir ./onloc-app
cd ./onloc-app
  1. Install the necessary files from the latest release.
curl -L -O https://github.com/onloc-app/onloc/releases/latest/download/docker-compose.yml
  1. Start the containers.
podman compose pull && podman compose up -d

Post-installation​

Once Onloc is installed, you can find the web UI at the address configured in the docker-compose.yml file. If you used the default configuration, that address will be http://your-server-ip:6144.

You can proceed with the usage guides to help you configure Onloc.