Install and create a workspace

One command

curl -fsSL https://raw.githubusercontent.com/colliedesk/colliedesk/main/install.sh | sh -s -- \
  --name "My Support Desk" --email "admin@example.com"

Re-running the installer keeps your existing .env. The steps below do the same by hand from a clone of the repository.

From a clone

Start the stack:
```
docker compose up -d --build
```

Create a workspace and its first admin:

docker compose exec server /app/colliedesk create-workspace \
  --name "Example Support" --admin-email "admin@example.com"

Open the one-time URL the command prints. It signs you in as the admin.

The link works once and expires after 15 minutes. If it expires, print a new one:

docker compose exec server /app/colliedesk pair --workspace <slug> --email admin@example.com

Data to back up

CollieDesk keeps data in two places. Back up both:

PostgreSQL (the postgres-data volume).
Attachment files in ATTACHMENTS_DIR (the attachments-data volume, mounted at /data/attachments). Without a volume, files are lost when the container is recreated.

To receive and answer customer email, set up the email channel. See the roadmap.

This page is rendered from the repository. Spot a mistake? Open an issue or a pull request.