Getting started

Local Test Setup

Install Docker and run Quollix as described below. Visit http://localhost in your browser, log in with the default credentials (admin/password).

Production Setup

This is a quick guide for a production installation of Quollix. For the sake of example, assume you have a domain like example.com, which we will call <SERVER_HOST> in the instructions below.

  1. Choose a server: for example, a virtual private server (VPS) from a hosting provider, or a physical server at home.
  2. Set DNS records: Create a wildcard A DNS record pointing to the IP address of the Quollix server for your domain: *.<SERVER_HOST>
  3. Install Docker: For installation instructions, see the Docker Installation Guide.
  4. Create a docker-compose.yml file with the following content:
services:
  quollix:
    image: quollix/quollix:latest
    container_name: quollix
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - /tmp:/tmp
      - /var/run/docker.sock:/var/run/docker.sock
    restart: unless-stopped
  • If you want extra security to prevent other people or bots logging in with the default credentials, add the following environment variables:
services:
  quollix:
    # ...
    environment:
      INITIAL_ADMIN_NAME: <replace-me>
      INITIAL_ADMIN_PASSWORD: <replace-me>
      INITIAL_ADMIN_EMAIL: <replace-me>
  1. Run the following command in the same directory as the docker-compose.yml file:
sudo docker compose up -d
  1. Visit the Quollix web interface at https://quollix.<SERVER_HOST>.
  2. Log in using the default credentials (admin / password).
  3. Go to the Settings page, set Server Host to <SERVER_HOST>, and save.
  4. Set up certificate by either:
    • uploading your own wildcard certificate covering the domains above
    • or generating a wildcard certificate via DNS-01 challenge and restarting the browser afterwards

Next Steps

The Operations section provides additional guidance for running Quollix in a self-hosted environment, including configuration and security best practices.