update readme
This commit is contained in:
32
README.md
32
README.md
@@ -2,34 +2,22 @@
|
||||
|
||||
This flake aims to provide a nixosModule that handles running an [ep3-bs](https://bs.hbsys.de/) instance.
|
||||
|
||||
## What does it look like?
|
||||
## Usage
|
||||
|
||||
Here is a minimal configuration:
|
||||
``` nix
|
||||
{
|
||||
services.ep3-bs.enable = true;
|
||||
services.ep3-bs.mail.address = "test@test.de";
|
||||
services.ep3-bs = {
|
||||
enable = true;
|
||||
mail.address = "test@test.de";
|
||||
database.user = "testuser3";
|
||||
database.password = "testPassword1234"; #TODO: should be set as file
|
||||
in_production = false;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Now you can access ep3-bs using your browser. You will be guided through the database setup in the frontend. Afterwards you have to manually delete the ```setup.php```. This only has to be done once on the initial setup.
|
||||
Now you can access ep3-bs using your browser. You will be guided through the database setup in the frontend. When you are done set ```service.ep3-bs.in_production = true``` and rebuild your machine.
|
||||
|
||||
It can be done as root with:
|
||||
``` shell
|
||||
rm /var/lib/ep3-bs/public/setup.php
|
||||
```
|
||||
|
||||
If there is a better solution using nix, please let me know.
|
||||
|
||||
## Installation
|
||||
|
||||
### Using flakes
|
||||
|
||||
Add ep3-bs as input:
|
||||
``` nix
|
||||
{
|
||||
# ...
|
||||
inputs.ep3-bs.url = github:kalipso/ep3-bs.nix;
|
||||
}
|
||||
```
|
||||
If there is a better solution where you dont have to toggle the in_production variable, please let me know.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user