Service: FreeScout - EyevinnOSC/community GitHub Wiki
FreeScout (serviceId freescout-help-desk-freescout) is an open source, self-hosted help desk with features akin to Zendesk and Help Scout. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance. License: AGPL-3.0.
- Run a shared help desk where you create and configure mailboxes and users.
- Manage tickets and settings through an admin interface, mobile-friendly and customizable.
- Keep data and control in your own OSC workspace.
FreeScout needs a MySQL-compatible database. Create it first and confirm it is running: MariaDB (linuxserver-docker-mariadb).
- Create a secret for the database password with
create-service-secret(serviceIdlinuxserver-docker-mariadb), for exampledbpassword. - Create a MariaDB instance with
create-service-instance:
{
"name": "freescoutdb",
"RootPassword": "{{secrets.dbpassword}}",
"Database": "freescout",
"User": "freescout",
"Password": "{{secrets.dbpassword}}"
}- Read the database address and port with
describe-service-instanceand build the URLmysql://freescout:<db-password>@<instance-ip>:<instance-port>/freescout. - Store that URL as a secret
dburland the admin password asadminpasswordwithcreate-service-secret(serviceIdfreescout-help-desk-freescout). - Create the FreeScout instance with
create-service-instanceusingserviceId: "freescout-help-desk-freescout":
{
"name": "guide",
"DbUrl": "{{secrets.dburl}}",
"AdminEmail": "[email protected]",
"AdminPassword": "{{secrets.adminpassword}}"
}Wait with wait-for-service-ready, then open the instance URL from describe-service-instance and log in with the admin email and password.
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Letters, digits and underscore only, at most 20 characters. |
| DbUrl | Yes | string, sensitive | Database URL in the format mysql://<user>:<password>@<host>:<port>/<database>. FreeScout supports MySQL, MariaDB and PostgreSQL databases. |
| AdminEmail | Yes | string | Email address of the administrator account created during installation. The admin has full access to mailboxes, users and settings. |
| AdminPassword | Yes | string, sensitive | Password of the administrator account, used to log in to the FreeScout admin interface. |
DbUrl and AdminPassword are sensitive: store them as service secrets and reference them as {{secrets.NAME}}, which only works as the entire field value.
After logging in with the admin email and password you can create and configure the mailboxes your help desk uses.
- Storage is limited to 10 GiB per instance.