onny/mail-quota-warning
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Jonas Heinrich 2025-03-12 14:45:05 +01:00
parent 5e842eed2f
commit c7592e9ff5
1 changed files with 31 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -1,9 +1,6 @@
# eintopf-radar-sync # eintopf-radar-sync
Small script to autologin to public wifis or test hotspots! Small script to sync events of an radar.quad.net group to a specific Eintopf
instance.
> Do not use this in production or against real public access points, since
> automatically logging in will violate most of the terms of use. The useage of
> this software is for development or research purpose only.
## Installation ## Installation
@ -14,7 +11,7 @@ Add the module to your `flake.nix`:
```nix ```nix
{ {
inputs = { inputs = {
iwd-autocaptiveauth.url = "git+https://git.project-insanity.org/onny/py-iwd-autocaptiveauth.git"; eintopf-radar-sync.url = "git+https://git.project-insanity.org/onny/eintopf-radar-sync.git";
[...] [...]
}; };
@ -24,12 +21,12 @@ Add the module to your `flake.nix`:
system = "x86_64-linux"; system = "x86_64-linux";
specialArgs.inputs = inputs; specialArgs.inputs = inputs;
modules = [ modules = [
inputs.iwd-autocaptiveauth.nixosModule inputs.eintopf-radar-sync.nixosModule
({ pkgs, ... }:{ ({ pkgs, ... }:{
nixpkgs.overlays = [ nixpkgs.overlays = [
inputs.iwd-autocaptiveauth.overlay inputs.eintopf-radar-sync.overlay
]; ];
}) })
@ -45,24 +42,33 @@ Add the module to your `flake.nix`:
Add this to your `configuration.nix` file Add this to your `configuration.nix` file
```nix ```nix
services.iwd-autocaptiveauth.enable = true; environment.etc."eintopf-radar-sync-secrets".text = ''
EINTOPF_AUTHORIZATION_TOKEN=foobar23
'';
services.eintopf-radar-sync = {
enable = true;
settings = {
EINTOPF_URL = "https://karlsunruh.eintopf.info";
RADAR_GROUP_ID = "436012";
};
secrets = [ /etc/eintopf-radar-sync-secrets ];
};
``` ```
Replace setting variables according to your setup.
Get the authorization token through login request in the Eintopf
Swagger api interface, for example
https://karlsunruh.project-insanity.org/api/v1/swagger#/auth/login
### From source ### From source
This script requires the program ```
[hyperpotamus](https://github.com/pmarkert/hyperpotamus) as a dependency. As cd eintopf-radar-sync
network manager, only nix develop
[iwd](https://git.kernel.org/pub/scm/network/wireless/iwd.git/) is supported. export EINTOPF_URL = "https://karlsunruh.eintopf.info"
Further you might need to install the Python modules ``python-dbus`` and export EINTOPF_AUTHORIZATION_TOKEN = "secret key"
``gobject``. export RADAR_GROUP_ID = "436012"
nix run
Just run ``python iwd-autocaptiveauth.py``. ```
## Configuration
The ``profiles`` directory contains small scripts which will perform the
http authentication process using ``hyperpotamus``. The filename should match
the ESSID of the wifi network.
Feel free to submit your profiles to this Gitlab repository!