From 9fa6f3477058d09e29d5fbefe43fe7236e500a23 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Thu, 15 Feb 2024 12:18:52 -0800 Subject: [PATCH] docs: Move installer details to Deployment options page. (cherry picked from commit 112f3d123aa28de9311c0976848aa5172f8d3f13) --- docs/production/deployment.md | 18 +++++++++++++++++- docs/production/install.md | 23 ++--------------------- 2 files changed, 19 insertions(+), 22 deletions(-) diff --git a/docs/production/deployment.md b/docs/production/deployment.md index 332e025d65..1768085400 100644 --- a/docs/production/deployment.md +++ b/docs/production/deployment.md @@ -45,7 +45,23 @@ extremely reliable for years, whereas the Docker image is new and has rough edges, so we recommend the normal installer unless you have a specific reason to prefer Docker. -## Advanced installer options +## Zulip installer details + +The [Zulip installer](install.md) does the following: + +- Creates the `zulip` user, which the various Zulip servers will run as. +- Creates `/home/zulip/deployments/`, which the Zulip code for this + deployment (and future deployments when you upgrade) goes into. At the + very end of the install process, the script moves the Zulip code tree + it's running from (which you unpacked from a tarball above) to a + directory there, and makes `/home/zulip/deployments/current` as a + symbolic link to it. +- Installs Zulip's various dependencies. +- Configures the various third-party services Zulip uses, including + PostgreSQL, RabbitMQ, Memcached and Redis. +- Initializes Zulip's database. + +### Advanced installer options The Zulip installer supports the following advanced installer options as well as those mentioned in the diff --git a/docs/production/install.md b/docs/production/install.md index 6ebfb91da7..f4fc2c3177 100644 --- a/docs/production/install.md +++ b/docs/production/install.md @@ -66,8 +66,8 @@ sudo -s # If not already root ``` This takes a few minutes to run, as it installs Zulip's dependencies. -For more information, see [installer details](#details-what-the-installer-does) -and [troubleshooting](#troubleshooting) below. +For more information, see [installer details](deployment.md#zulip-installer-details) +and [troubleshooting](#troubleshooting). #### Installer options @@ -154,25 +154,6 @@ Learning more: [realm-admin-docs]: https://zulip.com/help/getting-your-organization-started-with-zulip -## Details: What the installer does - -The install script does several things: - -- Creates the `zulip` user, which the various Zulip servers will run as. -- Creates `/home/zulip/deployments/`, which the Zulip code for this - deployment (and future deployments when you upgrade) goes into. At the - very end of the install process, the script moves the Zulip code tree - it's running from (which you unpacked from a tarball above) to a - directory there, and makes `/home/zulip/deployments/current` as a - symbolic link to it. -- Installs Zulip's various dependencies. -- Configures the various third-party services Zulip uses, including - PostgreSQL, RabbitMQ, Memcached and Redis. -- Initializes Zulip's database. - -If you'd like to deploy Zulip with these services on different -machines, check out our [deployment options documentation](deployment.md). - ## Troubleshooting **Install script.**