2017-01-06 12:10:15 +00:00
# Welcome to Zammad
2016-12-17 11:10:51 +00:00
Zammad is a web based open source helpdesk/ticket system with many features
to manage customer communication via several channels like telephone, facebook,
2022-01-28 20:44:56 +00:00
twitter, chat and emails. It is distributed under the GNU AFFERO General Public
License (AGPL). Do you receive many emails and want to answer them with a team of agents?
2016-12-17 11:10:51 +00:00
You're going to love Zammad!
2022-01-28 20:44:56 +00:00
## Use case for this repository
2016-12-17 11:10:51 +00:00
2022-01-28 20:44:56 +00:00
This repository is meant to be the starting point for somebody who likes to use dockerized multi-container Zammad in production.
2016-12-17 11:10:51 +00:00
2017-01-06 12:10:15 +00:00
## Getting started with zammad-docker-compose
2022-12-23 20:20:50 +00:00
[Learn more on Zammad’ ](https://docs.zammad.org/en/latest/install/docker-compose.html )
2017-12-09 11:36:38 +00:00
2022-11-08 15:08:16 +00:00
## Upgrading
2022-12-23 20:20:50 +00:00
For upgrading instructions see our [Releases ](https://github.com/zammad/zammad-docker-compose/releases ).
2022-11-08 15:08:16 +00:00
2022-12-23 20:20:50 +00:00
Please be aware that the zammad-docker-compose repository versions and tags don't match the Zammad container tags!
2022-11-08 15:08:16 +00:00
2022-04-27 14:08:47 +00:00
## Status
2017-11-13 08:57:22 +00:00
2022-11-08 15:08:16 +00:00
[](https://github.com/zammad/zammad-docker-compose/actions/workflows/ci-remote-image.yaml) [](https://hub.docker.com/r/zammad/zammad-docker-compose/)
2017-12-09 11:36:38 +00:00
2017-11-13 08:57:22 +00:00
## Using a reverse proxy
In environments with more then one web applications it is necessary to use a reverse proxy to route connections to port 80 and 443 to the right application.
2022-09-21 09:00:15 +00:00
To run Zammad behind a reverse proxy, we provide `docker-compose.proxy-example.yml` as a starting point.
2017-11-13 08:57:22 +00:00
2021-08-13 14:00:05 +00:00
1. Copy `./.examples/proxy/docker-compose.proxy-example.yml` to your own configuration, e.g. `./docker-compose.prod.yml`
2017-11-13 08:57:22 +00:00
`cp ./.examples/proxy/docker-compose.proxy-example.yml ./docker-compose.prod.yml`
2020-12-07 12:41:12 +00:00
2. Modify the environment variable `VIRTUAL_HOST` and the name of the external network in `./docker-compose.prod.yml` to fit your environment.
2021-08-13 14:00:05 +00:00
3. Run docker-composer commands with the default and your configuration, e.g. `docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d`
2017-11-13 08:57:22 +00:00
See `.examples/proxy/docker-compose.yml` for an example proxy project.
Like this, you can add your `docker-compose.prod.yml` to a branch of your Git repository and stay up to date by merging changes to your branch.
2017-12-09 11:36:38 +00:00
## Using Rancher
2020-12-07 12:41:12 +00:00
```console
RANCHER_URL=http://RANCHER_HOST:8080 rancher-compose --env-file=.env up
```
2020-02-19 22:14:14 +00:00
2020-09-14 14:11:41 +00:00
## Running without Elasticsearch
Elasticsearch is an optional, but strongly recommended dependency for Zammad. More details can be found in the [documentation ](https://docs.zammad.org/en/latest/prerequisites/software.html#elasticsearch-optional ). There are however certain scenarios when running without Elasticsearch may be desired, e.g. for very small teams, for teams with limited budget or as a temporary solution for an unplanned Elasticsearch downtime or planned cluster upgrade.
Elasticsearch is enabled by default in the example `docker-compose.yml` file. It is also by default required to run the "zammad-init" command. Disabling Elasticsearch is possible by setting a special environment variable: `ELASTICSEARCH_ENABLED=false` for the `zammad-init` container and removing all references to Elasticsearch everywhere else: the `zammad-elasticsearch` container, it's volume and links to it.
