Entwicklungsumgebung einrichten: Unterschied zwischen den Versionen
Abschnitt "Betriebssystem vorbeiten"
(Abschnitt "git" vervollständigt) |
(Abschnitt "Betriebssystem vorbeiten") |
||
| Zeile 1: | Zeile 1: | ||
Das Einrichten der Testumgebung erfolgt in mehreren Schritten, die im folgenden beschrieben sind. Falls es dabei zu unerwarteten Fehlermeldungen kommt, bitte die letzten Schritte noch einmal genau anschauen und gegebenenfalls wiederholen. Auch ein Blick ins Fehlerhandbuch hilft meistens, da bereits viele Fallstricke entdeckt und beschrieben wurden. | Das Einrichten der Testumgebung erfolgt in mehreren Schritten, die im folgenden beschrieben sind. Falls es dabei zu unerwarteten Fehlermeldungen kommt, bitte die letzten Schritte noch einmal genau anschauen und gegebenenfalls wiederholen. Auch ein Blick ins Fehlerhandbuch hilft meistens, da bereits viele Fallstricke entdeckt und beschrieben wurden. | ||
== Das Betriebssystem vorbereiten, entweder Linux oder Windows == | == 1. Das Betriebssystem vorbereiten, entweder Linux oder Windows == | ||
.. | === Windows 10 === | ||
==== Programme installieren ==== | |||
Unter Windows ist es standardmäßig nicht möglich, “einfach“ die Linux Distribution Ubuntu zu installieren. Dazu muss vorab erst das WSL2 aktiviert / installiert werden werden (Punkt 1). Im Anschluss ist eine Installation von Ubuntu (18.04 oder 20.04 oder höher) möglich. Zudem muss Docker installiert werden, in dem dann die Entwicklungsumgebung laufen kann (Punkt 2). | |||
# WSL2 unter Windows10 aktivieren und Ubuntu 20.04 installieren: | |||
## Aus dem Microsoft-Store: https://aka.ms/wslstorepage (verfügbar seit Nov. 2022) | |||
## Manuell unter [https://learn.microsoft.com/de-de/windows/wsl/install#manual-installation-steps|Installieren von WSL] | |||
# Docker für Windows installieren: [https://docs.docker.com/docker-for-windows/install/|Install Docker Desktop on Windows] | |||
# Unter Windows muss in der Hosts-Datei (%windir%\system32\drivers\etc) folgende Eintragung gemacht werden: | |||
<nowiki>127.0.0.1 docker.team-opencaching.de | |||
127.0.0.1 try.docker.team-opencaching.de</nowiki> | |||
== Sourcecode von Git laden == | Danach kann Ubuntu gestartet werden (z.B. im “Such“-Menü nach Ubuntu suchen und anklicken). Beim erstmaligen Starten von Ubuntu müssen ein Benutzername und ein Passwort festgelegt werden. | ||
Im Anschluss den Punkten folgen und ausführen, die im nächsten Schritt “Linux” beschrieben werden. | |||
=== Linux === | |||
Der Linuxartikel wurde erstellt auf Lubuntu 18.04, aktualisiert mit 22.04 und erweitert mit Debian 12 | |||
==== Programme installieren ==== | |||
Folgende Programme sind notwendig und müssen vorab installiert werden: | |||
PHP (aktuell mind. PHP7.4, später PHP8), diverse PHP-Erweiterungen, docker-compose, mariadb-client. Für die PHP-Erweiterungen ist eventuell ein zusätzliches PPA-Repository notwendig. Dessen Installation erfordert je nach Betriebssystem ein unterschiedliches Vorgehen. | |||
<nowiki>Ubuntu: | |||
sudo apt install software-properties-common | |||
sudo add-apt-repository ppa:ondrej/php | |||
Debian: | |||
sudo apt install software-properties-common ca-certificates lsb-release apt-transport-https | |||
curl -sSL https://packages.sury.org/php/README.txt | sudo bash -x</nowiki> | |||
Die Pakete lassen sich mit folgenden Befehlen installieren (Versionsnummer kann abweichen). | |||
<nowiki>sudo apt update | |||
sudo apt install php8 php8.0-mbstring php8.0-curl php8.0-xml php8.0-mysql | |||
sudo apt install docker-compose | |||
sudo apt install mariadb-client</nowiki> | |||
Sollten beim Installieren der Pakete Fehlermeldungen auftreten, ist es empfehlenswert, die Pakete einzeln zu installieren und auftretende Fehler/Abhängigkeiten einzeln zu lösen. | |||
==== Nutzer in docker-Gruppe aufnehmen ==== | |||
Der aktuelle Benutzer muss in die Gruppe “docker” aufgenommen werden, sonst kann es passieren, dass dieser keinen Zugriff auf die Dockercontainer bekommt. | |||
<nowiki>sudo usermod -aG docker $(id -un)</nowiki> | |||
Die Änderung wird aber erst nach einem Ab-/Anmelden des Nutzers wirksam. Überprüft werden kann dies danach mittels | |||
<nowiki>id</nowiki> | |||
Hier muss die “docker”-Gruppe aufgelistet sein. Beispiel: | |||
<nowiki>uid=1000(user) gid=1000(user) groups=1000(user),4(adm),24(cdrom),..,128(docker)</nowiki> | |||
==== Eigenschaften der Docker Socket-Datei prüfen ==== | |||
Den folgenden Befehl ausführen, um die Eigenschaften der Datei anzeigen zu lassen: | |||
<nowiki>sudo ls -la /var/run/docker.sock</nowiki> | |||
Die Datei muss dabei ‘docker’ zugewiesen sein: | |||
<nowiki>rw-rw---- 1 root docker 0 Dec 21 19:16 /var/run/docker.sock</nowiki> | |||
Ist dies nicht der Fall, muss die Zugehörigkeit geändert werden: | |||
<nowiki>chgrp docker /var/run/docker.sock</nowiki> | |||
== 2. Sourcecode von Git laden == | |||
=== Github === | === Github === | ||
Zwar ist zum Herunterlden des Sourcecodes keine Account auf GitHub notwendig, aber zum Hochladen wird einer benötigt. Daher sollte zuerst einen Account auf https://github.com/ angelegt werden. | Zwar ist zum Herunterlden des Sourcecodes keine Account auf GitHub notwendig, aber zum Hochladen wird einer benötigt. Daher sollte zuerst einen Account auf https://github.com/ angelegt werden. | ||
| Zeile 51: | Zeile 111: | ||
== Docker Entwicklungsumgebung initalisieren == | == 3. Docker Entwicklungsumgebung initalisieren == | ||
=== Entwicklungsumgebung zum ersten Mal starten === | === Entwicklungsumgebung zum ersten Mal starten === | ||
(siehe auch: Github: [https://github.com/OpencachingDeutschland/oc-server3#starting-the-docker-development-environment|starting the docker environment]) | (siehe auch: Github: [https://github.com/OpencachingDeutschland/oc-server3#starting-the-docker-development-environment|starting the docker environment]) | ||
| Zeile 102: | Zeile 162: | ||
<nowiki>./psh.phar docker:stop</nowiki> | <nowiki>./psh.phar docker:stop</nowiki> | ||
== Die Testdatenbank füllen == | == 4. Die Testdatenbank füllen == | ||
Während der Installation wird eine Testdatenbank importiert, die bereits eine kleine Menge an Caches und Nutzern beinhaltet. Ein manueller Import des Datenbankdumps ist somit (seit März 2021) nicht mehr notwendig. | Während der Installation wird eine Testdatenbank importiert, die bereits eine kleine Menge an Caches und Nutzern beinhaltet. Ein manueller Import des Datenbankdumps ist somit (seit März 2021) nicht mehr notwendig. | ||
| Zeile 165: | Zeile 225: | ||
== Die Entwicklungsumgebung vorbereiten == | == 5. Die Entwicklungsumgebung vorbereiten == | ||
Gegebenenfalls sind an der Programmierumgebung Änderungen vorzunehmen, um zum Beispiel [[OC Coding Style|einheitlich formatierten Code]] zu schreiben. | Gegebenenfalls sind an der Programmierumgebung Änderungen vorzunehmen, um zum Beispiel [[OC Coding Style|einheitlich formatierten Code]] zu schreiben. | ||
| Zeile 190: | Zeile 250: | ||
== Das Fehlerhandbuch lesen (gilt insbesondere für die Schritte #1-#4 :wink:) == | == 6. Das Fehlerhandbuch lesen (gilt insbesondere für die Schritte #1-#4 :wink:) == | ||
.. neue Unterseite.. | .. neue Unterseite.. | ||