You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dev/install.rst
+6-23Lines changed: 6 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -15,34 +15,15 @@ A development setup can be hosted by your laptop, in a VM, on a separate server
15
15
* Is Unix-like system (Linux, BSD, Mac OSX) which **supports Docker**. Windows systems should have WSL+Docker or Docker Desktop.
16
16
* Has **10 GB or more of free disk space** on the drive where Docker's cache and volumes are stored. If you want to experiment with customizing Docker containers, you'll likely need more.
17
17
* Can spare *2 GB of system memory* for running Read the Docs, this typically means that a development laptop should have **8 GB or more of memory** in total.
18
+
* Your system should *ideally* match the production system which uses the **latest official+stable Docker** distribution for `Ubuntu <https://docs.docker.com/engine/install/ubuntu/>`_ (the ``docker-ce`` package). If you are on Windows or Mac, you may also want to try `Docker Desktop <https://docs.docker.com/desktop/>`_.
19
+
* We use the latest stable `docker-compose 1.x <https://pypi.org/project/docker-compose/>`_ (this can be installed and run through a virtual environment).
18
20
19
21
.. note::
20
22
21
23
Take into account that this setup is intended for development purposes.
22
24
We do not recommend to follow this guide to deploy an instance of Read the Docs for production.
23
25
24
26
25
-
Installing Docker
26
-
-----------------
27
-
28
-
You need `Docker <https://www.docker.com/>`_ to run a development setup of Read the Docs. The easiest place to start is `Docker's installation guide <https://docs.docker.com/install/>`_, however there might be other more specific ways to get Docker for your exact system.
29
-
30
-
If you run Windows, you can run Docker on `Windows Subsystem for Linux (WSL) <https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers>`_ or `Docker Desktop for Windows <https://docs.docker.com/desktop/windows/install/>`_.
31
-
32
-
.. tip::
33
-
34
-
We always support Docker CE for the latest Ubuntu LTS. On Ubuntu 22.04, we are therefore supporting Docker 20.x, the version of the ``docker.io`` package.
35
-
36
-
The following will install Docker Community Edition maintained by a Ubuntu/Canonical team:
37
-
38
-
.. prompt:: bash
39
-
40
-
# Install the docker.io package
41
-
sudo apt install docker.io
42
-
# Add the current user to the Docker group. After this, you should log out and back in for the group membership to be effective.
43
-
sudo adduser $(whoami) docker
44
-
45
-
46
27
Set up your environment
47
28
-----------------------
48
29
@@ -85,7 +66,8 @@ Set up your environment
85
66
86
67
COMPOSE_PROJECT_NAME=community inv docker.up --init # --init is only needed the first time
87
68
88
-
#. Go to http://community.dev.readthedocs.io to access your local instance of Read the Docs. On newer versions of Firefox and Chrome, use a fresh Private/Incognito session.
69
+
#. Go to http://community.dev.readthedocs.io to access your local instance of Read the Docs.
70
+
Because HSTS is enabled on ``*.readthedocs.io`` and because some browsers have HTTPS-only modes enabled, you should potentially use a fresh private/incognito session.
89
71
90
72
Notice that two commands use the environment variable ``COMPOSE_PROJECT_NAME=community``. You might want to configure this globally. Running these commands without specifying ``COMPOSE_PROJECT_NAME`` currently `does not work <https://github.com/readthedocs/readthedocs.org/issues/9318>`_.
91
73
@@ -105,7 +87,8 @@ This manual step is intended to be made redundant.
105
87
Check that everything works
106
88
---------------------------
107
89
108
-
#. In a private/incognito session, visit http://community.dev.readthedocs.io
90
+
#. Visit http://community.dev.readthedocs.io
91
+
(if your browser automatically redirect to ``https://``, use a private/incognito session)
109
92
110
93
#. Login as ``admin`` / ``admin`` and verify that the project list appears.
0 commit comments