From cfc3127694ebb8f499ba861d445862686c715db7 Mon Sep 17 00:00:00 2001 From: Massimo Melina Date: Mon, 13 Jan 2025 12:41:27 +0100 Subject: [PATCH] doc: missing fields in account --- config.md | 5 +++++ dev.md | 6 +++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/config.md b/config.md index ad773db34..d2992c607 100644 --- a/config.md +++ b/config.md @@ -208,6 +208,11 @@ For each account entries, this is the list of properties you can have: - `redirect` provide a URL if you want the user to be redirected upon login. Default is none. - `admin` set `true` if you want to let this account log in to the Admin-panel. Default is `false`. - `belongs` an array of usernames of other accounts from which to inherit their permissions. Default is none. +- `srp` encrypted password +- `password` a temporary unencrypted password, transformed into `srp` ASAP +- `disabled` prevents using this account. Default is false. +- `expire` account won't work once the time has passed this timestamp. Use JSON timestamp syntax. Default is none. +- `days_to_live` used to set `expire` on first login. Default is none. - `disable_password_change` set `true` if you want to forbid password change for users. Default is `false`. - `allow_net` a mask of addresses to restrict the access of the account diff --git a/dev.md b/dev.md index 622a698c0..b509d453a 100644 --- a/dev.md +++ b/dev.md @@ -38,8 +38,8 @@ Alternatively you can run a development server, just be sure to load config from The project is roughly divided in Server + Frontend + Admin, where Frontend is a web interface intended to access shared files, while Admin is the web interface for configuration/administration. -Server lies in the root of the project, with its "src" folder, while Frontend and Admin are inside folders "frontend" -and "admin" respectively, with their "src" folder within. +Server resides in the project's root, with its "src" folder, while Frontend and Admin are inside folders "frontend" +and "admin" respectively, each with its own "src" folder within. Additionally, you have the following folders: - mui-grid-form: a lib used by Admin to easily build forms @@ -53,7 +53,7 @@ Additionally, you have the following folders: # Guidelines - For strings, I'm using double-quotes for text that's read by the user, and single-quotes elsewhere. Backticks can be any. -- All objects that go in yaml should use snake_case. +- All keys that go in yaml should use snake_case. - Reason: we want something that is both easy for the user and maps directly in our code. Spaces and kebab-case don't play well with javascript and camel is less readable for the user. - API names should start with get_ if and only if they provide information without making changes.