aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md40
1 files changed, 23 insertions, 17 deletions
diff --git a/readme.md b/readme.md
index c38542f..6e06cfb 100644
--- a/readme.md
+++ b/readme.md
@@ -1,14 +1,16 @@
# trein?
+[english readme](readme_en.md)
+
domme python scripts voor openbaar vervoer in nederland in je agenda
-`storingen` is een script die je met fcgiwrap en nginx kunt draaien op een
+`storingen.py` is een script die je met fcgiwrap en nginx kunt draaien op een
server om een ical bestand te genereren die je laat weten wanneer de ns weer
eens niet rijdt
-`autoplanner` neemt een icalendar bestand in (met bijvoorbeeld een rooster), en
-vraagt voor elke dag een reisadvies op om bij de vroegste afspraak op tijd te
-zijn
+`autoplanner.py` neemt een icalendar bestand in (met bijvoorbeeld een rooster),
+en vraagt voor elke dag een reisadvies op om bij de vroegste afspraak op tijd
+te zijn
## setup
@@ -20,18 +22,6 @@ lekker veilig opgeslagen in een plain-text bestand `storingen.key`.
trajectnamen staan op losse regels in `storingen.cfg`, een voorbeeld hiervan
staat in deze repository.
-hier is een voorbeeld nginx configuratie (snippet die in een server block kan):
-
-```nginx
-location /ical/trein.ics {
- gzip off;
- autoindex on;
- fastcgi_pass unix:/var/run/fcgiwrap.socket;
- include /etc/nginx/fastcgi_params;
- fastcgi_param SCRIPT_FILENAME /var/trein/storingen.fcgi;
-}
-```
-
### autoplanner
deze gebruikt de openbare reisplanner om reisadvies op te vragen. omdat deze
@@ -41,9 +31,25 @@ ooit stoppen met werken.
dit script verwacht een bestand `autoplanner.json`, die gebaseerd is op
`autoplanner.def.json`, en leest een icalendar agenda vanaf stdin.
-voorbeeldaanroep:
+voorbeeldaanroep (aanpassen in `autoplanner.fcgi` voor server gebruik):
```bash
./autoplanner.py < rooster.ics
+# of
+curl https://rooster.site/rooster.ics | ./autoplanner.py
+```
+
+### nginx
+
+hier is een voorbeeld nginx configuratie (snippet die in een server block kan):
+
+```nginx
+location /ical/trein.ics {
+ gzip off;
+ autoindex on;
+ fastcgi_pass unix:/var/run/fcgiwrap.socket;
+ include /etc/nginx/fastcgi_params;
+ fastcgi_param SCRIPT_FILENAME /var/trein/storingen.fcgi;
+}
```