From db5adb47a0a20c385d4e5212baa2953ae908f3d7 Mon Sep 17 00:00:00 2001 From: Alarith Uhde Date: Wed, 12 Jun 2024 20:14:02 +0900 Subject: [PATCH] Fix manual instructions in README.md The manual install instructions assume some prior experience with nodejs and lack a few information. This commit adds the following: - clarify file paths (e.g., where is , where is com.tuxedocomputers.tccd.conf) - include the npm run build step that was missing and how to fix a possible error with it - include information how to start the dashboard after installing. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3aa25ea3..04040fd4 100644 --- a/README.md +++ b/README.md @@ -47,10 +47,12 @@ tuxedo-control-center 3. Install service file that points to development build path (or use installed service from packaged version) Manual instructions: - 1. Copy `tccd.service` and `tccd-sleep.service` (from src/dist-data) to `/etc/systemd/system/` - 2. Edit the `tccd.service` (exec start/stop) to point to `/dist/tuxedo-control-center/data/service/tccd`. - 3. Copy `com.tuxedocomputers.tccd.conf` to `/usr/share/dbus-1/system.d/` - 4. Start service `systemctl start tccd`. (And enable for autostart `systemctl enable tccd tccd-sleep`) + 1. Copy `tccd.service` and `tccd-sleep.service` (from `
/src/dist-data/`) to `/etc/systemd/system/` + 2. Execute `npm run build` in `
`. If you encounter the error `npm run build error:0308010C:digital envelope routines::unsupported` (e.g., on Debian 12), set `export NODE_OPTIONS=--openssl-legacy-provider` and try again (see [this issue](https://github.com/tuxedocomputers/tuxedo-control-center/issues/172)). + 3. Edit the `tccd.service` (exec start/stop) to point to `/dist/tuxedo-control-center/data/service/tccd`. By default, this path is `
/dist/tuxedo-control-center/data/service/src/dist-data/`. + 4. Copy `
/src/dist-data/com.tuxedocomputers.tccd.conf` to `/usr/share/dbus-1/system.d/` + 5. Start service `systemctl start tccd`. (And enable for autostart `systemctl enable tccd tccd-sleep`) + 6. If you had to set the `NODE_OPTIONS` in step 2, you have to `unset NODE_OPTIONS` again for the dashboard to work. After that, you can start the dashboard manually from the `
` with `npm run start` ### NPM scripts `npm run `