changeset 8427:d59cb6068e55 stable

docs: clarify the installation steps and how things fit together Hint that create-db user information is for creating the initial local user and that the database connection (which also might use some kind of user) is something else.
author Mads Kiilerich <mads@kiilerich.com>
date Fri, 15 May 2020 18:50:59 +0200
parents 16389bb32f39
children 6eb1f66ac23f
files docs/overview.rst
diffstat 1 files changed, 36 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/overview.rst	Sun May 10 20:50:46 2020 +0200
+++ b/docs/overview.rst	Fri May 15 18:50:59 2020 +0200
@@ -7,6 +7,42 @@
 Some overview and some details that can help understanding the options when
 installing Kallithea.
 
+1. **Prepare environment and external dependencies.**
+    Kallithea needs:
+
+    * A filesystem where the Mercurial and Git repositories can be stored.
+    * A database where meta data can be stored.
+    * A Python environment where the Kallithea application and its dependencies
+      can be installed.
+    * A web server that can host the Kallithea web application using the WSGI
+      API.
+
+2. **Install Kallithea software.**
+    This makes the ``kallithea-cli`` command line tool available.
+
+3. **Create low level configuration file.**
+    Use ``kallithea-cli config-create`` to create a ``.ini`` file with database
+    connection info, mail server information, some web server configuration,
+    etc.
+
+4. **Populate the database.**
+    Use ``kallithea-cli db-create`` with the ``.ini`` file to create the
+    database schema and insert the most basic information: the location of the
+    repository store and an initial local admin user.
+
+5. **Configure the web server.**
+    The web server must invoke the WSGI entrypoint for the Kallithea software
+    using the ``.ini`` file (and thus the database). This makes the web
+    application available so the local admin user can log in and tweak the
+    configuration further.
+
+6. **Configure users.**
+    The initial admin user can create additional local users, or configure how
+    users can be created and authenticated from other user directories.
+
+See the subsequent sections, the separate OS-specific instructions, and
+:ref:`setup` for details on these steps.
+
 
 Python environment
 ------------------