Skip to content
Snippets Groups Projects
Commit e88529cd authored by Robin Appelman's avatar Robin Appelman
Browse files

readme formatting


Signed-off-by: default avatarRobin Appelman <robin@icewind.nl>
parent fa6cc3c4
No related branches found
No related tags found
No related merge requests found
......@@ -40,13 +40,14 @@ The setup required consists of three steps
### Push server
The push server should be setup to run as a background daemon, the recommended way is by setting it up as a system service in the init system.
If you're not using systemd than any init or process management system that runs the push server binary
with the described environment variables will work.
#### systemd
The push server should be setup to run as a background daemon, the recommended way is by setting up a systemd service to
run the server. If you're not using systemd than any init or process management system that runs the push server binary
with the described environment variables will work.
You can create a systemd service by creating a file named `/etc/systemd/system/notify_push.service` with the following
For systemd based setups, can create a systemd service by creating a file named `/etc/systemd/system/notify_push.service` with the following
content.
```ini
......@@ -63,28 +64,6 @@ User=www-data
WantedBy = multi-user.target
```
#### OpenRC
For Gentoo/Alpine/postmarketOS/Artix, you can create a OpenRC service by creating a file named
`/etc/init.d/notify_push` with the following content.
```ini
#!/sbin/openrc-run
description="Push daemon for Nextcloud clients"
pidfile=${pidfile:-/run/notify_push.pid}
runas_user=${runas_user:-www-data:www-data}
command=${command:-/path/to/push/binary/notify_push}
command_args="--port 7867 /path/to/nextcloud/config/config.php"
command_background=true
depend() {
need redis nginx php-fpm7 mariadb
}
```
Adjust the paths, ports and user as needed.
<details>
<summary>Snap configuration (click to expand)</summary>
......@@ -107,6 +86,29 @@ WantedBy = multi-user.target
</details>
#### OpenRC
For OpenRC based setups, you can create a OpenRC service by creating a file named
`/etc/init.d/notify_push` with the following content.
```ini
#!/sbin/openrc-run
description="Push daemon for Nextcloud clients"
pidfile=${pidfile:-/run/notify_push.pid}
runas_user=${runas_user:-www-data:www-data}
command=${command:-/path/to/push/binary/notify_push}
command_args="--port 7867 /path/to/nextcloud/config/config.php"
command_background=true
depend() {
need redis nginx php-fpm7 mariadb
}
```
Adjust the paths, ports and user as needed.
#### Configuration
The push server can be configured either by loading the config from the nextcloud `config.php`
......@@ -137,27 +139,20 @@ You can enable this same behavior by passing the `--glob-config` option.
Once the systemd service file is set up with the correct configuration you can start it using
`sudo systemctl start notify_push`
OpenRC
`sudo rc-service notify_push start`
- systemd: `sudo systemctl start notify_push`
- OpenRc: `sudo rc-service notify_push start`
and enable it to automatically start on boot using
`sudo systemctl enable notify_push`
OpenRC
- systemd: `sudo systemctl enable notify_push`
- OpenRc: `sudo rc-update add notify_push`
`sudo rc-update add notify_push`
Every time this app receives an update you should restart the systemd service using
`sudo systemctl restart notify_push`
OpenRC
- systemd: `sudo systemctl restart notify_push`
- OpenRc: `sudo rc-service notify_push restart`
`sudo rc-service notify_push restart`
<details>
<summary>Alternatively, you can do this automatically via systemctl by creating the following systemd service and path (click to expand)</summary>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment