From f9f000b67ae23d67c7ec8b7afccc40cef468e49d Mon Sep 17 00:00:00 2001 From: Vadim Troshchinskiy Shmelev Date: Thu, 19 Oct 2023 14:56:17 +0200 Subject: [PATCH] Add documentation --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f67d5b --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# OG Browser + +El OpenGnsys Browser es un navegador limitado de tipo quiosco, basado en Qt6/Chrome. + +## Compilacion + +El sistema esta basado en CMake. Para compilar: + + + git clone https://ognproject.evlt.uma.es/gitea/unizar/ogbrowser.git + cd ogbrowser + mkdir build + cd build + cmake .. + make -j8 # 8 cores -- cambiar según hardware + + +## Uso + + src/OGBrowser URL + +Por ejemplo: + + src/OGBrowser http://example.com + + +## URLs especiales: + +El navegador reconoce URLs especiales dentro de los documentos, que pueden usarse +para ejecutar comandos locales. + +* command - Ejecuta un comando +* command+output - Ejecuta un comando y muestra la salida +* command+confirm - Pregunta antes de ejecutar un comando +* command+confirm+output - Pregunta antes de ejecutar un comando y muestra la salida +* command+output+confirm - Idéntico al anterior + + +Ejemplo: + + Ejecutar + +Esto crea un enlace que al hacerse click, ejecuta el comando ping y muestra el resultado en una ventana. + + +## Proxy + +Usa el proxy del sistema, incluyendo las variables de entorno: HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, NO_PROXY + +## Modo administrativo + +El administrador dispone de una consola y mas información sobre la ejecución de comandos. + +Se activa estableciendo la variable de entorno `ogactiveadmin=true` +