Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/docs/production/requirements.md

128 lines
5.0 KiB
Markdown
Raw Normal View History

docs: Improve Zulip in Production page navigation and ToC. Improves readability of ToC and makes pages more navigable by shortening Zulip in Production page headings.
2016-08-09 22:21:19 +02:00
# Requirements
Move production installation requirements to separate page. To begin the process of consolidating Zulip documentation on Read the Docs, the requirements are now their own topic page, and index.rst links to it. Fixes: #669.
2016-07-12 21:35:25 +02:00
install docs: Move requirements tl;dr to requirements doc. This further reduces the wall of text on the install instructions. Simultaneously it lightens up the pressure on this summary to be quite so terse; expand a couple of items into multiple bullets (yet with fewer words!) for greater readability.
2018-03-03 03:12:40 +01:00
To run a Zulip server, you will need:
* A dedicated machine or VM
* A supported OS:
docs: Document production support for Debian Stretch and Ubuntu Bionic. Fixes #9197.
2018-06-05 17:03:15 +02:00
* Ubuntu 18.04 Bionic
* Ubuntu 16.04 Xenial
* Ubuntu 14.04 Trusty (not recommended for new installations)
* Debian 9 Stretch
install docs: Move requirements tl;dr to requirements doc. This further reduces the wall of text on the install instructions. Simultaneously it lightens up the pressure on this summary to be quite so terse; expand a couple of items into multiple bullets (yet with fewer words!) for greater readability.
2018-03-03 03:12:40 +01:00
* At least 2GB RAM, and 10GB disk space
* If you expect 100+ users: 4GB RAM, and 2 CPUs
* A hostname in DNS
* Credentials for sending email
For details on each of these requirements, see below.
docs: Reorganize requirements page with server/credentials categories.
2016-08-25 00:19:10 +02:00
## Server
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
install docs: Say explicitly that Zulip should have its own (virtual) machine. This is the main thing that https://zulip.org/server.html explains that we don't yet in our main documentation tree.
2017-07-26 00:32:51 +02:00
#### General
docs: Add tips on installing on an existing server.
2017-05-24 22:36:15 +02:00
The installer expects Zulip to be the **only thing** running on the
install docs: Say explicitly that Zulip should have its own (virtual) machine. This is the main thing that https://zulip.org/server.html explains that we don't yet in our main documentation tree.
2017-07-26 00:32:51 +02:00
system; it will install system packages with `apt` (like nginx,
postgresql, and redis) and configure them for its own use. We
docs: Add tips on installing on an existing server.
2017-05-24 22:36:15 +02:00
strongly recommend using either a fresh machine instance in a cloud
provider, a fresh VM, or a dedicated machine. If you decide to
disregard our advice and use a server that hosts other services, we
can't support you, but
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
[we do have some notes on issues you'll encounter](install-existing-server.html).
install docs: Say explicitly that Zulip should have its own (virtual) machine. This is the main thing that https://zulip.org/server.html explains that we don't yet in our main documentation tree.
2017-07-26 00:32:51 +02:00
#### Operating System
docs: Document production support for Debian Stretch and Ubuntu Bionic. Fixes #9197.
2018-06-05 17:03:15 +02:00
Ubuntu 18.04 Bionic, Ubuntu 16.04 Xenial, Ubuntu 14.04 Trusty and
Debian Stretch are supported for running Zulip in production. 64-bit
is recommended. We also recommend installing on the newest option
you're comfortable with, to save your organization the work of
upgrading.
install docs: Say explicitly that Zulip should have its own (virtual) machine. This is the main thing that https://zulip.org/server.html explains that we don't yet in our main documentation tree.
2017-07-26 00:32:51 +02:00
docs: Document need to enable Universe repository on Ubuntu.
2018-10-31 19:53:09 +01:00
If you're using Ubuntu, the
[Ubuntu universe repository][ubuntu-repositories] must be
scripts: Recommend apt update after enabling universe. One needs to manually do an apt update after add-apt-repository, or it won't actually work.
2019-01-26 21:27:10 +01:00
[enabled][enable-universe], which is usually just:
```
sudo add-apt-repository universe
sudo apt update
```
docs: Document need to enable Universe repository on Ubuntu.
2018-10-31 19:53:09 +01:00
[ubuntu-repositories]:
https://help.ubuntu.com/community/Repositories/Ubuntu
[enable-universe]: https://help.ubuntu.com/community/Repositories/CommandLine#Adding_the_Universe_and_Multiverse_Repositories
docs: Reorganize requirements page with server/credentials categories.
2016-08-25 00:19:10 +02:00
#### Hardware Specifications
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
requirements: Document anti-recommendation of t2 style instances. If your instance runs out of CPU credits, it will result in a nasty outage. Fixes #1605.
2016-11-27 04:04:35 +01:00
* CPU and Memory: For installations with 100+ users you'll need a
minimum of **2 CPUs** and **4GB RAM**. For installations with fewer
prod-requirements.md: Fix grammar. Change "strong" to "strongly" (adverb).
2017-04-12 05:48:02 +02:00
users, 1 CPU and 2GB RAM is sufficient. We strongly recommend against
requirements: Document anti-recommendation of t2 style instances. If your instance runs out of CPU credits, it will result in a nasty outage. Fixes #1605.
2016-11-27 04:04:35 +01:00
installing with less than 2GB of RAM, as you will likely experience
out of memory issues installing dependencies. We recommend against
using highly CPU-limited servers like the AWS `t2` style instances
for organizations with a hundreds of users (active or no).
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
docs: Improve documentation on resource requirements.
2017-06-04 08:38:44 +02:00
See our
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
[documentation on scalability](../production/maintain-secure-upgrade.html#scalability)
docs: Improve documentation on resource requirements.
2017-06-04 08:38:44 +02:00
for advice on hardware requirements for larger organizations.
docs: Update recommendations of disk requirements. Addresses part of #5724.
2017-07-07 21:40:00 +02:00
* Disk space: You'll need at least 10GB of free disk space for a
server with dozens of users. If you intend to store uploaded files
locally rather than on S3 you will likely need more, depending how
often your users upload large files. You'll eventually need 100GB
or more if you have thousands of active users or millions of total
messages sent.
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
docs: Reorganize requirements page with server/credentials categories.
2016-08-25 00:19:10 +02:00
#### Network and Security Specifications
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
requirements: Document more clearly ports required for Zulip.
2017-01-10 20:40:47 +01:00
* Incoming HTTPS access (usually port 443, though this is
configurable) from the networks where your users are (usually, the
public Internet). If you also open port 80, Zulip will redirect
users to HTTPS rather than not working when users type
e.g. `http://zulip.example.com` in their browser. If you are using
Zulip's [incoming email integration][email-mirror-code] you may also
need incoming port 25 open.
[email-mirror-code]: https://github.com/zulip/zulip/blob/master/zerver/management/commands/email_mirror.py
* Outgoing HTTP(S) access (ports 80 and 443) to the public Internet so
docs: Update email configuration documentation. Fixes #2958.
2017-02-22 06:12:12 +01:00
that Zulip can properly manage inline image previews. You'll also
need outgoing SMTP access to your SMTP server (the standard port for
this is 587) so that Zulip can send email.
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
docs: Reorganize requirements page with server/credentials categories.
2016-08-25 00:19:10 +02:00
#### Domain name
docs: Tweak discussion of SSL certs in prod requirements.
2017-12-13 05:08:35 +01:00
You should already have a domain name (e.g., `zulip.example.com`)
available for your Zulip server. In order to generate valid SSL
certificates [with Certbot][doc-certbot], and to enable other services
such as Google authentication, you'll need to set the domain's
A record to point to your production server.
docs: Reorganize requirements page with server/credentials categories.
2016-08-25 00:19:10 +02:00
## Credentials needed
#### SSL Certificate
install docs: Cut SSL cert from requirements summary. The summary already has a qualifier that basically says it shouldn't matter for most people -- making it simultaneously the most complicated bullet there, and among the least likely to matter. And in fact, this requirement shouldn't matter for *anyone* when first experimenting with Zulip. If certbot won't work in a given admin's environment, and the available ways to get a cert aren't convenient, they can always let the installer generate a self-signed cert to get going, and circle back to the issue later. So, make that option clear in the main requirements text, and then just cut the whole bullet from the summary.
2018-03-03 03:24:05 +01:00
Your Zulip server will need an SSL certificate for the domain name it
uses. For most Zulip servers, the recommended (and simplest) way to
get this is to just [use the `--certbot` option][doc-certbot] in the
Zulip installer, which will automatically get a certificate for you
and keep it renewed.
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
install docs: Cut SSL cert from requirements summary. The summary already has a qualifier that basically says it shouldn't matter for most people -- making it simultaneously the most complicated bullet there, and among the least likely to matter. And in fact, this requirement shouldn't matter for *anyone* when first experimenting with Zulip. If certbot won't work in a given admin's environment, and the available ways to get a cert aren't convenient, they can always let the installer generate a self-signed cert to get going, and circle back to the issue later. So, make that option clear in the main requirements text, and then just cut the whole bullet from the summary.
2018-03-03 03:24:05 +01:00
For test installations, an even simpler alternative is always
available: [the `--self-signed-cert` option][doc-self-signed] in the
installer.
If you'd rather acquire an SSL certificate another way, see our [SSL
certificate documentation](ssl-certificates.html).
[doc-certbot]: ssl-certificates.html#certbot-recommended
[doc-self-signed]: ssl-certificates.html#self-signed-certificate
docs: Tweak discussion of SSL certs in prod requirements.
2017-12-13 05:08:35 +01:00
docs: Reorganize requirements page with server/credentials categories.
2016-08-25 00:19:10 +02:00
#### Outgoing email
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
docs: Update email configuration documentation. Fixes #2958.
2017-02-22 06:12:12 +01:00
* Outgoing email (SMTP) credentials that Zulip can use to send
outgoing emails to users (e.g. email address confirmation emails
during the signup process, missed message notifications, password
reset, etc.). If you don't have an existing outgoing SMTP solution,
read about
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
[free outgoing SMTP options and options for prototyping](email.html#free-outgoing-email-services).
Move production installation requirements to separate page. To begin the process of consolidating Zulip documentation on Read the Docs, the requirements are now their own topic page, and index.rst links to it. Fixes: #669.
2016-07-12 21:35:25 +02:00
docs: Improve production requirements doc. - Adds headings and organizes for greater clarity. - Adds some detail about each of the requirements.
2016-07-28 01:38:02 +02:00
Once you have met these requirements, see [full instructions for installing
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
Zulip in production](../production/install.html).