init commit

kiszolgalo/OLVASSEL.md

@@ -0,0 +1,36 @@
+# Szerver v1.0
+## Fordítás
+JDK 21-re van szükség a fordításhoz (ha csak a JAR file-ra van szükség, akkor nem kell külön leszedni, elvileg működik a 25-ös Java-val is. Ha nem működne, érdemes erre ránézni.) Ennek beállítása:
+- [Windows](https://www.happycoders.eu/java/how-to-switch-multiple-java-versions-windows/)
+- [Debian](https://computingforgeeks.com/how-to-set-default-java-version-on-ubuntu-debian/)
+## TCP
+A TCP szerver nyit a megadott porton, 127.0.0.1-en (helyben) egy konnektort, ahova írni lehet és ahonnan olvasni lehet.
+
+### Metódusok:
+- `+GETPREV` - lekéri a legutóbbi elküldött üzenetét
+- `+GET` - lekéri a legutóbb "uMOGI-nak írt" üzenetet
+
+## HTTP
+A HTTP szerver a megadott porton nyílik meg.
+### Metódusok:
+- `/` - kiszolgálja az üzenetező felületet HTML-ben
+- `/uMogi` - visszaadja az uMogi legutolsó üzenetét
+- `/web` - visszaadja a weboldalra beírt utolsó üzenetet
+- `/uMogiWrite` - az uMogi használhatná írásra (nem lett használva végül)
+- `/webWrite` - a weboldal ezzel ír az uMogira
+- `/mogi` - szó szerint csak visszaadja a MOGI logo-t
+
+## Futtatás
+A futtatáshoz a `kiszolgalo-all.jar` állományt kell futtatni JAVA segítségével, az alábbi paranccsal:
+`java -jar kiszolgalo-all.jar`
+
+Amennyiben a megfelelő kicsomagolt ZIP file-ban futtatjuk a programot nem kell állítani semmit a környezeti változókon.
+
+### Környezeti változók:
+| ENV       | Desc                                                                                                        | Default                                                             |
+|-----------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
+| HTTP_PORT | HTTP szerver portja                                                                                         | 8080                                                                |
+| TCP_PORT  | TCP szerver portja                                                                                          | 9000                                                                |
+| LOCAL_IP  | TCP szerver helyi IP-je (http-vel szemben itt nem elég a loopback cím használata, kell a  gép konkrét címe) | A gép IP-je ha támogatja a lekérést, egyébként fallback localhost-ra|
+| INDEX     | Az `index.html` file elérési útvonala                                                                       | ./resources/index.html                                              |
+| MOGI      | Az `mogi.png` file elérési útvonala                                                                         | ./resources/mogi.png                                                |