docs: improve service guide and clarity

Restructure README, add admonitions, fix log command,
and refine script comments and safety notes.

docs/basic-script-openrc/README.md

@@ -1,76 +1,108 @@
-## 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.
-#!/sbin/openrc-run
+- Administrative privileges (doas or sudo).
-# Distributed under the terms of the GNU General Public License v3 or later
+- `ytlocal` script located at `/usr/sbin/ytlocal` and application files in an accessible directory.
-name="yt-local"
-pidfile="/var/run/ytlocal.pid"
-command="/usr/sbin/ytlocal"
 
-depend() {
+## Service Installation
-    use net
-}
 
-start_pre() {
+1. **Create the OpenRC service script** `/etc/init.d/ytlocal`:
-    if [ ! -f /usr/sbin/ytlocal ] ; then
-        eerror "Please create script file of ytlocal in '/usr/sbin/ytlocal'"
-        return 1
-    else
-        return 0
-    fi
-}
 
-start() {
+   ```sh
-    ebegin "Starting yt-local"
+   #!/sbin/openrc-run
-    start-stop-daemon --start --exec "${command}" --pidfile "${pidfile}"
+   # Distributed under the terms of the GNU General Public License v3 or later
-    eend $?
+   name="yt-local"
-}
+   pidfile="/var/run/ytlocal.pid"
+   command="/usr/sbin/ytlocal"
 
-reload() {
+   depend() {
-    ebegin "Reloading ${name}"
+       use net
-    start-stop-daemon --signal HUP --pidfile "${pidfile}"
+   }
-    eend $?
-}
 
-stop() {
+   start_pre() {
-   ebegin "Stopping ${name}"
+       if [ ! -f /usr/sbin/ytlocal ]; then
-   start-stop-daemon --quiet --stop --exec "${command}" --pidfile "${pidfile}"
+           eerror "Please create script file of ytlocal in '/usr/sbin/ytlocal'"
-   eend $?
+           return 1
-}
+       else
-```
+           return 0
+       fi
+   }
 
-after, modified execute permissions:
+   start() {
+       ebegin "Starting yt-local"
+       start-stop-daemon --start --exec "${command}" --pidfile "${pidfile}"
+       eend $?
+   }
 
-    $ doas chmod a+x /etc/init.d/ytlocal
+   reload() {
+       ebegin "Reloading ${name}"
+       start-stop-daemon --signal HUP --pidfile "${pidfile}"
+       eend $?
+   }
 
+   stop() {
+       ebegin "Stopping ${name}"
+       start-stop-daemon --quiet --stop --exec "${command}" --pidfile "${pidfile}"
+       eend $?
+   }
+   ```
 
-2. Write `/usr/sbin/ytlocal` and configure path.
+   > [!NOTE]
+   > Ensure the script is executable:
+   >
+   > ```sh
+   > doas chmod a+x /etc/init.d/ytlocal
+   > ```
 
-```
+2. **Create the executable script** `/usr/sbin/ytlocal`:
-#!/usr/bin/env bash
 
-cd /home/your-path/ytlocal/ # change me
+   ```bash
-source venv/bin/activate
+   #!/usr/bin/env bash
-python server.py > /dev/null 2>&1 &
-echo $! > /var/run/ytlocal.pid
-```
 
-after, modified execute permissions:
+   # 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
+   python server.py > /dev/null 2>&1 &
+   echo $! > /var/run/ytlocal.pid
+   ```
 
-    $ doas chmod a+x /usr/sbin/ytlocal
+   > [!WARNING]
+   > Run this script only as root or via `doas`, as it writes to `/var/run` and uses network privileges.
 
+   > [!TIP]
+   > To store the PID in a different location, adjust the `pidfile` variable in the service script.
 
-3. OpenRC check
+   > [!IMPORTANT]
+   > Verify that the virtual environment (`venv`) is correctly set up and that `python` points to the appropriate version.
 
-- status: `doas rc-service ytlocal status`
+   > [!CAUTION]
-- start: `doas rc-service ytlocal start`
+   > Do not stop the process manually; use OpenRC commands (`rc-service ytlocal stop`) to avoid race conditions.
-- restart: `doas rc-service ytlocal restart`
-- stop: `doas rc-service ytlocal stop`
 
-- enable: `doas rc-update add ytlocal default`
+   > [!NOTE]
-- disable: `doas rc-update del ytlocal`
+   > When run with administrative privileges, the configuration is saved in `/root/.yt-local`, which is root‑only.
 
-When yt-local is run with administrator privileges,
+## Service Management
-the configuration file is stored in /root/.yt-local
+
+- **Status**: `doas rc-service ytlocal status`
+- **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`
+
+## Post‑Installation 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 server’s 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.