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