Jason Michalski e1b4da877f Document the custom_zulip_files mechanism.
Also remove configure-rabbitmq, which is no longer used.
2018-05-16 15:50:17 -07:00
2015-10-20 10:05:29 +02:00
2017-08-24 10:36:45 +02:00
2016-05-25 12:43:18 +02:00

Welcome to docker-zulip!

Docker Repository on Quay.io docker-zulip stream

Image available from:

Current Zulip version: 1.8.1 Current Docker image version: 1.8.1-0


This is a container image for running Zulip in production.

Quote from Zulip.Org:

Powerful open source group chat

Zulip's Github


Zulip requirements

Zulip recommends at least 2GB of RAM for running a production Zulip server.

How to configure the container

See the Configuration page for information on configuring the container to suit your needs.


How to get the container running

To pull the image run

docker pull quay.io/galexrt/zulip:1.8.1-0 or docker pull galexrt/zulip:1.8.1-0

For the latest development image run

docker pull quay.io/galexrt/zulip:dev


Configure docker-compose.yml

Important: You must edit docker-compose.yml to provide various settings before starting the container. In particular, you'll want to set the hostname and potentially edit the default database password.

See the configuration documentation to learn how to configure the image.


Starting the container

To start the container, you have to use either use docker-compose or kubernetes:

Don't forget to configure your docker-compose.yml properly!!

Using docker-compose

Change to the root of the source folder and use docker-compose up.

Using Kubernetes

A Kubernetes pod file is in the kubernetes/ folder. The command to run it would be kubectl create -f ./kubernetes/.


Creating an organization

This step is the analog of creating an organization in Zulip in the main Zulip documentation. To generate the one-time use link, you can use the following command:

docker-compose exec zulip sudo -H -u zulip -g zulip /home/zulip/deployments/current/manage.py generate_realm_creation_link

Follow the link you just got printed and follow the instructions to create your new organization (and first administrator account).


Troubleshooting

zulip-django exited

The main reason for this to happen is that you are missing a config file named uwsgi.ini. The get this file run:

// This command copy the output of file uwsgi.ini into your data volume on the host.
// Replace `YOUR_ZULIP_DATA_PATH` with your path.
host$ docker run --rm quay.io/galexrt/zulip:1.5.2 cat /etc/zulip/uwsgi.ini > YOUR_ZULIP_DATA_PATH/settings/etc-zulip/uwsgi.ini

Community

Chat with other docker-zulip users on the chat.zulip.org. The stream/channel is #production-help.

Contributing

If you find this container useful, here's how you can help:

  • Help users with issues they may encounter
  • Send a pull request with your awesome new features and bug fixes

Please use 4 spaces as intent in the files, Thanks!

A big thanks to everybody that sends in issues, pull request! and helps with the issues/tickets! :-)

Description
Container configurations, images, and examples for Zulip.
Readme Apache-2.0 2 MiB
Languages
Shell 82.7%
Smarty 9%
Dockerfile 8.3%