mirror of
https://github.com/zokradonh/kopano-docker
synced 2025-06-17 21:06:13 +00:00
4728072dd5
update Dockerfiles/Makefile for use with kopano supported build introduce a local ldap image with some demo users include caddy for reverse proxying add proper documentation and remove obsolete build and push scripts Signed-off-by: Felix Bartels <felix@host-consultants.de>
73 lines
4.8 KiB
Markdown
73 lines
4.8 KiB
Markdown
# (unofficial) Kopano Docker Images
|
|
|
|
This repository contains an easy to replicate recipe to spin up a [Kopano](https://kopano.com/) demo enviroment, which can (through modification of `.env` and possibly `docker-compose.yml`) also be used for production environments.
|
|
|
|
## How to get started?
|
|
|
|
- make sure that you are running a recent enought version of Docker and [Docker Compose](https://docs.docker.com/compose/install/)
|
|
- clone this repository to your local disk
|
|
- run `git submodule update --init --recursive` from within the checkout to also clone submodules
|
|
- run `setup.sh`
|
|
- this script will ask you a few questions about your environment.
|
|
- If you are just interested in the demo environment you can accept the default values by pressing `Enter` on each question
|
|
- afterwards it builds a local image for the demo LDAP and the reverse proxy
|
|
- now run `docker-compose up` and you will see how the remaining Docker images are pulled and then everything is started
|
|
- after startup has succeeded you can access the Kopano WebApp by going to `https://webapp.kopano.demo` (if you have given a differing LDAP Domain name then it will be `https://webapp.your.domain`).
|
|
- you can also access phpLDAPadmin by going to `https://ldap.kopano.demo`
|
|
|
|
**Note:** For the reverse proxy to work you need to make sure that the given domain resolves to the reverse proxy.
|
|
|
|
The `docker-compose.yml` file by default pulls Docker containers from https://hub.docker.com/r/zokradonh/kopano_core/ and https://hub.docker.com/r/zokradonh/kopano_webapp/. These images are based on the [Kopano nightly builds](https://download.kopano.io/community/) and will contain the latest version available from the time the image was built.
|
|
|
|
### Need to adjust any values after the initial run of `setup.sh`?
|
|
|
|
If you want to modify some of the values from the `setup.sh` run you can simply edit `.env` in your favourite editor. Repeated runs of `setup.sh` will neither modify `docker-compose.yml` nor `.env`. In that file you will also find some given defaults like ldap query filters and the local ports for the Caddy reverse proxy.
|
|
|
|
### How to use a newer version than the one available from the Docker Hub?
|
|
|
|
In this repository you can also find a Makefile that automates the process of building newer images.
|
|
|
|
You can easily rebuild all images based on the currently available Kopano version by running `make build-all`. To just rebuild a certain image you can also run `make build-core` or `make build-webapp`. Please check the `Makefile` to see other possible targets. (depending on your environment you may also be able to autocomplete with the `Tab` key)
|
|
|
|
To be able to easily go back to a previous version you can also "tag" you Docker images by running e.g. `make tag-core`.
|
|
|
|
### How to use the project with the official and supported Kopano releases?
|
|
|
|
This project also makes it possible to build Docker images based on the official Kopano releases. For this the following section needs to be modified in `.env`:
|
|
|
|
```
|
|
# Docker Repository to push to
|
|
#docker_repo=zokradonh
|
|
|
|
# modify below to build a different version, than the kopano nightly release
|
|
#KOPANO_CORE_REPOSITORY_URL=https://serial:REPLACE-ME@download.kopano.io/supported/core:/final/Debian_9.0/
|
|
#KOPANO_WEBAPP_REPOSITORY_URL=https://serial:REPLACE-ME@download.kopano.io/supported/webapp:/final/Debian_9.0/
|
|
#RELEASE_KEY_DOWNLOAD=1
|
|
#DOWNLOAD_COMMUNITY_PACKAGES=0
|
|
```
|
|
Just uncomment the last four lines and insert your Kopano subscription key where it currently says `REPLACE-ME`. Once this is done a `make build-all` will rebuild the images based on the latest available Kopano release (don't forget to `make tag-core` and `make tag-webapp` your images after building them).
|
|
|
|
If you are running a private Docker Registry then you may also change `docker_repo` to reference your internal registry.
|
|
|
|
***WARNING***
|
|
|
|
The built image includes your subscription key! Do not push this image to any public registry like e.g. https://hub.docker.com!
|
|
|
|
### Some more commands for those unfamilar with docker-compose
|
|
|
|
- Start ``docker-compose-yml`` file in the background: `docker-compose up -d`
|
|
- Get a status overview of the running containers`: `docker-compose ps`
|
|
- Stop compose running in the background: `docker-compose stop`
|
|
- Destroy local containers and network interfaces: `docker-compose down`
|
|
- Run commands in a running container: `docker-compose exec kserver kopano-cli --list-users`
|
|
- Get logs of a container running in the background: `docker-compose logs -f kserver`
|
|
|
|
|
|
## Third party docker images
|
|
|
|
The example `docker-compose.yml` uses the following components for the MTA (mail delivery, including anti-spam & anti-virus) and openLDAP. Please consult their documentation for further configuration advice.
|
|
|
|
- https://github.com/tomav/docker-mailserver/
|
|
- https://github.com/osixia/docker-openldap
|
|
- https://github.com/osixia/docker-phpLDAPadmin
|