docs: improve service guide and clarity
All checks were successful
CI / test (push) Successful in 1m35s
CI / test (pull_request) Successful in 1m41s

Restructure README, add admonitions, fix log command,
and refine script comments and safety notes.
This commit is contained in:
2026-04-20 02:56:21 -05:00
parent 3fe256ce29
commit bd008ebf91

View File

@@ -1,8 +1,16 @@
## Basic init yt-local for openrc # Basic init yt-local for openrc
1. Write `/etc/init.d/ytlocal` file. ## Prerequisites
``` - System with OpenRC installed and configured.
- Administrative privileges (doas or sudo).
- `ytlocal` script located at `/usr/sbin/ytlocal` and application files in an accessible directory.
## Service Installation
1. **Create the OpenRC service script** `/etc/init.d/ytlocal`:
```sh
#!/sbin/openrc-run #!/sbin/openrc-run
# Distributed under the terms of the GNU General Public License v3 or later # Distributed under the terms of the GNU General Public License v3 or later
name="yt-local" name="yt-local"
@@ -41,36 +49,60 @@ stop() {
} }
``` ```
after, modified execute permissions: > [!NOTE]
> Ensure the script is executable:
>
> ```sh
> doas chmod a+x /etc/init.d/ytlocal
> ```
$ doas chmod a+x /etc/init.d/ytlocal 2. **Create the executable script** `/usr/sbin/ytlocal`:
```bash
2. Write `/usr/sbin/ytlocal` and configure path.
```
#!/usr/bin/env bash #!/usr/bin/env bash
cd /home/your-path/ytlocal/ # change me # Change the working directory according to your installation path
# Example: if installed in /usr/local/ytlocal, use:
cd /home/your-path/ytlocal/ # <-- MODIFY TO YOUR PATH
source venv/bin/activate source venv/bin/activate
python server.py > /dev/null 2>&1 & python server.py > /dev/null 2>&1 &
echo $! > /var/run/ytlocal.pid echo $! > /var/run/ytlocal.pid
``` ```
after, modified execute permissions: > [!WARNING]
> Run this script only as root or via `doas`, as it writes to `/var/run` and uses network privileges.
$ doas chmod a+x /usr/sbin/ytlocal > [!TIP]
> To store the PID in a different location, adjust the `pidfile` variable in the service script.
> [!IMPORTANT]
> Verify that the virtual environment (`venv`) is correctly set up and that `python` points to the appropriate version.
3. OpenRC check > [!CAUTION]
> Do not stop the process manually; use OpenRC commands (`rc-service ytlocal stop`) to avoid race conditions.
- status: `doas rc-service ytlocal status` > [!NOTE]
- start: `doas rc-service ytlocal start` > When run with administrative privileges, the configuration is saved in `/root/.yt-local`, which is rootonly.
- restart: `doas rc-service ytlocal restart`
- stop: `doas rc-service ytlocal stop`
- enable: `doas rc-update add ytlocal default` ## Service Management
- disable: `doas rc-update del ytlocal`
When yt-local is run with administrator privileges, - **Status**: `doas rc-service ytlocal status`
the configuration file is stored in /root/.yt-local - **Start**: `doas rc-service ytlocal start`
- **Restart**: `doas rc-service ytlocal restart`
- **Stop**: `doas rc-service ytlocal stop`
- **Enable at boot**: `doas rc-update add ytlocal default`
- **Disable**: `doas rc-update del ytlocal`
## PostInstallation Verification
- Confirm the process is running: `doas rc-service ytlocal status`
- Inspect logs for issues: `doas tail -f /var/log/ytlocal.log` (if logging is configured).
## Troubleshooting Common Issues
- **Service fails to start**: verify script permissions, correct `command=` path, and that the virtualenv exists.
- **Port conflict**: adjust the servers port configuration before launching.
- **Import errors**: ensure all dependencies are installed in the virtual environment.
[!IMPORTANT]
Keep the service script updated when modifying startup logic or adding new dependencies.