From 773af81ba27d060333589e8717f1256fa101fa2e Mon Sep 17 00:00:00 2001 From: David Huss <dh@atoav.com> Date: Tue, 5 Nov 2024 17:45:27 +0100 Subject: [PATCH] Add section about architecture to the README --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d3e0e82..8642200 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,16 @@ mediactl sports a touchscreen that allows control of the media technology in tha  -## service +## architecture + +There is a fastapi web service (`localhost:8000`) running behind an nginx reverse proxy that exposes it to the world. The service has a systemd unit file located at `/etc/systemd/system` (see section below). +The touchpanel is started with raspi-autologin and the `.xinit` file located in the `d0` user directory (see section below). The files of the running webservice are located at `/home/d0/mediactl` (see section below for hints if you want to edit those files). + +## autostart on RPI +See [this](https://blog.r0b.io/post/minimal-rpi-kiosk/) for a description of how to start chromium via `/home/d0/.xinit` – note: this file contains the screen blanking settings (`xset s 600 0` ) + + +## systemd service **Check Service Status** ```bash @@ -20,10 +29,6 @@ sudo systemctl restart mediactl.service -## autostart on RPI - -See [this](https://blog.r0b.io/post/minimal-rpi-kiosk/) for a description of how to start chromium via `/home/d0/.xinit` – note: this file contains the screen blanking settings (`xset 600 0` ) - ## note about apt In `/etc/apt/apt.conf.d/proxy.conf` there is a proxy connection setup: -- GitLab