Skip to content

Commit 37b83c6

Browse files
committed
update docs again
1 parent ffc534b commit 37b83c6

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

docs/deployment/docker.rst

+19-14
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,37 @@ Rodhaj Docker images.
1414
Step 1 - Download required files
1515
================================
1616

17-
Create a directory (e.g. ``./rodhaj``), which will hold all of the required files.
17+
Download the necessary archive for getting started. This archive contains all
18+
of the files needed to get started. These are provided either in ``.zip`` or ``.tar.gz``
19+
formats.
1820

1921
.. code-block:: bash
2022
21-
mkdir ./rodhaj
22-
cd ./rodhaj
23+
wget https://github.com/transprogrammer/rodhaj/releases/latest/download/rodhaj-docker.tar.gz
2324
24-
Download ``docker-compose.yml``, ``config.yml``, and ``example.env`` using the following commands:
25+
# .zip version download
26+
wget https://github.com/transprogrammer/rodhaj/releases/latest/download/rodhaj-docker.zip
27+
28+
We need to unpack the archive in order to access the files. The following commands should do that.
2529

2630
.. code-block:: bash
2731
28-
wget -O docker-compose.yml https://github.com/transprogrammer/rodhaj/releases/latest/download/docker-compose.yml \
29-
&& wget -O config.yml https://github.com/transprogrammer/rodhaj/releases/latest/download/config-example.yml \
30-
&& wget -O .env https://github.com/transprogrammer/rodhaj/releases/latest/download/example.env
32+
tar -xvzf rodhaj-docker.tar.gz
3133
32-
.. note::
34+
# .zip version unpacking
35+
unzip rodhaj-docker.zip
3336
34-
Optionally, if you desired a full production version, then use the following commands to download
35-
``docker-compose.prod.yml``, ``example.env``, and ``prometheus.yml``:
37+
Once we have the files, we can now ``cd`` into the new extracted archive.
3638

37-
.. code-block:: bash
39+
.. code-block:: bash
40+
41+
cd rodhaj-docker
3842
39-
wget -O docker-compose.yml https://raw.githubusercontent.com/transprogrammer/rodhaj/main/docker/docker-compose.prod.yml \
40-
&& wget -O prometheus.yml https://raw.githubusercontent.com/transprogrammer/rodhaj/main/docker/prometheus.yml \
41-
&& wget -O .env https://github.com/transprogrammer/rodhaj/releases/latest/download/example.env
43+
.. important::
4244

45+
Throughout the rest of the guide, the next steps assume that
46+
you are in the ``rodhaj-docker`` directory.
47+
4348
Step 2 - Populate ``.env`` and ``config.yml`` file with values
4449
==============================================================
4550

0 commit comments

Comments
 (0)