Skip to content

Install docs improved #2656

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 3, 2017
Merged

Install docs improved #2656

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e25d0e
Remove extra whitespaces
humitos Feb 22, 2017
52739d4
Instructions for installing Elasticsearch, PostgreSQL and Redis
humitos Feb 22, 2017
ddd7afa
Remove PostgreSQL since it's not really required
humitos Mar 3, 2017
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
27 changes: 24 additions & 3 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ need to install Python 3 with virtualenv in your system as well.
.. _Python 2.7: http://www.python.org/
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _Git: http://git-scm.com/
.. _Homebrew: http://brew.sh/
.. _Elasticsearch: https://www.elastic.co/products/elasticsearch
.. _PostgreSQL: https://www.postgresql.org/
.. _Redis: https://redis.io/


.. note::
Expand All @@ -42,7 +46,24 @@ need to install Python 3 with virtualenv in your system as well.
Users of other Linux distributions may need to install the equivalent
packages, depending on their system configuration.

.. _Homebrew: http://brew.sh/
.. note::

If you want full support for searching inside your Read the Docs
site you will need to install Elasticsearch_.

Ubuntu users could install this package as following::

sudo apt-get install elasticsearch

.. note::

Besides the Python specific dependencies, you will also need
PostgreSQL_ and Redis_.

Ubuntu users could install this package as following::

sudo apt-get install redis-server postgresql

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need Postgres actually, we don't have any Postgres-specific code that I know of. The development database is fine, but not recommended for production instances.

We do require Redis currently, though only because of a feature that prints our build queue in our templates. I think we could get rid of this however -- I'll open a ticket to discuss this. I think it's fine to leave the docs on redis in for now.


You will need to verify that your pip version is higher than 1.5 you can do this as such::

Expand Down Expand Up @@ -78,7 +99,7 @@ database::
Then please create a superuser account for Django::

python manage.py createsuperuser

Now let's properly generate the static assets::

python manage.py collectstatic
Expand All @@ -101,7 +122,7 @@ Visit http://127.0.0.1:8000/ in your browser to see how it looks; you can use
the admin interface via http://127.0.0.1:8000/admin (logging in with the
superuser account you just created).

For builds to properly kick off as expected, it is necessary the port
For builds to properly kick off as expected, it is necessary the port
you're serving on (i.e. ``runserver 0.0.0.0:8080``) match the port defined
in ``PRODUCTION_DOMAIN``. You can utilize ``local_settings.py`` to modify this.
(By default, it's ``localhost:8000``)
Expand Down