Teams/Keys-Team/Eintragen eines neuen Knotens mit Git Client

Auf dieser Seite erfährst du, wie du einen Freifunk-Key (fastd) mittels Git-Client in das Key-Repository einträgst. Das Gleiche kannst du auch über die Web-Oberfläche machen - wie erfährst du hier.

Grundlagen

• Github ist eine Plattform, auf der kostenlose Repositories für die Versionsverwaltungssoftware Git angeboten werden.
• Wir verwalten unsere Keys in Repositories auf Github (https://github.com/freifunk-mwu/peers-ffmz bzw. https://github.com/freifunk-mwu/peers-ffwi).
• Die Gateways ziehen sich die Keys aus den Repositories alle 15 Minuten.
• Wir tragen die Keys in die Repositories entweder über die Web-Oberfläche oder über einen Git-Client ein.
• Wir arbeiten auf dem Master direkt. Es sind keine Pull-Requests nötig.
• Jeder Key entspricht einer Datei, die dem Repository hinzugefügt werden muss.

Aufbau einer Key-Datei

• Als Dateinamen für einen Key im Repository nehmen wir den Namen des Knotens wie er uns übermittelt wird. Dieser muss eindeutig innerhalb des Repositorys sein.
• Der Inhalt der Datei muss so aufgebaut sein:

key "[DerKeySelbst]";

Schaue dir vor ersten Commit am besten eine andere Key-Datei mal als Beispiel an.

Voraussetzungen zum Eintragen mittels Git-Client

• Du hast einen Account auf github.com
• Dein Github-Account ist der Organisation "Freifunk MWU" zugeordnet (dazu bitte ans Admin-Team wenden)
• Dein Github-Account ist dem Keys-Team zugeordnet, so dass du auch die Berechtigung hast, das Repository zu verändern (ebenfalls ans Admin-Team oder an Florian wenden)
• Du hast lokal einen Git-Client installiert (und hast idealerweise auch schonmal ein Git-Tutorial angeschaut)

Vorgehen zum Eintragen

Repository lokal spiegeln mit "clone"

git clone https://github.com/freifunk-mwu/peers-ffmz

oder wenn Repo schon vorhanden die lokale Version erstmal aktualisieren mit dem letzten Stand aus dem Repo ("pull")

git pull

Dann in den Repository-Ordner auf der Festplatte bitte die neue Key-Datei einfügen (Datei neu erstellen und den eingesendeten Key als Dateiinhalt nehmen). In die Commit-Message bitte nur den Key bzw. Knotennahmen aufnehmen, keine weiteren Zusatzinfos (Datensparsamkeit!).

Nachdem du die neue Datei auf deinem Rechner hinzugefügt hast, musst du sie auch dem Repository hinzufügen ("add):

git add KnotenName4711

Danach musst du das Hinzufügen der neuen Datei persistieren ("commit"):

git commit KnotenName4711 -m "Add key KnotenName4711"

Zu guter Letzt musst du die neue Datei noch in den Master hoch spielen ("pushen"). Beim Pushen wirst du nach User+PW gefragt:

git push

Erst durch das Pushen wird die Datei tatsächlich wieder in den Master gespielt. Ab dann kann sie von den Gateways gezogen und verwendet werden. Sobald eine Datei hinzugefügt wird, läuft außerdem ein Prüfskript, das die hinzugefügte Datei auf Konsistenz prüft und ggf. eine Mecker-Mail versendet.

Weitere Infos

• Weitere Infos zum Arbeiten mit Github (z.B. wie du SSH statt https nutzt) findest du hier: https://help.github.com/articles/which-remote-url-should-i-use/