Skip to content

Commit a0aa532

Browse files
authored
adjust readme and docker image path (#310)
Signed-off-by: André Bauer <[email protected]> Signed-off-by: André Bauer <[email protected]>
1 parent 731f83d commit a0aa532

File tree

3 files changed

+13
-87
lines changed

3 files changed

+13
-87
lines changed

.env

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@ POSTGRES_PASS=zammad
44
POSTGRES_USER=zammad
55
REDIS_URL=redis://zammad-redis:6379
66
RESTART=always
7-
# don't forget to add the minus before the version
8-
VERSION=-5.2.3-32
7+
VERSION=5.2.3-35

README.md

Lines changed: 7 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,15 @@ This repository is meant to be the starting point for somebody who likes to use
1414

1515
[Learn more on Zammads documentation](https://docs.zammad.org/en/latest/install/docker-compose.html)
1616

17+
## Upgrading
18+
19+
For upgrading instrcutions see our [Releases](https://github.com/zammad/zammad-docker-compose/releases).
20+
21+
Please be aware that the zammad-cocker-compose repository versions and tags don't match the Zammad container tags!
22+
1723
## Status
1824

19-
[![CI Status](https://github.com/zammad/zammad-docker-compose/workflows/ci/badge.svg)](https://github.com/zammad/zammad-docker-compose/actions) [![Docker Pulls](https://badgen.net/docker/pulls/zammad/zammad-docker-compose?icon=docker&label=pulls)](https://hub.docker.com/r/zammad/zammad-docker-compose/)
25+
[![ci-remote-image](https://github.com/zammad/zammad-docker-compose/actions/workflows/ci-remote-image.yaml/badge.svg)](https://github.com/zammad/zammad-docker-compose/actions/workflows/ci-remote-image.yaml) [![Docker Pulls](https://badgen.net/docker/pulls/zammad/zammad-docker-compose?icon=docker&label=pulls)](https://hub.docker.com/r/zammad/zammad-docker-compose/)
2026

2127
## Using a reverse proxy
2228

@@ -43,82 +49,3 @@ RANCHER_URL=http://RANCHER_HOST:8080 rancher-compose --env-file=.env up
4349
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.
4450

4551
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.
46-
47-
## Upgrading
48-
49-
### From =< to 5.0.0 to 5.2.3-32
50-
51-
* Elasticsearch was updated from 7.17.3 to 8.5.0 using the Bitnami image
52-
* We don't use a custom build of the docker image anymore as ingest-attachment is no longer a plugin but instead a module packaged with this distribution of Elasticsearch
53-
* ELASTICSEARCH_REINDEX var should be set to true
54-
55-
* PostgreSql was updated from 9.6.24 to 15.0.0
56-
* We don't use a custom build of the docker image anymore as we just mount the backup script to the postgres container now
57-
* backup / restore ins needed to update
58-
* you can create a new backup (with your old postgres 9.6 version / still in previous git version) by:
59-
* if you already have checked out the newest commit
60-
* `git checkout cd424e98689b8dc49878a37b9aab67192c36fd24`
61-
* docker-compose stop
62-
* docker-compose up
63-
* check docker logs until "backup finished :)" is shown as last(!) entry
64-
* `docker logs -f zammad-docker-compose_zammad-backup_1`
65-
* `docker-compose stop`
66-
* you can restore the backup in postgres 15 like
67-
* update git epository
68-
* `git checkout master`
69-
* `git pull`
70-
* stop docker-compose if it's running
71-
* `docker-compose stop`
72-
* delete old zammad postgre container and volume (data is lost! get sure your backups are in place!)
73-
* `docker container rm zammad-docker-compose_zammad-postgresql_1`
74-
* `docker volume rm zammad-docker-compose_postgresql-data`
75-
* recreate zammads postgres volume
76-
* `docker volume create zammad-docker-compose_postgresql-data`
77-
* start a temporary restore container (adjust username & password vars if needed)
78-
* `docker run -it --rm --name postgres-restore -v zammad-docker-compose_zammad-backup:/var/tmp/zammad:ro -v zammad-docker-compose_postgresql-data:/var/lib/postgresql/data -e POSTGRES_USER=zammad -e POSTGRES_PASSWORD=zammad postgres:15.0-alpine`
79-
* in a second bash shell run:
80-
* show available backups
81-
* `docker exec -it postgres-restore bash -c "ls -al /var/tmp/zammad/"`
82-
* create zammad_production db
83-
* `docker exec -it postgres-restore bash -c "psql -U zammad --command='CREATE DATABASE zammad_production'"`
84-
* restore old data with adjusted filename you got from the ls command above
85-
* `docker exec -it postgres-restore bash -c "gunzip -kc /var/tmp/zammad/!!!ENTER_PSQL_FILE_NAME_FROM_COMMAND_ABOVE!!!_zammad_db.psql.gz | psql -U zammad" -d zammad_production`
86-
* stop the restore container
87-
* `docker stop postgres-restore`
88-
* in your first bash shell
89-
* `docker-compose up`
90-
91-
### From =< 4.0.0 to 5.0.0
92-
93-
Memchached config changed. If you use the old env vars `MEMCACHED_HOST` & `MEMCACHED_PORT` adapt to `MEMCACHE_SERVERS`.
94-
Redis is a dependency for the Websocket server now.
95-
96-
### From =< 3.6.0-65
97-
98-
To be able to run Zammad container with an unprivileged user we had to change the port Nginx uses from 80 to 8080, so Zammad needs to be accessed via <http://localhost:8080> instead of <http://localhost> now!
99-
100-
This change will also affect you, if you use a reverse proxy, like Traefik or Haproxy, in front of Zammad as your reverse proxy configuration needs to be adapted to point to port 8080 now.
101-
102-
### From =< 3.3.0-12
103-
104-
We've updated the Elasticsearch image from 5.6 to 7.6.
105-
As there is no direct upgrade path we have to delete all Elasticsearch indices and rebuild them.
106-
This will depend on the name of your docker container and volume, which depends on the checkout directory (`zammad-docker-compose` by default):
107-
108-
```console
109-
docker-compose stop
110-
docker container rm zammad-docker-compose_zammad-elasticsearch_1
111-
docker volume rm zammad-docker-compose_elasticsearch-data
112-
docker-compose up --no-recreate
113-
```
114-
115-
To workaround the [changes in the PostgreSQL 9.6 container](https://github.com/docker-library/postgres/commit/f1bc8782e7e57cc403d0b32c0e24599535859f76) do the following:
116-
117-
```console
118-
docker-compose start
119-
docker exec -it zammaddockercompose_zammad-postgresql_1 bash
120-
psql --username postgres --dbname zammad_production
121-
CREATE USER zammad;
122-
ALTER USER zammad WITH PASSWORD 'zammad';
123-
ALTER USER zammad WITH SUPERUSER CREATEDB;
124-
```

docker-compose.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ services:
3636
- POSTGRESQL_USER=${POSTGRES_USER}
3737
- POSTGRESQL_PASS=${POSTGRES_PASS}
3838
- REDIS_URL=${REDIS_URL}
39-
image: ${IMAGE_REPO}:zammad${VERSION}
39+
image: ${IMAGE_REPO}:${VERSION}
4040
restart: on-failure
4141
volumes:
4242
- zammad-data:/opt/zammad
@@ -52,7 +52,7 @@ services:
5252
- "8080"
5353
depends_on:
5454
- zammad-railsserver
55-
image: ${IMAGE_REPO}:zammad${VERSION}
55+
image: ${IMAGE_REPO}:${VERSION}
5656
restart: ${RESTART}
5757
volumes:
5858
- zammad-data:/opt/zammad
@@ -75,7 +75,7 @@ services:
7575
environment:
7676
- MEMCACHE_SERVERS=${MEMCACHE_SERVERS}
7777
- REDIS_URL=${REDIS_URL}
78-
image: ${IMAGE_REPO}:zammad${VERSION}
78+
image: ${IMAGE_REPO}:${VERSION}
7979
restart: ${RESTART}
8080
volumes:
8181
- zammad-data:/opt/zammad
@@ -93,7 +93,7 @@ services:
9393
environment:
9494
- MEMCACHE_SERVERS=${MEMCACHE_SERVERS}
9595
- REDIS_URL=${REDIS_URL}
96-
image: ${IMAGE_REPO}:zammad${VERSION}
96+
image: ${IMAGE_REPO}:${VERSION}
9797
restart: ${RESTART}
9898
volumes:
9999
- zammad-data:/opt/zammad
@@ -107,7 +107,7 @@ services:
107107
environment:
108108
- MEMCACHE_SERVERS=${MEMCACHE_SERVERS}
109109
- REDIS_URL=${REDIS_URL}
110-
image: ${IMAGE_REPO}:zammad${VERSION}
110+
image: ${IMAGE_REPO}:${VERSION}
111111
restart: ${RESTART}
112112
volumes:
113113
- zammad-data:/opt/zammad

0 commit comments

Comments
 (0)