From 804657c55bca747a006e5a22cb0ac1e8fed60a90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn-Michael=20Miehe?= <40151420+ldericher@users.noreply.github.com> Date: Fri, 17 Nov 2023 08:51:52 +0100 Subject: [PATCH] fixed some TODOs and regressions in READMEs --- README.md | 4 ++-- api/README.md | 20 ++++++++++---------- api/pyproject.toml | 3 +++ ui/README.md | 14 +++++++------- 4 files changed, 22 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index bb5c0bd..684483a 100644 --- a/README.md +++ b/README.md @@ -79,12 +79,12 @@ This can all be done after logging into your prepared device: > > - DietPi might ask: "Would you like DietPi to apply the recommended GPU memory split?". Choose **Yes**. > - DietPi will ask: "Would you like to configure the DietPi-AutoStart option?". **Cancel** that, this choice does not matter as it is changed by the installer. -> - DietPi will ask: "Would you like to join DietPi-Survey?". It's up to you, but I'd suggest to **opt OUT**. +> - DietPi will ask: "Would you like to join DietPi-Survey?". You should decide for yourself if you want telemetry or not, but I suggest to **opt OUT**. > - The installer will ask for the connected screen's resolution. The default values should be fine, you can likely just hit **Return** here. > - The installer will ask for "display languages". This will affect some details on the connected screen.
For German, enter `de-DE,de,en-US,en`. > - The installer will ask you to "review the Docker Compose file" before starting the services. You will want to edit `WEBDAV__HOST`, `WEBDAV__USERNAME` and `WEBDAV__PASSWORD` at least.
- Refer to [the "Settings"](TODO) for the full list of options. + Refer to [the "Settings"](#settings-on-your-device-opt-ovdashboard-docker-compose-yml) for the full list of options. Afterwards, reboot your device (`reboot` in the terminal). diff --git a/api/README.md b/api/README.md index 303f4ea..600b3ed 100644 --- a/api/README.md +++ b/api/README.md @@ -5,7 +5,7 @@ This API enables the OVDashboard UI to run. ## Quick Start -If you only want a working installation, it is highly recommended to use the `docker` image at [`TODO`](TODO). +If you only want a working installation, it is highly recommended to use the `docker` image on [`code.yavook.de`](https://code.yavook.de/OEKZident.de/-/packages/container/ovdashboard). The image contains both the API and UI. Refer to the [main README](../README.md) for an in-depth how-to. @@ -17,7 +17,7 @@ You only need a "general purpose" development setup to get this project up and r - [Docker Engine](https://docs.docker.com/engine/install/) - [Visual Studio Code](https://code.visualstudio.com/) -- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (VSCode extension) +- [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (VSCode extension) Once you open this directory in VSCode, you should be prompted to reopen it in a development container. If not, hit `Ctrl+Alt+P` and search for "reopen in container". @@ -28,14 +28,14 @@ If not, hit `Ctrl+Alt+P` and search for "reopen in container". > You probably don't need this! Usually the image is good enough! However, if you want to deploy the API on a cluster or with custom ASGI workers and/or process managers, go ahead. -First, install the `ovdashboard_api` python package. +First, [install the `ovdashboard_api` python package](#installing-the-ovdashboard_api-python-package). Then you can: -- use `uvicorn` or another ASGI runner to start the app object `ovdashboard_api:app`
-Example: `uvicorn 'ovdashboard_api:app'` +- use `uvicorn` or another ASGI runner to start the app object `ovdashboard_api.app:app`
+Example: `uvicorn 'ovdashboard_api.app:app'` - run the provided `ovdashboard-api` script – this is basically a shorthand for `uvicorn` - use `gunicorn` or another application server with ASGI workers
-Example (ASGI workers provided by `uvicorn`): `gunicorn 'ovdashboard_api:app' --worker-class 'uvicorn.workers.UvicornWorker'` +Example (ASGI workers provided by `uvicorn`): `gunicorn 'ovdashboard_api.app:app' --worker-class 'uvicorn.workers.UvicornWorker'` ## Configuration @@ -48,16 +48,16 @@ Refer to the [main README](../README.md) for the list of variables. If `git` is installed, install `ovdashboard_api` directly using this command: - python3 -m pip install 'git+https://TODO#egg=ovdashboard_api&subdirectory=api' + python3 -m pip install 'git+https://code.yavook.de/OEKZident.de/ovdashboard.git#egg=ovdashboard_api&subdirectory=api' -If installing `git` is not an option, just [download and extract this repository's archive](TODO), then use your local path instead of the `git+https://` URL for `pip install`. +If installing `git` is not an option, just [download and extract this repository's archive](https://code.yavook.de/OEKZident.de/ovdashboard/archive/master.zip), then use `python3 -m pip install `. ## Installation Dependencies Refer to your distribution's manual for how to install these dependencies: -- Python 3.9 with pip
-If `python3 --version` shows "Python 3.9" or later, and `python3 -m pip` does execute, your setup is working. +- Python 3.12 with pip
+If `python3 --version` shows "Python 3.12" or later, and `python3 -m pip` does execute, your setup is working. - git (recommended) - libmagic diff --git a/api/pyproject.toml b/api/pyproject.toml index f18ce19..06ca523 100644 --- a/api/pyproject.toml +++ b/api/pyproject.toml @@ -28,6 +28,9 @@ flake8-isort = "^6.1.0" types-cachetools = "^5.3.0.6" pytest = "^7.4.3" +[tool.poetry.scripts] +ovdashboard-api = "ovdashboard_api.main:main" + [build-system] build-backend = "poetry.core.masonry.api" requires = ["poetry-core>=1.0.0"] diff --git a/ui/README.md b/ui/README.md index dc96245..5bbe3b3 100644 --- a/ui/README.md +++ b/ui/README.md @@ -3,7 +3,7 @@ ## Quick Start -If you only want a working installation, it is highly recommended to use the `docker` image at [`TODO`](TODO). +If you only want a working installation, it is highly recommended to use the `docker` image on [`code.yavook.de`](https://code.yavook.de/OEKZident.de/-/packages/container/ovdashboard). The image contains both the API and UI. Refer to the [main README](../README.md) for an in-depth how-to. @@ -15,7 +15,7 @@ You only need a "general purpose" development setup to get this project up and r - [Docker Engine](https://docs.docker.com/engine/install/) - [Visual Studio Code](https://code.visualstudio.com/) -- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (VSCode extension) +- [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (VSCode extension) Once you open this directory in VSCode, you should be prompted to reopen it in a development container. If not, hit `Ctrl+Alt+P` and search for "reopen in container". @@ -26,16 +26,16 @@ If not, hit `Ctrl+Alt+P` and search for "reopen in container". > You probably don't need this! Usually the image is good enough! However, if you want to deploy the UI on a cluster or any custom web server, go ahead. -First, run `yarn build` in this directory - I'd recommend you use VSCode with a development container as described above. -Alternatively, you can copy the `/html` directory from the `docker` image: +First, run `yarn build` in this directory - You will probably want to use VSCode with the development container as described above. +Alternatively, you can copy the `/usr/local/share/ovdashboard_ui/html` directory from the `docker` image: ```sh -id=$(docker create TODO) -docker cp "${id}:/html" "/path/to/dist" +id=$(docker create code.yavook.de/oekzident.de/ovdashboard:) +docker cp "${id}:/usr/local/share/ovdashboard_ui/html" "" docker rm -v "${id}" ``` -Then you can deploy the `dist` directory as the webroot using your favourite web server. +Then you can deploy the `` directory as the webroot using your favourite web server. ## Configuration