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

Move production health check doc to separate page.

This commit is contained in:
Sumana Harihareswara 2016-07-12 16:02:30 -04:00 committed by Tim Abbott
parent ec005726c4
commit 07afc9d34b
5 changed files with 73 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.prod.md
View File

@ -29,67 +29,7 @@ See [Authentication and logging into Zulip the first time](https://zulip.readthe
Checking Zulip is healthy and debugging the services it depends on
==================================================================
You can check if the zulip application is running using:
```
supervisorctl status
```
And checking for errors in the Zulip errors logs under
`/var/log/zulip/`. That contains one log file for each service, plus
`errors.log` (has all errors), `server.log` (logs from the Django and
Tornado servers), and `workers.log` (combined logs from the queue
workers).
After you change configuration in `/etc/zulip/settings.py` or fix a
misconfiguration, you will often want to restart the Zulip application.
You can restart Zulip using:
```
supervisorctl restart all
```
Similarly, you can stop Zulip using:
```
supervisorctl stop all
```
The Zulip application uses several major services to store and cache
data, queue messages, and otherwise support the Zulip application:
* postgresql
* rabbitmq-server
* nginx
* redis
* memcached
If one of these services is not installed or functioning correctly,
Zulip will not work. Below we detail some common configuration
problems and how to resolve them:
* An AMQPConnectionError traceback or error running rabbitmqctl
usually means that RabbitMQ is not running; to fix this, try:
```
service rabbitmq-server restart
```
If RabbitMQ fails to start, the problem is often that you are using
a virtual machine with broken DNS configuration; you can often
correct this by configuring `/etc/hosts` properly.
* If your browser reports no webserver is running, that is likely
because nginx is not configured properly and thus failed to start.
nginx will fail to start if you configured SSL incorrectly or did
not provide SSL certificates. To fix this, configure them properly
and then run:
```
service nginx restart
```
If you run into additional problems, [please report
them](https://github.com/zulip/zulip/issues) so that we can update
these lists! The Zulip installation scripts logs its full output to
`/var/log/zulip/install.log`, so please include the context for any
tracebacks from that log.
See [Checking Zulip is healthy and debugging the services it depends on](https://zulip.readthedocs.io/en/latest/prod-health-check-debug.html).
Making your Zulip instance awesome

1
docs/index.rst
View File

@ -50,6 +50,7 @@ Contents:
prod-requirements
prod-install
prod-auth-first-login
prod-health-check-debug
.. _tutorial-docs:

5
docs/prod-auth-first-login.md
View File

@ -3,7 +3,7 @@ Authentication and logging into Zulip the first time
(As you read and follow the instructions in this section, if you run
into trouble, check out the troubleshooting advice in [the next major
section](https://github.com/zulip/zulip/blob/master/README.prod.md#checking-zulip-is-healthy-and-debugging-the-services-it-depends-on).)
section](prod-health-check-debug.html).)
Once you've finished installing Zulip, configuring your settings.py
file, and initializing the database, it's time to login to your new
@ -84,5 +84,4 @@ automatically linkified, e.g., whenever someone mentions "T1234", it
could be auto-linkified to ticket 1234 in your team's Trac instance.
Next step: [Checking that Zulip is healthy and debugging the services
it depends
on](https://github.com/zulip/zulip/blob/master/README.prod.md#checking-zulip-is-healthy-and-debugging-the-services-it-depends-on).
it depends on](prod-health-check-debug.html).

66
docs/prod-health-check-debug.md Normal file
View File

@ -0,0 +1,66 @@
Checking Zulip is healthy and debugging the services it depends on
==================================================================
You can check if the zulip application is running using:
```
supervisorctl status
```
And checking for errors in the Zulip errors logs under
`/var/log/zulip/`. That contains one log file for each service, plus
`errors.log` (has all errors), `server.log` (logs from the Django and
Tornado servers), and `workers.log` (combined logs from the queue
workers).
After you change configuration in `/etc/zulip/settings.py` or fix a
misconfiguration, you will often want to restart the Zulip application.
You can restart Zulip using:
```
supervisorctl restart all
```
Similarly, you can stop Zulip using:
```
supervisorctl stop all
```
The Zulip application uses several major services to store and cache
data, queue messages, and otherwise support the Zulip application:
* postgresql
* rabbitmq-server
* nginx
* redis
* memcached
If one of these services is not installed or functioning correctly,
Zulip will not work. Below we detail some common configuration
problems and how to resolve them:
* An AMQPConnectionError traceback or error running rabbitmqctl
usually means that RabbitMQ is not running; to fix this, try:
```
service rabbitmq-server restart
```
If RabbitMQ fails to start, the problem is often that you are using
a virtual machine with broken DNS configuration; you can often
correct this by configuring `/etc/hosts` properly.
* If your browser reports no webserver is running, that is likely
because nginx is not configured properly and thus failed to start.
nginx will fail to start if you configured SSL incorrectly or did
not provide SSL certificates. To fix this, configure them properly
and then run:
```
service nginx restart
```
If you run into additional problems, [please report
them](https://github.com/zulip/zulip/issues) so that we can update
these lists! The Zulip installation scripts logs its full output to
`/var/log/zulip/install.log`, so please include the context for any
tracebacks from that log.
Next: [Making your Zulip instance awesome.](https://github.com/zulip/zulip/blob/master/README.prod.md#making-your-zulip-instance-awesome)

5
scripts/setup/initialize-database
View File

@ -29,6 +29,7 @@ echo "If you haven't already, you should configure email in /etc/zulip/settings.
echo "And then you should now be able to visit your server over https and sign up using"
echo "an email address that ends with @ADMIN_DOMAIN (from your settings file)."
echo ""
echo "See README.prod.md for instructions on how to confirm your Zulip install is healthy, "
echo " change ADMIN_DOMAIN, debug common issues, and otherwise finish setting things up."
echo "See docs/prod-health-check-debug.md for instructions on how to confirm your Zulip "
echo "install is healthy, change ADMIN_DOMAIN, debug common issues, and otherwise finish "
echo "setting things up."
set -x