kalipso/ep3-bs.nix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
kalipso
2024-01-26 15:00:18 +01:00
parent 083b2062e6
commit a2678c9b39
1 changed files with 10 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -2,34 +2,22 @@
This flake aims to provide a nixosModule that handles running an [ep3-bs](https://bs.hbsys.de/) instance. 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: Here is a minimal configuration:
``` nix ``` nix
{ {
services.ep3-bs.enable = true; services.ep3-bs = {
services.ep3-bs.mail.address = "test@test.de"; 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: If there is a better solution where you dont have to toggle the in_production variable, please let me know.
``` 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;
}
```