mirror/phylum
1
0
Fork 0
mirror of https://codeberg.org/shroff/phylum.git synced 2026-01-05 19:21:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Abhishek Shroff
2025-05-30 19:19:29 +05:30
parent 4cac27fca3
commit 6467abd55a
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -40,13 +40,12 @@ In rough order, here are some things that are planned
## Deployment / Testing
The easiest way to get up and running is to use docker (or podman) compose go to `http://localhost:2448`.
The easiest way to get up and running is to use docker (or podman) compose and go to `http://localhost:2448`. You must add the first user via CLI using the `admin user invite` command. You may add others as well, or invite them directly from inside the app.
Configuration is read from `config.yml`, if it exists. Any config item can be overridden via environment variables and command-line flags, with '_' separating nested keys, and a`'PHYLUM_' prefix for env.
At the very least, you must specify `PHYLUM_DB_PASSWORD` in your `.env` file. See `example.env` for more options.
See `config.defaults.yml` to see a list of all configuration options, and `example.env` for some common overrides.
Configuration is read from `config.yml`, if it exists. See `config.defaults.yml` for a list of all configuration options.
You must add the first user using the CLI using the `admin user invite` command. You may add others as well, or invite them directly from inside the app.
## Development