Skip to content

Commit

Permalink
[#293] include documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SonnyBA committed Nov 29, 2024
1 parent dcadd08 commit d9d1007
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,11 @@ Provide the envvars via the process manager

If you use a process manager (such as supervisor/systemd), use their techniques
to define the envvars. The component will pick them up out of the box.


Initial configuration
=====================

Open Klant supports the ``setup_configuration`` management command, which allows
configuration via yaml files. Further details using this command can be read at
:ref:`installation_configuration_cli`.
1 change: 1 addition & 0 deletions docs/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ this.

config
migration
setup_configuration
66 changes: 66 additions & 0 deletions docs/installation/setup_configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
.. _installation_configuration_cli:

==============================
Open Klant configuration (CLI)
==============================

After deploying Open Klant, it needs to be configured to be fully functional.
You can get the full command documentation with:

.. code-block:: bash
$ src/manage.py setup_configuration --help
.. warning:: This command is declarative - if configuration is manually changed after
running the command and you then run the exact same command again, the manual
changes will be reverted.

Preparation
===========

The command executes the list of pluggable configuration steps, and each step
has required specific variables, that should be prepared.
Here is the description of all available configuration steps and the variables,
used by each step.

Token configuration
----------------------

Create a YAML configuration file with your settings:

.. code-block:: yaml
tokens_config_enable: true
tokens_config:
group:
- identifier: token-1
contact_person: Person 1
email: [email protected]
organization: Organization XYZ # optional
application: Application XYZ # optional
administration: Administration XYZ # optional
- identifier: token-2
contact_person: Person 2
email: [email protected]
.. note:: Invalid entries will be skipped and logged according to the configured
logging settings.

Execution
=========

Open Klant configuration
------------------------

With the full command invocation, everything is configured at once. Each configuration step
is idempotent, so any manual changes made via the admin interface will be updated if the command
is run afterwards.

.. code-block:: bash
$ src/manage.py setup_configuration
.. note:: Due to a cache-bug in the underlying framework, you need to restart all
replicas for part of this change to take effect everywhere.

0 comments on commit d9d1007

Please sign in to comment.