Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add supervisord contrib example #3262

Merged
merged 3 commits into from
Nov 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
.ropeproject/
_build
bower_components/
contrib/supervisord.log
deploy/.vagrant
dist/*
local_settings.py
Expand Down
28 changes: 28 additions & 0 deletions contrib/readme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Running Read the Docs via Supervisord
=====================================

This is the easiest way to start all of the commands you'll need for development
in an environment relatively close to the production evironment. All you need is
``supervisord`` and ``redis-server``. Installation of ``redis-server`` is
outside the scope of this documentation, but once installed, all you need to run
from ``supervisord`` is::

pip install supervisord
cd contrib/
supervisord

This will bring up a web instance for the dashboard, a web instance for
documentation serving, two celery instances, and redis-server.

If you already are running redis-server, this will complain about the port
already being in use, but will still load.

Debugging
---------

To debug, set trace points like normal, with ``pdb``/``ipdb``. Then you can
connect to the process by bringing it to the foreground::

supervisorctl fg main

You'll still see logging to STDERR on the main supervisord process page.
42 changes: 42 additions & 0 deletions contrib/supervisord.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[supervisord]
nodaemon = True
directory = ../
loglevel = error
strip_ansi = False
environment = PYTHONUNBUFFERED=1,READTHEDOCS_INSTANCE=readthedocs.org

[inet_http_server]
port = 127.0.0.1:9001
username = 🍔
password = 🍟

[supervisorctl]
username = 🍔
password = 🍟

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[program:redis]
command = redis-server
directory = ../
priority = 0
startretries = 0
stderr_logfile = /dev/stderr
stderr_logfile_maxbytes = 0

[program:main]
command = python manage.py runserver 8000
directory = ../
priority = 100
stopasgroup = True
stderr_logfile = /dev/stderr
stderr_logfile_maxbytes = 0

[program:celery]
command = celery worker -A readthedocsinc -Q default,celery,web,builder -l DEBUG -c 2
directory = ../
priority = 100
stopasgroup = True
stderr_logfile = /dev/stderr
stderr_logfile_maxbytes = 0