diff --git a/README.md b/README.md index 1ebeef9baaf71e66105b1916b807907199781f2d..f4de3884bc1a08d2b00597d85b8165ca4727a2ac 100644 --- a/README.md +++ b/README.md @@ -7,29 +7,31 @@ Hinweis: diese Variante startet eine lokale Testversion der Website, es sind nic 1. Repo Clonen 2. Verzeichnis betreten 3. (optional) config.py.example anpassen und als config.py neu speichern -(Achtung: per default werden keine Beispieldaten initialisiert und auch kein useraccount -SQLITE_INIT_DATA sollte also wenigstens beim ersten Durchlauf True sein) -4. Schauen ob alle Dependencies erfüllt sind (siehe weiter unten) +4. Schauen, ob alle Dependencies erfüllt sind (siehe weiter unten) 5. `./run.py` ausführen -6. unter [http://localhost:5000](http://localhost:5000) ist die Website verfügbar +6. Unter [http://localhost:5000](http://localhost:5000) ist die Website verfügbar 7. Moderatorlogin mit user: `videoag` Passwort: `videoag` Alternativ, insbesondere zum Testen der Zugriffsbeschränkungen: Siehe `nginx.example.conf`. ### Zum Mitmachen: -1. Repo zum User clonen, dafür den "Clone-Button auf der Website verwenden -2. Weiter mit 'Zum Testen' -3. Änderungen machen -4. ins eigene Repo pushen -5. Pull-Request an uns, dazu unter "Merge-Requests" einmal auf "New Merge Request" und das Private Repo auswählen. +1. Repo für den eigenen User forken, dafür den "Fork-Button" auf der Website verwenden +2. Sicherstellen, dass der Upstream richtig konfiguriert ist: +[Link](https://help.github.com/articles/configuring-a-remote-for-a-fork/) +Origin stellt hier euren User da, Upstream das Original der Gruppe videoagwebsite +3. Erstellt euch eine eigene Branch, diese könnt ihr nennen wie ihr wollt, entweder nach der Änderung oder eurem Namen (git branch username), danach switched ihr in diese Branch (git checkout username) +3. Die Initialisierung ist unter "Zum Testen" bereits erklärt worden +3. Änderungen machen, committen, upstream mergen (git fetch upstream; git merge upstream/master) +4. Ins eigene Repo pushen (git push) +5. Pull-Request an uns, dazu unter "Merge-Requests" einmal auf "New Merge Request" und das Private Repo auswählen; oder ihr geht auf euer privates repo, da taucht dann eine Benachrichtigung über einen möglichen Merge-Request auf 6. Warten 7. Wir mergen die Änderungen ### Abhängigkeiten Notwendig: -* python3 -* flask +* python (Version 3) * sqlite +* python-flask * python-requests (wird vom L2P und vom Kalenderimport verwendet, kann nicht optional eingebunden werden) Optional (wird für einzelne Features benötigt): @@ -39,4 +41,4 @@ Optional (wird für einzelne Features benötigt): * python-mysql-connector (wenn MySQL als Datenbank verwendet werden soll) Kurzform unter Ubuntu: -sudo apt install python3 python3-pip sqlite python3-requests python3-lxml python-ldap python3-icalendar; pip3 install --upgrade pip; pip3 install Flask python-mysql-connector +sudo apt install python3 python3-flask sqlite python3-requests python3-lxml python3-ldap3 python3-icalendar python3-mysql.connector diff --git a/config.py.example b/config.py.example index ec3ed60e2b26732872b7ad8b49390442424e28d5..0cc9d4e518a4bfe9e338526992e522c340958bdf 100644 --- a/config.py.example +++ b/config.py.example @@ -1,5 +1,6 @@ # Defaults for development ,do not use in production! DEBUG = False +SERVER_IP = 'localhost' VIDEOPREFIX = 'https://videoag.fsmpi.rwth-aachen.de' VIDEOMOUNT = [{'mountpoint': 'files/protected/', 'prefix':'protected/'},{'mountpoint':'files/pub/','prefix':'pub/' }, {'mountpoint':'files/vpnonline/','prefix':'vpnonline/' }] #SECRET_KEY = 'something random' @@ -16,7 +17,7 @@ DB_DATA = 'db_example.sql' DB_ENGINE = 'sqlite' SQLITE_DB = 'db.sqlite' SQLITE_INIT_SCHEMA = True -SQLITE_INIT_DATA = False +SQLITE_INIT_DATA = True #LDAP_HOST = 'ldaps://rumo.fsmpi.rwth-aachen.de' #ICAL_URL = 'https://user:password@mail.fsmpi.rwth-aachen.de/SOGo/....ics' diff --git a/run.py b/run.py index 6c64338353d281eebed0fa5114d0d288807f4fbb..0a55cedff8789f9d055a05952cb023df8934fbc8 100755 --- a/run.py +++ b/run.py @@ -2,4 +2,4 @@ from server import * if __name__ == '__main__': - app.run(threaded=True) + app.run(threaded=True, host=config['SERVER_IP'])