Organize docs

This commit is contained in:
Jesús 2021-01-10 15:31:22 -05:00
parent 78abaf7aba
commit 3868295b05
No known key found for this signature in database
GPG Key ID: F6EE7BC59A315766
3 changed files with 81 additions and 1 deletions

View File

@ -114,7 +114,7 @@ In general, Tor video routing will be slower (for instance, moving around in the
Pull requests and issues are welcome
For coding guidelines and an overview of the software architecture, see the HACKING.md file.
For coding guidelines and an overview of the software architecture, see the [HACKING.md](docs/HACKING.md) file.
## License

View File

@ -60,3 +60,7 @@
* You'll want to have a utility or IDE that can perform full text search on a repository, since this is crucial for navigating unfamiliar codebases to figure out where certain strings appear or where things get defined.
* If you're confused what the purpose of a particular line/section of code is, you can use the "git blame" feature on github (click the line number and then the three dots) to view the commit where the line of code was created and check the commit message. This will give you an idea of how it was put together.
## OpenRC init
You see [configuration with OpenRC](basic-script-openrc/README.md)

View File

@ -0,0 +1,76 @@
## Basic init yt-local for openrc
1. Write `/etc/init.d/ytlocal` file.
```
#!/sbin/openrc-run
# Distributed under the terms of the GNU General Public License v3 or later
name="yt-local"
pidfile="/var/run/ytlocal.pid"
command="/usr/sbin/ytlocal"
depend() {
use net
}
start_pre() {
if [ ! -f /usr/sbin/ytlocal ] ; then
eerror "Please create script file of ytlocal in '/usr/sbin/ytlocal'"
return 1
else
return 0
fi
}
start() {
ebegin "Starting yt-local"
start-stop-daemon --start --exec "${command}" --pidfile "${pidfile}"
eend $?
}
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 $?
}
```
after, modified execute permissions:
$ doas chmod a+x /etc/init.d/ytlocal
2. Write `/usr/sbin/ytlocal` and configure path.
```
#!/usr/bin/env bash
cd /home/your-path/ytlocal/ # change me
source venv/bin/activate
python server.py > /dev/null 2>&1 &
echo $! > /var/run/ytlocal.pid
```
after, modified execute permissions:
$ doas chmod a+x /usr/sbin/ytlocal
3. OpenRC check
- 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: `doas rc-update add ytlocal default`
- disable: `doas rc-update del ytlocal`
When yt-local is run with administrator privileges,
the configuration file is stored in /root/.youtube-local