Skip to content

Commit 0f1917c

Browse files
authored
Merge pull request #2656 from humitos/install-docs-improved
Install docs improved
2 parents ff7d113 + ddd7afa commit 0f1917c

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

docs/install.rst

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ need to install Python 3 with virtualenv in your system as well.
1616
.. _Python 2.7: http://www.python.org/
1717
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
1818
.. _Git: http://git-scm.com/
19+
.. _Homebrew: http://brew.sh/
20+
.. _Elasticsearch: https://www.elastic.co/products/elasticsearch
21+
.. _PostgreSQL: https://www.postgresql.org/
22+
.. _Redis: https://redis.io/
1923

2024

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

45-
.. _Homebrew: http://brew.sh/
49+
.. note::
50+
51+
If you want full support for searching inside your Read the Docs
52+
site you will need to install Elasticsearch_.
53+
54+
Ubuntu users could install this package as following::
55+
56+
sudo apt-get install elasticsearch
57+
58+
.. note::
59+
60+
Besides the Python specific dependencies, you will also need Redis_.
61+
62+
Ubuntu users could install this package as following::
63+
64+
sudo apt-get install redis-server
65+
4666

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

@@ -78,7 +98,7 @@ database::
7898
Then please create a superuser account for Django::
7999

80100
python manage.py createsuperuser
81-
101+
82102
Now let's properly generate the static assets::
83103

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

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

0 commit comments

Comments
 (0)