paulmataruso/docker-zulip
1
0
Fork 0
mirror of https://github.com/zulip/docker-zulip.git synced 2025-11-21 23:18:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

README: Expand some words.

Browse Source
This commit is contained in:
Alex Vandiver
2024-12-04 12:27:53 -05:00
committed by Tim Abbott
parent 9a6611802b
commit 520c562853
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -32,7 +32,7 @@ To use `docker-zulip`, you need the following:
engine. engine.
- We [recommend at least 2GB of available RAM][prod-requirements] for - We [recommend at least 2GB of available RAM][prod-requirements] for
running a production Zulip server; you'll want 4GB if you're running a production Zulip server; you'll want 4GB if you're
building the container (rather than using the prebuilt images). If building the container (rather than using the pre-built images). If
you're just testing and/or aren't expecting a lot of users/messages, you're just testing and/or aren't expecting a lot of users/messages,
you can get away with significantly less especially for the you can get away with significantly less especially for the
`postgres`, `memcached`, etc. containers, because Docker makes it `postgres`, `memcached`, etc. containers, because Docker makes it
@@ -97,7 +97,7 @@ sample configuration to run that Zulip server with each of the major
## Running a Zulip server with docker-compose ## Running a Zulip server with docker-compose
To use this project, we recommend starting by cloning the repo (since To use this project, we recommend starting by cloning the repository (since
you'll want to edit the `docker-compose.yml` file in this project): you'll want to edit the `docker-compose.yml` file in this project):
``` ```
@@ -183,11 +183,11 @@ which you need to encode in the YAML file. For example,
**Reducing RAM usage**. By default, the Zulip server automatically detect **Reducing RAM usage**. By default, the Zulip server automatically detect
whether the system has enough memory to run Zulip queue processors in the whether the system has enough memory to run Zulip queue processors in the
higher-throughput but more multiprocess mode (or to save 1.5GiB of RAM with higher-throughput but more multiprocess mode (or to save 1.5GiB of RAM with
the multithreaded mode). This algorithm might see the host's memory, not the the multi-threaded mode). This algorithm might see the host's memory, not the
docker container's memory. Set to `QUEUE_WORKERS_MULTIPROCESS` to `true` or docker container's memory. Set to `QUEUE_WORKERS_MULTIPROCESS` to `true` or
`false` to override the automatic calculation. `false` to override the automatic calculation.
**SSL Certificates**. By default, the image will generate a self-signed cert. **SSL Certificates**. By default, the image will generate a self-signed certificate.
You can set `SSL_CERTIFICATE_GENERATION: "certbot"` within `docker-compose.yml` You can set `SSL_CERTIFICATE_GENERATION: "certbot"` within `docker-compose.yml`
to enable automatically-renewed Let's Encrypt certificates. By using certbot to enable automatically-renewed Let's Encrypt certificates. By using certbot
here, you are agreeing to the [Let's Encrypt here, you are agreeing to the [Let's Encrypt