OEKZident.de/ovdashboard
2
0
Fork 0
Code Releases 1 Packages Activity

fixed some TODOs and regressions in READMEs

Browse source
This commit is contained in:
Jörn-Michael Miehe 2023-11-17 08:51:52 +01:00
parent 44c2ebcb43
commit 804657c55b
4 changed files with 22 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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 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 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 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. <br /> > - The installer will ask for "display languages". This will affect some details on the connected screen. <br />
For German, enter `de-DE,de,en-US,en`. 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. <br /> > - 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. <br />
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). Afterwards, reboot your device (`reboot` in the terminal).

20
api/README.md
View file

@ -5,7 +5,7 @@ This API enables the OVDashboard UI to run.
## Quick Start ## 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. The image contains both the API and UI.
Refer to the [main README](../README.md) for an in-depth how-to. 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/) - [Docker Engine](https://docs.docker.com/engine/install/)
- [Visual Studio Code](https://code.visualstudio.com/) - [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. 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". 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! > 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. 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: Then you can:
- use `uvicorn` or another ASGI runner to start the app object `ovdashboard_api:app` <br /> - use `uvicorn` or another ASGI runner to start the app object `ovdashboard_api.app:app` <br />
Example: `uvicorn 'ovdashboard_api:app'` Example: `uvicorn 'ovdashboard_api.app:app'`
- run the provided `ovdashboard-api` script &ndash; this is basically a shorthand for `uvicorn` - run the provided `ovdashboard-api` script &ndash; this is basically a shorthand for `uvicorn`
- use `gunicorn` or another application server with ASGI workers <br /> - use `gunicorn` or another application server with ASGI workers <br />
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 ## 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: 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 <LOCAL_PATH>`.
## Installation Dependencies ## Installation Dependencies
Refer to your distribution's manual for how to install these dependencies: Refer to your distribution's manual for how to install these dependencies:
- Python 3.9 with pip <br /> - Python 3.12 with pip <br />
If `python3 --version` shows "Python 3.9" or later, and `python3 -m pip` does execute, your setup is working. If `python3 --version` shows "Python 3.12" or later, and `python3 -m pip` does execute, your setup is working.
- git (recommended) - git (recommended)
- libmagic - libmagic

3
api/pyproject.toml
View file

@ -28,6 +28,9 @@ flake8-isort = "^6.1.0"
types-cachetools = "^5.3.0.6" types-cachetools = "^5.3.0.6"
pytest = "^7.4.3" pytest = "^7.4.3"
[tool.poetry.scripts]
ovdashboard-api = "ovdashboard_api.main:main"
[build-system] [build-system]
build-backend = "poetry.core.masonry.api" build-backend = "poetry.core.masonry.api"
requires = ["poetry-core>=1.0.0"] requires = ["poetry-core>=1.0.0"]

14
ui/README.md
View file

@ -3,7 +3,7 @@
## Quick Start ## 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. The image contains both the API and UI.
Refer to the [main README](../README.md) for an in-depth how-to. 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/) - [Docker Engine](https://docs.docker.com/engine/install/)
- [Visual Studio Code](https://code.visualstudio.com/) - [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. 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". 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! > 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. 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. 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 `/html` directory from the `docker` image: Alternatively, you can copy the `/usr/local/share/ovdashboard_ui/html` directory from the `docker` image:
```sh ```sh
id=$(docker create TODO) id=$(docker create code.yavook.de/oekzident.de/ovdashboard:<IMAGE_TAG>)
docker cp "${id}:/html" "/path/to/dist" docker cp "${id}:/usr/local/share/ovdashboard_ui/html" "<LOCAL_PATH>"
docker rm -v "${id}" docker rm -v "${id}"
``` ```
Then you can deploy the `dist` directory as the webroot using your favourite web server. Then you can deploy the `<LOCAL_PATH>` directory as the webroot using your favourite web server.
## Configuration ## Configuration