# zammad

Zammad is a free helpdesk or issue tracking system. 

<!-- metadata -->

* **Category**: Apps
* **Status**: 0
* **Image**: [`zammad`](https://hub.docker.com/r/zammad), 4, upstream
* **Healthcheck**: Yes
* **Backups**: No
* **Email**: Yes
* **Tests**: No
* **SSO**: Yes

<!-- endmetadata -->

## Quick start

if using elasticsearch, set on your host: `vm.max_map_count=262144`  in `/etc/sysctl.conf` and run `sysctl -p`

* `abra app new zammad --secrets`
* `abra app config <app-name>`
* `abra app secret insert <app-name> smtp_password v1 <password>`
* `abra app secret generate -a <app-name>`
* `abra app deploy <app-name>`

Either use the web wizard for the initial setup or run: `abra app cmd <app-name> zammad-railsserver init`

## Authentik SSO

* `abra app config <app-name>`
```
SSO_PROVIDER_DOMAIN=authentik.example.com
IDP_SSO_TARGET_URL=https://authentik.example.com/application/saml/zammad/sso/binding/init/
IDP_SLO_SERVICE_URL=https://authentik.example.com/application/saml/zammad/slo/binding/redirect/
```
Run:
`abra app cmd --local <app_name> enable_authentik_sso`

## Useful Commands

Show changed settings: `abra app cmd <app_name> zammad-railsserver get_setting_changes`

Open rails console: `abra app cmd <app_name> zammad-railsserver console`


For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).