Skip to content

Commit

Permalink
doc: missing fields in account
Browse files Browse the repository at this point in the history
  • Loading branch information
rejetto committed Jan 13, 2025
1 parent a7416d3 commit cfc3127
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
5 changes: 5 additions & 0 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit cfc3127

Please sign in to comment.