README overhaul
This commit is contained in:
parent
6b1fda1ffe
commit
afbd9f4db8
1 changed files with 24 additions and 19 deletions
43
README.md
43
README.md
|
@ -54,7 +54,7 @@ It is also heavily advisable that you log into your device using SSH, so you sho
|
||||||
|
|
||||||
### Install Base System
|
### Install Base System
|
||||||
|
|
||||||
`OVDashboard` is designed to run on a `DietPi` installation. Full installation documentation is available [at dietpi.com](https://dietpi.com/docs/deploy/). To quickly get up and running:
|
OVDashboard is designed to run on a `DietPi` installation. Full installation documentation is available [at dietpi.com](https://dietpi.com/docs/deploy/). To quickly get up and running:
|
||||||
|
|
||||||
1. Download Image from [dietpi.com/#download](https://dietpi.com/#download)
|
1. Download Image from [dietpi.com/#download](https://dietpi.com/#download)
|
||||||
1. Uncompress Image and flash onto SD card – you might need "7zip", "balenaEtcher" and/or other tools
|
1. Uncompress Image and flash onto SD card – you might need "7zip", "balenaEtcher" and/or other tools
|
||||||
|
@ -83,19 +83,32 @@ This can all be done after logging into your prepared device:
|
||||||
> - 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 />
|
||||||
|
Refer to [the "Settings"](TODO) for the full list of options.
|
||||||
|
|
||||||
Afterwards, reboot your device (`reboot` in the terminal). Your OVDashboard should be working now.
|
Afterwards, reboot your device (`reboot` in the terminal).
|
||||||
|
|
||||||
|
If the install was successful, your OVDashboard should be showing up on the connected screen after rebooting.
|
||||||
|
|
||||||
|
> You will also be able to view your OVDashboard on any webbrowser in your network using `http://<device-ip>`. <br />
|
||||||
|
> The device IP is displayed in the lower right region of the OVDashboard.
|
||||||
|
|
||||||
For a better understanding of your newly created OVDashboard, refer to the [about section](#about-the-default-ovdashboard-deployment).
|
For a better understanding of your newly created OVDashboard, refer to the [about section](#about-the-default-ovdashboard-deployment).
|
||||||
|
|
||||||
## Updates, upgrades
|
|
||||||
|
|
||||||
<!-- TODO `/opt/ovdashboard` -->
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
### "Config" in your WebDAV share: `config.txt`
|
||||||
|
|
||||||
<!-- TODO -->
|
<!-- TODO -->
|
||||||
|
|
||||||
|
### "Settings" on your Device: `/opt/ovdashboard/docker-compose.yml`
|
||||||
|
|
||||||
|
<!-- TODO -->
|
||||||
|
|
||||||
|
## Updating your Device
|
||||||
|
|
||||||
|
<!-- TODO `/opt/ovdashboard` -->
|
||||||
|
|
||||||
## Setup for development and contribution
|
## Setup for development and contribution
|
||||||
|
|
||||||
Refer to the specific README files for [the API](./api/README.md) and [the UI](./ui/README.md) to contribute to one of those sub-projects.
|
Refer to the specific README files for [the API](./api/README.md) and [the UI](./ui/README.md) to contribute to one of those sub-projects.
|
||||||
|
@ -103,17 +116,9 @@ Refer to the specific README files for [the API](./api/README.md) and [the UI](.
|
||||||
|
|
||||||
## About the "default" OVDashboard deployment
|
## About the "default" OVDashboard deployment
|
||||||
|
|
||||||
The default deployment is made up of three parts: The **installer** runs once, prepares your device for OVDashboard usage and deploys the **server**.
|
Running the installer script carries out the following actions:
|
||||||
|
|
||||||
The **server** will then run continuously and make OVDashboard available as a web application in your network.
|
- install Chromium-Browser, Docker and Docker Compose
|
||||||
|
- create the OVDashboard project at `/opt/ovdashboard`
|
||||||
Also, a browser is installed to display the OVDashboard using your device.
|
- start the OVDashboard project, this deploys the `ovdashboard` service from [`code.yavook.de`](https://code.yavook.de/OEKZident.de/-/packages/container/ovdashboard) and a [`redis` instance](https://redis.io/) to your device
|
||||||
|
- set up your device to auto-boot into Chromium "kiosk" mode to display the local OVDashboard
|
||||||
|
|
||||||
### The OVDashboard installer will:
|
|
||||||
|
|
||||||
- install and set up Docker, Docker Compose and Chromium-Browser
|
|
||||||
- create the OVDashboard Compose project at `/opt/ovdashboard`
|
|
||||||
- get a `docker` image from [`code.yavook.de`](https://code.yavook.de/OEKZident.de/-/packages/container/ovdashboard) containing the OVDashboard server
|
|
||||||
- set up your device to auto-run Chromium in "kiosk" mode to display the local OVDashboard
|
|
||||||
- auto-hide your mouse cursor
|
|
||||||
|
|
Loading…
Reference in a new issue