Skip to content

Commit 8f7caa9

Browse files
committed
Remove Installing docker section, replace with requirements. Elaborate why privacy/incognito sessions may be needed
1 parent 056411e commit 8f7caa9

File tree

1 file changed

+6
-23
lines changed

1 file changed

+6
-23
lines changed

docs/dev/install.rst

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,15 @@ A development setup can be hosted by your laptop, in a VM, on a separate server
1515
* Is Unix-like system (Linux, BSD, Mac OSX) which **supports Docker**. Windows systems should have WSL+Docker or Docker Desktop.
1616
* 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.
1717
* 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).
1820

1921
.. note::
2022

2123
Take into account that this setup is intended for development purposes.
2224
We do not recommend to follow this guide to deploy an instance of Read the Docs for production.
2325

2426

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-
4627
Set up your environment
4728
-----------------------
4829

@@ -85,7 +66,8 @@ Set up your environment
8566

8667
COMPOSE_PROJECT_NAME=community inv docker.up --init # --init is only needed the first time
8768

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.
8971

9072
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>`_.
9173

@@ -105,7 +87,8 @@ This manual step is intended to be made redundant.
10587
Check that everything works
10688
---------------------------
10789

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)
10992

11093
#. Login as ``admin`` / ``admin`` and verify that the project list appears.
11194

0 commit comments

Comments
 (0)