Docker Compose scenarios

Panoramica

Se lo stack Zammad "vanilla" non copre il tuo caso d'uso, puoi usare uno degli scenari predefiniti.

I seguenti scenari sono supportati e spiegati più avanti:

• Rendere lo stack disponibile tramite HTTPS
  • Aggiungi un servizio tunnel Cloudflare allo stack
  • Aggiungi un Nginx Proxy Manager (NPM) allo stack
  • Aggiungi una rete Docker esterna a Nginx
• Usare servizi esterni
  • Disabilita il servizio Elasticsearch
• Rendere i servizi disponibili esternamente
  • Aggiungi una rete Docker esterna a Elasticsearch
  • Aggiungi una porta host a Elasticsearch
• Scenari aggiuntivi
  • Disabilita il servizio di backup
  • Aggiungi un'istanza Ollama allo stack
  • Limita le risorse hardware dello stack

Puoi trovare i file nel repository Zammad-Docker-Compose.

General usage

Segui la guida generale di deployment e applica le seguenti modifiche.

Sotto il campo "Compose path", fai clic sul pulsante Add file. Questo apre la sezione "Additional paths" dove puoi specificare lo scenario che vuoi utilizzare. Aggiungi scenarios/{scenario you want to use}.yml e sostituisci l’ultima parte tra le parentesi {} con il nome di uno dei file scenario. Puoi anche combinare più scenari aggiungendo ulteriori percorsi.

Making the stack available via HTTPS

Se configuri Zammad per l'uso in produzione, deve essere protetto usando una connessione HTTPS.

Add Cloudflare tunnel

If you want to publish Zammad in a very convenient way, you can use a Cloudflare tunnel.

• Usa il file di scenario scenarios/add-cloudflare-tunnel.yml per la distribuzione
• Aggiungi un sotto-dominio a un dominio già esistente nella tua dashboard Cloudflare
• Crea un tunnel per questo sottodominio e configuralo per inoltrare il traffico al tuo zammad-ngin
• Fornisci il tuo token tunnel Cloudflare allo stack Zammad usando la variabile d'ambiente

Add Nginx proxy manager

Una configurazione molto comune per pubblicare servizi web è usare un reverse proxy.

• Usa il file di scenario scenarios/add-nginx-proxy-manager.yml per la distribuzione
• Fornisci il tuo FQDN per Zammad usando la variabile d'ambiente ZAMMAD_FQDN
• Configura il tuo DNS. Il FQDN di Zammad scelto dovrebbe puntare all'indirizzo IP dell'host NPM.
• Configura un nuovo host proxy nel tuo NPM e segui i passaggi per ottenere un certificato SSL

Add external Docker network to Nginx

Se hai già un reverse proxy che si occupa della terminazione SSL, questo scenario fa per te.

• Usa il file di scenario scenarios/add-external-network-to-nginx.yml per la distribuzione
• Fornisci il nome della tua rete esterna usando la variabile d'ambiente `ZAMMAD_NGINX_

Using external services

Disabilita il servizio Elasticsearch

Hai già un'istanza Elasticsearch in esecuzione e vuoi usarla anche per Zammad?

• Usa il file di scenario scenarios/disable-elasticsearch-service.yml per la distribuzione - questo
• Usa le seguenti variabili d'ambiente per fornire informazioni sulla connessione alla tua istanza:
  • ELASTICSEARCH_SCHEMA
  • ELASTICSEARCH_HOST
  • ELASTICSEARCH_PORT
  • ELASTICSEARCH_USER
  • ELASTICSEARCH_PASS

Making services externally available

Questi scenari servono a collegare applicazioni esterne ai servizi di Zammad. A seconda

DANGER

Quando esponi Elasticsearch fuori dallo stack, assicurati di impostare la variabile `ELASTICSEAR

TIP

Se vuoi usare TLS, devi connetterti a Elasticsearch tramite reverse proxy.

Add external Docker network to Elasticsearch

Un caso d'uso comune per questo è usare uno strumento di reporting/visualizzazione come Grafana sulla stessa rete.

• Usa il file di scenario scenarios/add-external-network-to-elasticsearch.yml per la distribuzione
• Fornisci il nome della tua rete esterna usando la variabile d'ambiente `ZAMMAD_ELASTI

Add host port to Elasticsearch

Nel caso tu voglia esporre il servizio Elasticsearch dello stack Zammad nella rete.

• Usa il file di scenario scenarios/add-hostport-to-elasticsearch.yml per la distribuzione
• La porta predefinita per Elasticsearch è 9200. Cambiala con un'altra porta usando la variabile d'ambiente.

Additional scenarios

Disable backup service

Nel caso tu voglia gestire i backup in modo diverso, puoi disabilitare il servizio di backup integrato.

Puoi farlo semplicemente usando il file di scenario scenarios/disable-backup-service.yml.

Aggiungi Ollama

You can spin up an additional Ollama container to use Zammad's AI features on your machine.

INFO

Questo è pensato per scopi di sviluppo o test, poiché eseguire uno stack LLM produttivo è.

Per distribuire un container Ollama all'interno dello stack Zammad, usa il file di scenario scenarios/ad.

Per usarlo in Zammad, aggiungi il nome del servizio e la porta (http://ollama:11434) al provider.

Limit resources

Se vuoi limitare le risorse hardware che lo stack Zammad può usare, usa il file s.

Other use cases

Il tuo scenario non è ancora coperto? Suggerisci pure il tuo caso d'uso. Prevediamo di aggiungerne altri.

Customize the stack locally

Sometimes it's necessary to apply local changes to the Zammad Docker stack, e.g. to include additional services. If you plan to do so, we recommend that you do not change the docker-compose.yml file, but instead create a local docker-compose.override.yml that includes all your modifications. Docker Compose will automatically load this file and merge its changes into your stack.