34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# lapp
|
|
|
|
list app
|
|
|
|
install
|
|
1. clone repo
|
|
2. create subfolder "instance" to store database file
|
|
3. for an initial instance: run python3 initialze_data.py, with the python from the virtual-env
|
|
4. add the below config to your apache2 enabled site
|
|
|
|
## Secrets and configuration
|
|
|
|
LAPP stores its private configuration in `instance/secrets.yaml`. On first
|
|
startup, missing values are generated automatically and the file permissions are
|
|
set to `0600`.
|
|
|
|
The file contains the Flask session key, API application key, database URI,
|
|
initial account credentials, initial group secrets, and the Fernet key used by
|
|
`test.py`. To change the database, edit `runtime.database_uri` in this file.
|
|
|
|
Keep `runtime.secret_key` stable: changing it logs users out and invalidates
|
|
existing auto-login cookies. `runtime.application_key` is used by
|
|
`/api/validate_key`.
|
|
|
|
The entire `instance/` directory is ignored by Git. Back up `secrets.yaml`
|
|
securely and never commit or share it.
|
|
|
|
## Initial data secrets
|
|
|
|
`initialize_data.py` creates initial users and groups only when the database has
|
|
no users yet. Set the values under `initial_data` in `instance/secrets.yaml`
|
|
before running it, or use the securely generated defaults. The script prints the
|
|
location of the credentials when it creates the initial data.
|