docs.zammad.org Open in urlscan Pro
104.17.33.82  Public Scan

Form analysis
2 forms found in the DOM

GET ../search.html

<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  <input type="text" name="q" placeholder="Search docs" aria-label="Search docs">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>

GET //readthedocs.org/projects/zammad/search/

<form id="flyout-search-form" class="wy-form" target="_blank" action="//readthedocs.org/projects/zammad/search/" method="get">
  <input type="text" name="q" aria-label="Search docs" placeholder="Search docs">
</form>

Text Content

Zammad System Documentation
latest


About

 * Zammad

Prerequisites

 * Software
 * Hardware

Installation & Update

 * Install from package
 * Install from source
 * Set up Elasticsearch
 * Install with Docker Compose
   * Install Docker Environment
   * Getting started with zammad-docker-compose
     * Docker Compose Environment Variables
     * Step 1: Clone GitHub repo
     * Step 2: Setting vm.max_map_count for Elasticsearch
     * Step 3: Adjust Environment as needed
     * Step 4: Start Zammad using DockerHub images
   * Next steps
 * Install on Kubernetes via Helm
 * Updating Zammad

Getting started

 * Configure the webserver
 * First steps

Migration

 * Migrating to Zammad

Administration via ...

 * Web-UI
 * Console

Contributing / Development

 * Start

REST API

 * Introduction
 * User
 * Organization
 * Group
 * Roles
 * Calendar
 * Service-Level Agreements (SLA)
 * Ticket Endpoints
 * Generic CTI
 * Online Notification
 * Object
 * User Access Token

Appendix

 * Backup and Restore
 * Configuration via Environment Variables
 * Configure Database server
 * Migrate to PostgreSQL server
 * Privacy & Data Retention
 * Troubleshooting and FAQ
 * Single Sign-On for Kerberos
 * Reporting Tools (Third party)

Zammad System Documentation
 * 
 * Install with Docker Compose
 * Edit on GitHub

--------------------------------------------------------------------------------


INSTALL WITH DOCKER COMPOSE¶

Warning

We currently do not support Docker environments in productive use. It’s no
problem if you run Zammad on docker, however, support is only provided for
Zammad as application!

Docker Compose environments require deeper system know how. If you’re not too
familiar with Docker and the way it works, you may want to stick with the
package installation instead.

Docker is a container-based software framework for automating deployment of
applications. Compose is a tool for defining and running multi-container Docker
applications.

Zammads docker images are hosted on Dockerhub.

Hint

By default, docker compose will use a fixed Zammad version like 6.2.0-1, which
refers to a specific commit. In this scenario, you are responsible to apply
updates by updating the version on your own.

Alternatively, you can also use floating versions that will give you automatic
updates via docker compose pull:

# VERSION=6.2     # all patchlevel updates
# VERSION=6       # including minor updates
# VERSION=latest  # all updates of stable versions, including major
# VERSION=develop # bleeding-edge development version (not recommended for production use)


Before you start, make sure to have at least 4 GB of RAM to run the containers.


INSTALL DOCKER ENVIRONMENT¶

This documentation expects you already have a working Docker Compose
environment. You can find the required documentations for these steps below:

>  * Docker Engine
> 
>  * Docker Compose


GETTING STARTED WITH ZAMMAD-DOCKER-COMPOSE¶




STEP 1: CLONE GITHUB REPO¶

Warning

If you’re updating Zammad, below commands will cause values set in .env and
docker-compose.override.yml to be lost. You’re expected to check if the
docker-compose.yml has changed and if so to adjust it accordingly.

$ git clone https://github.com/zammad/zammad-docker-compose.git
$ cd zammad-docker-compose


Hint

If cloning is too much of a hassle, you can also download the files from
https://github.com/zammad/zammad-docker-compose/releases. This will make sure
file permissions are preserved.


STEP 2: SETTING VM.MAX_MAP_COUNT FOR ELASTICSEARCH¶

Even with running Elasticsearch in a container, you’re required to adjust your
host’s settings to ensure a clean runtime.

$ sysctl -w vm.max_map_count=262144



STEP 3: ADJUST ENVIRONMENT AS NEEDED¶

In some cases our default environment is not what a docker-compose user is
looking for. To remove complexity from this page, we outsourced information on
this topic.

See Docker Compose Environment Variables


STEP 4: START ZAMMAD USING DOCKERHUB IMAGES¶

Warning

Before starting your containers ensure to not use default login data for your
Zammad database! See Step 3!

$ docker compose up -d


Hint

🔧 How to run rails/rake commands in containers

The docker entrypoint script sets up environment variables required by Zammad to
function properly. That is why calling rails / rake on the console should be
done via one of the following methods:

$ docker compose run --rm zammad-railsserver rails r '...your rails command here...'


This will run the command via the docker entrypoint and is recommended. In case
you require the use of docker exec, you can use the following command:

$ docker exec zammad-docker-compose-zammad-railsserver-1 /docker-entrypoint.sh rails r '...your rails command here...'


This will manually invoke the docker entrypoint and pass the desired command to
it for execution in the proper environment.


NEXT STEPS¶

With this Zammad technically is ready to go. However, you’ll need to follow the
following further steps to access Zammads Web-UI and getting started with it.

>  1. Connect Zammad with Elasticsearch
> 
>  2. Configure the webserver
> 
>  3. First steps
> 
>  4. You may also find Zammads Console commands useful

If you expect usage with 5 agents or more you may also want to consider the
following pages.

>  * Performance Tuning
> 
>  * Configure Database server

Previous Next

--------------------------------------------------------------------------------

Private docs hosting for any Docs as Code tool. Start a trial with Read the Docs
for Business.
Ads by EthicalAds
×

© Copyright 2024, Zammad. Revision 2ad1e068.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions latest stable pre-release Downloads HTML Epub On Read the Docs Project
Home Builds Downloads On GitHub View Edit Search


--------------------------------------------------------------------------------

Hosted by Read the Docs · Privacy Policy