# HG changeset patch # User Mads Kiilerich # Date 2020-06-19 18:24:38 # Node ID a63ccbc632d13d5642e43c66724565c538a9542f # Parent 8305790b95335ab13e37080eb94690f7298757b5 docs: add more section headings to setup description to show how it corresponds to the overview diff --git a/docs/overview.rst b/docs/overview.rst --- a/docs/overview.rst +++ b/docs/overview.rst @@ -30,13 +30,17 @@ installing Kallithea. 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.** +5. **Prepare front-end files** + Some front-end files must be fetched or created using ``npm`` tooling so + they can be served to the client as static files. + +6. **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.** +7. **Configure users.** The initial admin user can create additional local users, or configure how users can be created and authenticated from other user directories. diff --git a/docs/setup.rst b/docs/setup.rst --- a/docs/setup.rst +++ b/docs/setup.rst @@ -8,6 +8,11 @@ Setup 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 @@ settings, and logging. Extra settings ca 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 @@ path to the root). 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