Mercurial > kallithea
changeset 8612:4d742b172010
docs: front-end-build is actually a part of the install process - it is shared among all the instances
| author | Mads Kiilerich <mads@kiilerich.com> |
|---|---|
| date | Thu, 13 Aug 2020 19:04:00 +0200 |
| parents | 933d25793167 |
| children | 0765771dbe5a |
| files | docs/installation.rst docs/overview.rst docs/setup.rst |
| diffstat | 3 files changed, 22 insertions(+), 17 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/installation.rst Sat Aug 01 22:20:16 2020 +0200 +++ b/docs/installation.rst Thu Aug 13 19:04:00 2020 +0200 @@ -59,7 +59,7 @@ pip install --upgrade -e . python3 setup.py compile_catalog # for translation of the UI -You can now proceed to :ref:`setup`. +You can now proceed to :ref:`install-front-end`. .. _installation-virtualenv: @@ -114,7 +114,7 @@ - This will install Kallithea together with all other required Python libraries into the activated virtualenv. -You can now proceed to :ref:`setup`. +You can now proceed to :ref:`install-front-end`. .. _installation-without-virtualenv: @@ -133,4 +133,18 @@ pip install --user kallithea +You can now proceed to :ref:`install-front-end`. + +.. _install-front-end: + + +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 + You can now proceed to :ref:`setup`.
--- a/docs/overview.rst Sat Aug 01 22:20:16 2020 +0200 +++ b/docs/overview.rst Thu Aug 13 19:04:00 2020 +0200 @@ -20,20 +20,20 @@ 2. **Install Kallithea software.** This makes the ``kallithea-cli`` command line tool available. -3. **Create low level configuration file.** +3. **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. + +4. **Create low level configuration file.** Use ``kallithea-cli config-create`` to create a ``.ini`` file with database connection info, mail server information, configuration for the specified web server, etc. -4. **Populate the database.** +5. **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. **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
--- a/docs/setup.rst Sat Aug 01 22:20:16 2020 +0200 +++ b/docs/setup.rst Thu Aug 13 19:04:00 2020 +0200 @@ -93,15 +93,6 @@ sudo -u postgres createdb 'kallithea' --owner 'kallithea' kallithea-cli db-create -c my.ini --reuse -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 ^^^^^^^