Create contrib directory and replace examples dir.
This commit is contained in:
7
contrib/README.md
Normal file
7
contrib/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Contrib
|
||||
|
||||
This directory contains unmaintained, unsupported, and unorganized contributions by the Owncast community.
|
||||
|
||||
It is a place to put scripts, config files and examples that might be useful to share with others without expectation that they're an official part of the project.
|
||||
|
||||
[Read Drew DeVault's description of the contrib directory](https://drewdevault.com/2020/06/06/Add-a-contrib-directory.html) for details and background.
|
||||
19
contrib/owncast-sample.service
Normal file
19
contrib/owncast-sample.service
Normal file
@@ -0,0 +1,19 @@
|
||||
[Unit]
|
||||
Description=Owncast Service
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
WorkingDirectory=[path to owncast directory]
|
||||
ReadWritePaths=[path to owncast directory]
|
||||
ExecStart=[path to owncast directory]/owncast
|
||||
Restart=always
|
||||
RestartSec=5
|
||||
User=[user to run owncast as]
|
||||
Group=[group to run owncast as]
|
||||
NoNewPrivileges=true
|
||||
SecureBits=noroot
|
||||
ProtectSystem=strict
|
||||
ProtectHome=read-only
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
41
contrib/owncast-systemd-service.md
Normal file
41
contrib/owncast-systemd-service.md
Normal file
@@ -0,0 +1,41 @@
|
||||
This can be any text that makes sense to you.
|
||||
```
|
||||
[Unit]
|
||||
Description=Owncast Service
|
||||
```
|
||||
|
||||
This is where the "functional" parts of the service live.<br />
|
||||
```
|
||||
[Service]
|
||||
Type=simple
|
||||
WorkingDirectory=[path_to_owncast_root_directory]
|
||||
ExecStart=[path_to_owncast_executable]
|
||||
Restart=on-failure
|
||||
RestartSec=5
|
||||
```
|
||||
`WorkingDirectory` should be where you want the owncast folder to live.<br />
|
||||
|
||||
**Example:**<br />
|
||||
```WorkingDirectory=/var/www/owncast```
|
||||
|
||||
Similarly the `ExecStart` is the actual owncast binary.<br />
|
||||
|
||||
**Example:**<br />
|
||||
```ExecStart=/var/www/owncast/owncast```
|
||||
|
||||
```
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
This just means, use runlevel 3 non-graphical.
|
||||
|
||||
|
||||
**INSTALLATION**
|
||||
Just create the file in your systemd configuraiton directory (typically /etc/systemd/system/), and update the systemd daemon with:
|
||||
```$sudo systemd daemon-reload```
|
||||
|
||||
**USAGE**
|
||||
Currently the following options work
|
||||
- Start
|
||||
- Stop
|
||||
- Status
|
||||
Reference in New Issue
Block a user