54 lines
3.0 KiB
ReStructuredText
54 lines
3.0 KiB
ReStructuredText
FSR Generator
|
|
=============
|
|
|
|
Diese Sammlung an Skripten kann die meisten Dinge die man so für einen FSR braucht erzeugen.
|
|
|
|
Konfiguration
|
|
-------------
|
|
|
|
Die Hauptkonfigurationsdatei ist `generator.conf`. In diesem Git-Repo liegt eine `generator.conf` die mit den Werten für den FSR vorausgefüllt ist, idealerweise müsst ihr daran nichts ändern. Einige Dinge sind aber von Person zu Person unterschiedlich, dafür gibt es die `personal.conf`. Hier liegt eine `personal.conf.example` im Repo, die solltet ihr nach `personal.conf` kopieren und anpassen (vmtl. nur `email_redeleitung`, für weitere Optionen siehe Fortgeschrittene Nutzung).
|
|
|
|
Ausserdem müsst ihr, falls ihr das Skript nicht auf einem FS-Rechner ausführt, SSH so konfiguriert haben dass bei Verbindungen nach `fsmi-login.fsmi.uni-karlsruhe.de` der richtige Nutzername verwendet wird (`.ssh/config`). Ausserdem bietet sich die Nutzung von SSH-Keys an da mehrere Verbindungen aufgebaut werden und man nicht jedes mal ein Passwort eingeben will.
|
|
|
|
Ausserdem müsst ihr auf der Website ein Passwort für postgres `gesetzt <https://www.fsmi.uni-karlsruhe.de/Fachschaft/Personen/ExtraPasswoerter.html>`_ haben und die entsprechenden Rechte auf der Datenbank haben (sollten alle haben, sonst Mail an rechner@).
|
|
|
|
Die mitgelieferten Konfigurationsdateien sind darauf ausgelegt auf FS-Rechnern ohne nicht hier beschriebene Konfiguration zu funktionieren.
|
|
|
|
Nutzung
|
|
-------
|
|
|
|
Zuerst solltet ihr die TOP-Mails für den aktuellen FSR raussuchen. Diese speichert ihr als mbox in `data/fsr_tops.mbox` ab. (Wie das geht hängt vom verwendeten E-Mailprogramm ab)
|
|
|
|
Beim Generieren der Präsentation solltest du ausserdem noch die unbeantworteten Mails in `data/ubemails.txt` und die Termine in `data/termine.txt` schreiben.
|
|
|
|
Jetzt kann man, je nachdem was man machen will, `./invite` zum Einladung verschicken (Achtung: verschickt ohne weitere Nachfrage die Einladungsmail), `./presentation` zum Präsentation generieren oder `./protocol` zum Protokollvorlage generieren ausführen.
|
|
|
|
Fortgeschrittene Nutzung
|
|
------------------------
|
|
|
|
E-Mails automatisch aus Maildir lesen
|
|
+++++++++++++++++++++++++++++++++++++
|
|
|
|
TODO
|
|
|
|
Einladung nicht automatisch versenden
|
|
+++++++++++++++++++++++++++++++++++++
|
|
|
|
Wenn du in deiner `personal.conf` die Option `inviteseq` auf `invite_mbox_nosend` setzt versendet `./invite` die Einladung nicht automatisch sondern gibt sie auf dem Terminal aus, von wo du sie in dein E-M̀ailprogramm kopieren kannst.
|
|
|
|
Es gibt auch die Möglichkeit die Einladung in eine mbox-Datei zu schreiben die dein E-Mailprogramm öffen kann, dazu muss man in der `generator.conf` in der `sequencer`-Konfiguration die Option `--write-mbox` an `generate` anfügen, die Datei wird dann an den in `mbox_out` angegebenen Pfand geschrieben.
|
|
|
|
Termine aus FS-Kalender lesen
|
|
+++++++++++++++++++++++++++++
|
|
|
|
Voraussetzung: `khal <https://github.com/pimutils/khal>`_
|
|
|
|
TODO
|
|
|
|
Override-File
|
|
+++++++++++++
|
|
|
|
Es ist möglich einzelne Optionen der `generator.conf` in einer separaten Datei zu überschreiben.
|
|
|
|
TODO
|