mirror of
https://github.com/zulip/docker-zulip.git
synced 2025-11-18 12:53:11 +00:00
86 lines
3.0 KiB
Markdown
86 lines
3.0 KiB
Markdown
# Welcome to docker-zulip!
|
|
|
|
[](https://microbadger.com/images/galexrt/zulip "Get your own image badge on microbadger.com")
|
|
|
|
[](https://quay.io/repository/galexrt/zulip)
|
|
|
|
Image available from:
|
|
* [**Quay.io**](https://quay.io/repository/galexrt/zulip)
|
|
* [**Docker Hub**](https://hub.docker.com/r/galexrt/zulip)
|
|
|
|
Current Zulip version: `1.5.1`
|
|
Current Docker image version: `1.5.1`
|
|
|
|
***
|
|
|
|
This is a container image for [Zulip](https://zulip.org) from [Dropbox](https://blogs.dropbox.com/tech/2015/09/open-sourcing-zulip-a-dropbox-hack-week-project/)
|
|
|
|
**Quote from [Zulip.Org](https://zulip.org)**:
|
|
> Powerful open source group chat
|
|
|
|
Thanks to dropbox for Open Sourcing Zulip! - [Zulip's Github](https://github.com/zulip/zulip)
|
|
|
|
***
|
|
|
|
## How to configure the container
|
|
|
|
See the [Configuration](https://github.com/Galexrt/docker-zulip/wiki/Configuration) Page for infos about 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.5.1`
|
|
or
|
|
`docker pull galexrt/zulip:1.5.1`
|
|
|
|
### For the latest development image run
|
|
`docker pull quay.io/galexrt/zulip:dev`
|
|
|
|
***
|
|
|
|
## **Configure your `docker-compose.yml`, before running the container!**
|
|
**If you don't configure it, you'll end up with a misconfigured Zulip Instance!**
|
|
|
|
Check the wiki page on how to configure the image, [here](https://github.com/galexrt/docker-zulip/wiki/Configuration). [Wiki Page](https://github.com/galexrt/docker-zulip/wiki/Configuration)
|
|
|
|
***
|
|
|
|
## 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/`.
|
|
|
|
***
|
|
|
|
## 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.1 cat /etc/zulip/uwsgi.ini > YOUR_ZULIP_DATA_PATH/settings/etc-zulip/
|
|
```
|
|
|
|
## Community
|
|
|
|
* Chat with other docker-zulip users in the **IRC**. On the [IRC Freenode Webchat](https://webchat.freenode.net) or using a client [Join IRC channel](irc://chat.freenode.net:6697/#docker-zulip) server, in the #docker-zulip channel
|
|
|
|
## 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! **:-)**
|