commit a1c775aaa139bb42a2ec7e08a7e0e0c601fb05ef Author: www Date: Mon Apr 20 05:11:05 2020 +0000 Init First Documetation diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..015181a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +templates +.theia \ No newline at end of file diff --git a/Documentation-binders.jpg b/Documentation-binders.jpg new file mode 100644 index 0000000..ef8def4 Binary files /dev/null and b/Documentation-binders.jpg differ diff --git a/FETDjango/index.md b/FETDjango/index.md new file mode 100644 index 0000000..166a345 --- /dev/null +++ b/FETDjango/index.md @@ -0,0 +1,4 @@ +title: 2. FET Django fixes +template: page_plain.html + +$subpages$ \ No newline at end of file diff --git a/HowToStart/.gitignore b/HowToStart/.gitignore new file mode 100644 index 0000000..f10e14a --- /dev/null +++ b/HowToStart/.gitignore @@ -0,0 +1 @@ +templates \ No newline at end of file diff --git a/HowToStart/1_1_setup_new_environment.md b/HowToStart/1_1_setup_new_environment.md new file mode 100644 index 0000000..53f5c83 --- /dev/null +++ b/HowToStart/1_1_setup_new_environment.md @@ -0,0 +1,53 @@ +title: 1.1. Neue Entwicklungsumgebung einrichten +template: page_plain.html + +$subpagestab$ +Für diesen Schritt sind su Rechte notwendig. Wenn du noch keine hast, frag jemanden das für dich zu erledigen. + +## 1. Neuen Ordner anlegen + + :::bash + # Unterordner im Ordner /srv erstellen + cd /srv + mkdir test_1 + # Benutzer www als Owner! + chown www test_1 + +## 2. Einen permanenten Test Port zuordnen + +Dieser Schritt kann auch übersprungen werden und kurzfristig 8001 bis 8003 verwendet werden. + + :::bash + # für alle die nicht emacs nutzen gerne auch vim + # wer weder emacs noch vim kennt hat vermutlich keine sudo Rechte + emacs /etc/nginx/sites-available/tests + +Nginx Konfiguration +Für *name* einen freien subdomain namen verwenden. und für *Port* einen freien Port. Am besten +1 zu dem letzten vorhandenen. + + :::nginx + server { + listen 80; + server_name .2020.fet.at; + root /srv/static; + location / { + proxy_ssl_server_name on; + proxy_ssl_verify off; + + proxy_pass http://127.0.0.1:; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header REMOTE-USER $http_REMOTE_USER; + proxy_set_header Connection "upgrade"; + + } + } + +Konfiguration testen und NGinx neu starten + + :::bash + nginx -t + systemctl reload nginx + +## Dokumentation anlegen +Auf [diese Seite gehen](https://dev.2020.fet.at/#/srv/fet2020_doc) und die [Dokumentation](https://doc.2020.fet.at/) ergänzen. diff --git a/HowToStart/1_2_first_steps.md b/HowToStart/1_2_first_steps.md new file mode 100644 index 0000000..cac3a15 --- /dev/null +++ b/HowToStart/1_2_first_steps.md @@ -0,0 +1,18 @@ +title: 1.2 Erste Schritte in der neuen Umgebung + +## Öffnen der Entwicklungsumgebung + +unter dem Link https://dev.2020.fet.at/#/srv/<projektordner> findest du die Entwicklungsumgebung + +![Terminal Button in IDE](../screenshots/Screenshot_GetStarted_1.png) + +## Erstellen einer virutell PIP Umgebung +![Terminal öffnen](../screenshots/GetStarted_2.png) + +Aktivieren einer viruellen Python3 Umgebung. + + :::bash + www@fetsite:/srv/test_1$ python3 -m venv .env + www@fetsite:/srv/test_1$ activate + (.env) www@fetsite:/srv/test_1$ +Ab jetzt sollte die Zeile im Terminal beginnen mit (.env). \ No newline at end of file diff --git a/HowToStart/1_3_helloworld_flask.md b/HowToStart/1_3_helloworld_flask.md new file mode 100644 index 0000000..6ae2ab3 --- /dev/null +++ b/HowToStart/1_3_helloworld_flask.md @@ -0,0 +1,47 @@ +title: 1.3 Hello World mit Flask +Erstelle eine kleine Python Datei, zB test.py mit dem Inhalt: + + :::python + from flask import Flask + app = Flask(__name__) + + @app.route('/') + def hello_world(): + return 'Hello, World!' + +Starte den Development Server mit + + :::bash + FLASK_APP=test.py flask run --host=0.0.0.0 --port=8104 +Ändere den Port und den Dateinamen entsprechend. +Damit das jeweilige Startcommando nicht jedesmal eingetippt werden muss, empfehle ich eine run Datei zu erstellen: + +run + + :::bash + #!/bin/bash + . .env/bin/activate # Die Pythonumgebung laden + # + # Starten des flask Development Sers + # Die App muss in einer Datei sein, + # host 0.0.0.0 bedeutet, dass der Developmentserver auch von anderen erreicht werden kann. + # Default wäre dass der Server am Entwickulungsrechner lokal betrieben wird + # Port bitte auf den jeweiligen Wert ändren + FLASK_APP=test.py flask run --host=0.0.0.0 --port=8104 + +jetzt ein Terminal öffnen und die Datei lauffähig machen + + :::bash + chmod +x run # Ausführen erlauben + ./run # Ausführen + + +Im Terminal sollte jetzt etwa folgende Ausgabe erscheinen + + :::bash + * Serving Flask app "test.py" + * Environment: production + WARNING: This is a development server. Do not use it in a production deployment. + Use a production WSGI server instead. + * Debug mode: off + * Running on http://0.0.0.0:8104/ (Press CTRL+C to quit) diff --git a/HowToStart/1_4_start_git.md b/HowToStart/1_4_start_git.md new file mode 100644 index 0000000..bc9fb85 --- /dev/null +++ b/HowToStart/1_4_start_git.md @@ -0,0 +1 @@ +title: Git aktivieren diff --git a/HowToStart/django_fet_login.md b/HowToStart/django_fet_login.md new file mode 100644 index 0000000..1b258f1 --- /dev/null +++ b/HowToStart/django_fet_login.md @@ -0,0 +1,33 @@ +title: Django Fet Login + +Django kommt mit einem Administrationsinterface und einem Usermanagement. +Die Anleitung hier ist dazu gedacht den LDAP Login zu übernehmen und automatisch in Django einzuloggen. + +middleware.py + + :::python + from django.contrib.auth.models import User + from django.contrib.auth.middleware import RemoteUserMiddleware + import django + + class FETHeaderMiddleware(RemoteUserMiddleware): + header="Remote-User" + def process_request(self, request): + #Http Header auch nutzen: + request.META[self.header]=request.META.get(self.header, request.headers.get(self.header,None)) + super().process_request(request) + # Alle eingeloggten User zum Superuser machen + if request.user.is_authenticated: + request.user.is_admin=True + request.user.is_superuser=True + request.user.is_staff=True + + + +In setting.py + + :::python + MIDDLEWARE = [ ... + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'test1.middleware.FETHeaderMiddleware', + ...] diff --git a/HowToStart/index.md b/HowToStart/index.md new file mode 100644 index 0000000..2dfb3c7 --- /dev/null +++ b/HowToStart/index.md @@ -0,0 +1,4 @@ +title: 1. How To Start +template: page_plain.html + +$subpagestab$ \ No newline at end of file diff --git a/HowToStart/screenshots/GetStarted_2.png b/HowToStart/screenshots/GetStarted_2.png new file mode 100644 index 0000000..44159cf Binary files /dev/null and b/HowToStart/screenshots/GetStarted_2.png differ diff --git a/HowToStart/screenshots/Screenshot_GetStarted_1.png b/HowToStart/screenshots/Screenshot_GetStarted_1.png new file mode 100644 index 0000000..74c08cd Binary files /dev/null and b/HowToStart/screenshots/Screenshot_GetStarted_1.png differ diff --git a/HowToStart/test.jpg b/HowToStart/test.jpg new file mode 100644 index 0000000..e69de29 diff --git a/HowToStart/test.md b/HowToStart/test.md new file mode 100644 index 0000000..8eeeaf2 --- /dev/null +++ b/HowToStart/test.md @@ -0,0 +1,25 @@ + + +sdf + + :::python + def asdf(): + pass + + +--- + :::python + def asdf(): + pass + + + :::bash + Das ist ein Code +https://drive.google.com/file/d/1gPZB0YV4iP31u1OBe7IoFqDfRyCPvGQl/view?usp=sharing + UML + + + + + +link \ No newline at end of file diff --git a/Server/index.md b/Server/index.md new file mode 100644 index 0000000..8b719f4 --- /dev/null +++ b/Server/index.md @@ -0,0 +1,10 @@ + + + +My wrapping Text + + +$subpages$ + + +Hello \ No newline at end of file diff --git a/Server/nginx.md b/Server/nginx.md new file mode 100644 index 0000000..5714d66 --- /dev/null +++ b/Server/nginx.md @@ -0,0 +1,3 @@ +title: Nginx Einstellungen + +## Nginx Remote User diff --git a/index.md b/index.md new file mode 100644 index 0000000..5048c9a --- /dev/null +++ b/index.md @@ -0,0 +1,47 @@ +title: Doku für 2020 Projekt +title2: Das ist der Beginn der Doku für dieses Projekt +template: title.html +image: Documentation-binders.jpg + +## Entwicklungsumgebungen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UserDevTest link
andisEntwicklung: Django Versuch von Andi DevPort 8101
andis Design Test Foundation design1.2020.fet.at - DevPort 8102
moses Test1 von Moses DevPort 8103
andis Entwicklung: Test 1 um das Tutorial zu testen und Hello World in Flask umzusetzen DevPort 8104
+ +$hello$ +## Bereiche +$subfolders$ + +## Über diese App + +[Link zum Bearbeiten dieser Doku](https://dev.2020.fet.at/#/srv/fet2020_doc) + +[Link zu Entwicklungsumgebung für die app](https://dev.2020.fet.at/#/srv/fet2020_doc_app) \ No newline at end of file diff --git a/tg/index.md b/tg/index.md new file mode 100644 index 0000000..3220446 --- /dev/null +++ b/tg/index.md @@ -0,0 +1 @@ +title: 3. ttt \ No newline at end of file