Skip to content

Installation Guide (Docker)

Version: Arctyk ITSM v0.6.0+
Last Updated: January 2026

This guide explains how to set up a local development version of Arctyk ITSM using Docker and Docker Compose.

By the end of this procedure, you’ll have the application running locally with a Postgres database.

Prerequisites

Make sure the following are installed on your system:

Step 1: Clone the Repository

# Clone the repository
git clone https://github.com/Arctyk-ITSM/arctyk-itsm.git

# Navigate to the project directory
cd arctyk-itsm

Project Structure

Your repo should look similar to this:

arctyk/
├── .gitignore
├── .dockerignore
├── Dockerfile
├── docker-compose.yml
├── requirements.in
├── requirements.txt
├── dev-requirements.in
├── dev-requirements.txt
├── .flake8
├── .pre-commit-config.yaml
├── entrypoint.sh
├── package.json
├── pyproject.toml  
├── STATIC_SRC/
│ ├── bootstrap-icons/
│ ├── scss/
│ └── css/
│ └── js/
│ └── images/
└── static/
├── src/
│ ├── manage.py
│ ├── config/
│ ├── core/
│ ├── fixtures/
│ ├── tickets/
│ ├── users/
│ ├── projects/
│ ├── inventory/
│ └── reports/
├── media/

Step 2: Environment Configuration

Create a .env file in the project root with the following configuration:

# ──────────────── Django App Settings ────────────────

DEBUG=False
DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]  # Add your domain or public IP for production

# ──────────────── Secret Key ────────────────
# IMPORTANT: Replace with a secure key in .env (do not use this template key)
SECRET_KEY=changeme-in-real-env

# ──────────────── Django Superuser (Auto Create) ────────────────
DJANGO_SUPERUSER_USERNAME=admin
DJANGO_SUPERUSER_EMAIL=admin@example.com
DJANGO_SUPERUSER_PASSWORD=admin123  # Change in real .env

# ──────────────── PostgreSQL Settings ────────────────
POSTGRES_DB=helpdesk
POSTGRES_USER=postgres    # Change or leave default
POSTGRES_PASSWORD=changeme123  # Change in real .env
POSTGRES_HOST=db
POSTGRES_PORT=5432

# ──────────────── Redis / Celery (Optional) ────────────────
REDIS_URL=redis://redis:6379/0

Security

Never commit your .env file to version control. Ensure it's added to .gitignore.

Step 3: Start Docker Services

Arctyk ITSM uses Docker Compose to run all required services in a Docker container.

Start the container services:

# Start all services
docker compose up -d

Step 4: Launch the App

  1. Open http://localhost:8000 in a web browser:
  2. Log in using the default credentials:
    • Username: admin
    • Password: admin123

That's It!

You should now have a fully running Arctyk ITSM instance inside Docker.

Next Steps

Once configuration is complete, proceed to: