-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
75 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,3 +16,4 @@ this. | |
|
||
config | ||
migration | ||
setup_configuration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |