Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
AlekSIS-Core
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AlekSIS®
Official
AlekSIS-Core
Commits
7063e58b
Verified
Commit
7063e58b
authored
5 years ago
by
Nik | Klampfradler
Browse files
Options
Downloads
Patches
Plain Diff
[Docs] Add general explanation of configuration files.
parent
3a82c30d
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Pipeline
#228
failed
5 years ago
Stage: build
Stage: deploy
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/admin/01_config.rst
+53
-0
53 additions, 0 deletions
docs/admin/01_config.rst
docs/admin/02_ldap.rst
+0
-0
0 additions, 0 deletions
docs/admin/02_ldap.rst
docs/admin/03_psql.rst
+0
-0
0 additions, 0 deletions
docs/admin/03_psql.rst
with
53 additions
and
0 deletions
docs/admin/01_config.rst
0 → 100644
+
53
−
0
View file @
7063e58b
Configuration files and format
==============================
File locations and order
------------------------
BiscuIT is configured through text files in the directory `/etc/biscuit/`.
You can place any file types there that are supported by the `Dynaconf`_
configuration system (INI, YAML and TOML).
Files are evaluated in alphabetical order, with later definitions
overwriting earlier ones. Normally, there will be only one configuration
file, but you can make up any structure you like. If you use multiple
files, it might be a good idea to number them, e.g. `00_main.toml`,
`01_myschool.toml`, `99_temporary.toml`.
The TOML format is recommended and is the only format described in detail in
BiscuIT's documentation. For all other formats, refer to the `Dynaconf`_
documentation.
Configuration file format (TOML)
--------------------------------
TOML file are simple text files that define variables, much like in Python
(i.e. there are scalars, lists and dictionaries). BiscuIT structures its
configuration by topic.
A configuration file might look like this::
[default]
secret_key = "VerySecretKeyForSessionSecurity"
[default.http]
allowed_hosts = [ "biscuit.myschool.example.com", "localhost" ]
[default.database]
name = "biscuit"
user = "biscuit"
password = "SuperSecretPassword"
[default.caching]
memcached = { enabled = true, address = "127.0.0.1" }
The `secret_key` setting above defines a single value. The following `http`
section defines a table (cf. a dictionary) in one way, and you can see the
second form of such a table in the `memcached` setting (we could as well
have defined another section called `[default.caching.memcached]` and placed
`enabled` and `address` below it as scalars).
This can be a bit confusing, so this documentation will explain how to
configure BiscuIT on a per-feature basis.
.. _Dynaconf: https://dynaconf.readthedocs.io/en/latest/
This diff is collapsed.
Click to expand it.
docs/admin/0
1
_ldap.rst
→
docs/admin/0
2
_ldap.rst
+
0
−
0
View file @
7063e58b
File moved
This diff is collapsed.
Click to expand it.
docs/admin/0
2
_psql.rst
→
docs/admin/0
3
_psql.rst
+
0
−
0
View file @
7063e58b
File moved
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment