# Self-host FreeScout

> A free, self-hosted help desk and shared mailbox, a lighter alternative to Zendesk or Help Scout.

- Page: https://levelrail.com/templates/freescout/
- JSON: https://levelrail.com/templates/freescout.json
- Category: Communication
- Licence: AGPL-3.0 (Network copyleft (AGPL) license)
- Source: https://github.com/freescout-help-desk/freescout
- Upstream docs: https://github.com/freescout-helpdesk/freescout/wiki

## Requirements
- Memory: about 512 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: latest

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| freescout | ghcr.io/nfrastack/container-freescout | latest | 80 | freescout_data -> /data; freescout_logs -> /www/logs |
| mariadb | mariadb | 11 | none | freescout_db_data -> /var/lib/mysql |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| freescout | ADMIN_EMAIL | preset |
| freescout | ADMIN_PASS | generated |
| freescout | DB_HOST | preset |
| freescout | DB_NAME | preset |
| freescout | DB_PASS | generated |
| freescout | DB_USER | preset |
| freescout | DISPLAY_ERRORS | preset |
| freescout | SITE_URL | preset |
| freescout | TIMEZONE | preset |
| mariadb | MARIADB_DATABASE | preset |
| mariadb | MARIADB_PASSWORD | generated |
| mariadb | MARIADB_ROOT_PASSWORD | generated |
| mariadb | MARIADB_USER | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy freescout --name my-freescout
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/freescout/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### Can I deploy FreeScout on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id freescout for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image ghcr.io/nfrastack/container-freescout:latest, mariadb:11 is what you deploy there.

Self-host FreeScout, FreeScout docker compose file, deploy FreeScout on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
