diff --git a/README.prod b/README.prod index 4cd28031ff..135ea2f2f0 100644 --- a/README.prod +++ b/README.prod @@ -45,6 +45,53 @@ successfully, the main installation process will be complete, and if you are planning on using password authentication, you should be able to visit the URL for your server and register for an account. +(6) Subscribe to +https://groups.google.com/forum/#!forum/zulip-announce to get +announcements about new releases, security issues, etc. + +======================================================================= + +Maintaining Zulip in production: + +* To upgrade to a new version, download the appropriate release + tarball from https://www.zulip.org, and then run as root + + /home/zulip/deployments/current/scripts/upgrade-zulip + + The upgrade process will shut down the service, run `apt-get + upgrade` and any database migrations, and then bring the service + back up. This will result in some brief downtime for the service, + which should be under 30 seconds unless there is an expensive + transition involved. Unless you have tested the upgrade in advance, + we recommend doing upgrades at off hours. + + You can create your own release tarballs from a copy of this + repository using `tools/build-release-tarball`. + +* To update your settings, simply edit /etc/zulip/settings.py and then + run /home/zulip/deployments/current/scripts/restart-server to + restart the server + +* You are responsible for running "apt-get upgrade" on your system on + a regular basis to ensure that it is up to date with the latest + security patches. + +* To use the Zulip API with your Zulip server, you will need to use the + API endpoint of e.g. "https://zulip.yourdomain.net/api". Our Python + API example scripts support this via the + "--site=https://zulip.yourdomain.net" argument. The API bindings + support it via putting "site=https://zulip.yourdomain.net" in your + .zuliprc. + +* Similarly, you will need to instruct your users to specify the URL + for your Zulip server when using the Zulip desktop and mobile apps. + +* As a measure to mitigate the impact of potential memory leaks in one + of the Zulip daemons, the service automatically restarts itself + every Sunday early morning. See /etc/cron.d/restart-zulip for the + precise configuration. + + ======================================================================= SSO Authentication: @@ -88,45 +135,3 @@ To enable the Apache integration site. Now you should be able to visit https://zulip.yourdomain.net/ and login via the SSO solution. - -======================================================================= - -Maintaining Zulip in production: - -* To upgrade to a new version, download the appropriate release - tarball from https://www.zulip.org, and then run as root - - /home/zulip/deployments/current/scripts/upgrade-zulip - - The upgrade process will shut down the service, run `apt-get - upgrade` and any database migrations, and then bring the service - back up. This will result in some brief downtime for the service, - which should be under 30 seconds unless there is an expensive - transition involved. Unless you have tested the upgrade in advance, - we recommend doing upgrades at off hours. - - You can create your own release tarballs from a copy of this - repository using `tools/build-release-tarball`. - -* To update your settings, simply edit /etc/zulip/settings.py and then - run /home/zulip/deployments/current/scripts/restart-server to - restart the server - -* You are responsible for running "apt-get upgrade" on your system on - a regular basis to ensure that it is up to date with the latest - security patches. - -* To use the Zulip API with your Zulip server, you will need to use the - API endpoint of e.g. "https://zulip.yourdomain.net/api". Our Python - API example scripts support this via the - "--site=https://zulip.yourdomain.net" argument. The API bindings - support it via putting "site=https://zulip.yourdomain.net" in your - .zuliprc. - -* Similarly, you will need to instruct your users to specify the URL - for your Zulip server when using the Zulip desktop and mobile apps. - -* As a measure to mitigate the impact of potential memory leaks in one - of the Zulip daemons, the service automatically restarts itself - every Sunday early morning. See /etc/cron.d/restart-zulip for the - precise configuration.