Local setup

Mon, 01 Jan 0001 00:00:00 +0000

This setup is meant for testing Quollix on your local PC:

Create a docker-compose.yml.

services:
 quollix:
 image: quollix/quollix:latest
 container_name: quollix_quollix_quollix
 ports:
 - "127.0.0.1:80:80"
 - "127.0.0.1:443:443"
 volumes:
 - /tmp:/tmp
 - /var/run/docker.sock:/var/run/docker.sock
 restart: unless-stopped

Run the following command in the same directory as the docker-compose.yml file:

sudo docker compose up -d

Visit http://localhost in your browser, log in with the default credentials (admin/password). Quollix uses a self-signed HTTPS certificate by default. Your browser may show a certificate warning when you open Quollix or an installed app over HTTPS. For initial access you must accept the warning.
The subdomains of installed apps must resolve to the local machine. Edit the system hosts:

On Linux and macOS, edit /etc/hosts.
On Windows, edit C:\Windows\System32\drivers\etc\hosts.

The hosts file does not support wildcard records like *.localhost, so add each hostname you want to reach explicitly:

Production setup

Mon, 01 Jan 0001 00:00:00 +0000

This is a quick guide for installing Quollix for production use on a LAN or public server. The examples assume a domain such as example.com, referred to below as <SERVER_HOST>.

Choose a server: for example, a virtual private server (VPS) from a hosting provider or a physical server at home.
Configure DNS: Quollix routes installed apps by hostname. If the server host is example.com, Quollix itself can be accessed at quollix.example.com, and installed apps use hostnames such as forgejo.example.com, nextcloud.example.com, or vaultwarden.example.com. For this to work, every hostname under <SERVER_HOST> that you want to use must resolve to the machine running Quollix.

For LAN setups, you can host your own DNS server, use your router’s DNS server if supported, or use a public DNS provider. For public IP addresses, you usually need a public DNS server. In the DNS server, create a wildcard record that points to the IP address of the Quollix server:

*.example.com A <server-ip>

Install Docker on the server: for installation instructions, see the Docker installation guide.
Create the Compose file: add a docker-compose.yml file:

services:
 quollix:
 image: quollix/quollix:latest
 container_name: quollix_quollix_quollix
 ports:
 - "80:80"
 - "443:443"
 volumes:
 - /tmp:/tmp
 - /var/run/docker.sock:/var/run/docker.sock
 restart: unless-stopped

For extra protection, you can set a custom initial admin password with an environment variable:

Getting started on Quollix

Local setup

Production setup