diff docs/setup.rst @ 8576:a63ccbc632d1

docs: add more section headings to setup description to show how it corresponds to the overview
author Mads Kiilerich <mads@kiilerich.com>
date Fri, 19 Jun 2020 18:24:38 +0200
parents 850f096505ac
children 4742b8c89472
line wrap: on
line diff
--- a/docs/setup.rst	Fri Jun 19 13:42:31 2020 +0200
+++ b/docs/setup.rst	Fri Jun 19 18:24:38 2020 +0200
@@ -8,6 +8,11 @@
 Setting up Kallithea
 --------------------
 
+Some further details to the steps mentioned in the overview.
+
+Create low level configuration file
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 First, you will need to create a Kallithea configuration file. Run the
 following command to do so::
 
@@ -20,6 +25,9 @@
 
     kallithea-cli config-create my.ini host=8.8.8.8 "[handler_console]" formatter=color_formatter
 
+Populate the database
+^^^^^^^^^^^^^^^^^^^^^
+
 Next, you need to create the databases used by Kallithea. It is recommended to
 use PostgreSQL or SQLite (default). If you choose a database other than the
 default, ensure you properly adjust the database URL in your ``my.ini``
@@ -54,12 +62,18 @@
           but when trying to do a push it will fail with permission
           denied errors unless it has write access.
 
+Prepare front-end files
+^^^^^^^^^^^^^^^^^^^^^^^
+
 Finally, the front-end files must be prepared. This requires ``npm`` version 6
 or later, which needs ``node.js`` (version 12 or later). Prepare the front-end
 by running::
 
     kallithea-cli front-end-build
 
+Running
+^^^^^^^
+
 You are now ready to use Kallithea. To run it simply execute::
 
     gearbox serve -c my.ini