brmlab/hackerbase
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document the configuration file.

Browse source
This commit is contained in:
Dominik Pantůček 2023-04-11 23:06:59 +02:00
parent eb83a3845a
commit 2cb84d1847
1 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

24
doc/formats.md
View file

@ -1,8 +1,8 @@
Members Base
File Formats
============
This file documents the internal structure of the members information
storage.
This file documents the internal structure of various file formats
used.
Members Directory
-----------------
@ -15,10 +15,11 @@ Symlinks to the member files serve as human-readable aliases.
The implementation handles situation when the human-readable name is
the member file and the symlink is the four-digit member id.
Member File Parsing - Passes 0 and 1
------------------------------------
Key File Parsing - Passes 0 and 1
---------------------------------
Member files are read line-by-line.
All files are read line-by-line. This applies to both member file and
configuration file.
### Pass 0
@ -112,8 +113,13 @@ If any of Mandatory keys is missing, it is filled with
* phone
Member File Schema
------------------
Configuration File Parsing - Pass 2
-----------------------------------
nick - single word - alphabetical characters, underscore, dash, numbers
Basic passes 0 and 1 are performed and then only the following keys
are used to set initial values for runtime parameters:
* members-directory
* apikeys-file
* jendasap-checked
* bank-dir