Changeset - a63ccbc632d1
[Not reviewed]
default
0 2 0
Mads Kiilerich (mads) - 6 years ago 2020-06-19 18:24:38
mads@kiilerich.com
Grafted from: 2c91f4333667
docs: add more section headings to setup description to show how it corresponds to the overview
2 files changed with 20 insertions and 2 deletions:
0 comments (0 inline, 0 general)
docs/overview.rst
Show inline comments
 
@@ -27,19 +27,23 @@ installing Kallithea.
 

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

	
 
See the subsequent sections, the separate OS-specific instructions, and
 
:ref:`setup` for details on these steps.
 

	
docs/setup.rst
Show inline comments
 
@@ -5,24 +5,32 @@ 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::
 

	
 
    kallithea-cli config-create my.ini
 

	
 
This will create the file ``my.ini`` in the current directory. This
 
configuration file contains the various settings for Kallithea, e.g.
 
proxy port, email settings, usage of static files, cache, Celery
 
settings, and logging. Extra settings can be specified like::
 

	
 
    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``
 
configuration file to use this other database. Kallithea currently supports
 
PostgreSQL, SQLite and MariaDB/MySQL databases. Create the database by running
 
the following command::
 
@@ -51,18 +59,24 @@ path to the root).
 
.. note:: the given path for Mercurial_ repositories **must** be write
 
          accessible for the application. It's very important since
 
          the Kallithea web interface will work without write access,
 
          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
 

	
 
- This command runs the Kallithea server. The web app should be available at
 
  http://127.0.0.1:5000. The IP address and port is configurable via the
0 comments (0 inline, 0 general)