Skip to content

Commit a71b1d7

Browse files
committed
more ultracc seedbox changes
1 parent 49c557a commit a71b1d7

File tree

1 file changed

+51
-31
lines changed

1 file changed

+51
-31
lines changed

docs/pages/client/install.md

Lines changed: 51 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -201,52 +201,73 @@ If they are no longer a member, try their Github.
201201
!!! warning "UltraCC Seedbox Users"
202202
This is community provided. The Notifiarr developers have very little experience with UltraCC.
203203
204-
1. SSH into your Ultra Seedbox
205-
1. On your landing directory type `mkdir notifiarr`
204+
### Install Client
205+
206+
The outcome of these steps is that you make a new folder named `notifiarr` in your home folder,
207+
and it contains the `notifiarr` binary and `notifiarr.conf` config file. We're also adding a user-level
208+
systemd service unit file to your home folder, enabling it (so it starts when the server boots).
209+
210+
When you finish here, head on over to the [After Install](./afterInstall.md) page for next steps.
211+
212+
1. SSH into your Ultra Seedbox.
213+
1. In your home folder type `mkdir notifiarr`
206214
1. Type `cd notifiarr`
207-
1. On [Github](https://github.com/Notifiarr/notifiarr/releases) find the latest release asset labelled `notifiarr.amd64.linux.gz`,
215+
1. On [Github](https://github.com/Notifiarr/notifiarr/releases) find the latest release asset labeled `notifiarr.amd64.linux.gz`,
208216
right click on that and click copy link.
209217
1. Download it; Back on your terminal type `wget '<paste link>'`
210218
1. Decompress it; Type `gzip -d notifiarr.amd64.linux.gz`
211219
1. Rename it; Type `mv notifiarr.amd64.linux notifiarr`
212220
1. Make it executable; Type `chmod +x notifiarr`
213221
1. Download config file; Type `wget -O notifiarr.conf https://raw.githubusercontent.com/Notifiarr/notifiarr/refs/heads/main/examples/notifiarr.conf.example`
214-
1. Type `mkdir -p cd /home/$USER/.config/systemd/user`
222+
223+
### Install Service Unit
224+
225+
1. Type `mkdir -p /home/$USER/.config/systemd/user`
215226
1. Type `cd /home/$USER/.config/systemd/user`
216-
1. Type `nano notifiarr.service`
217227
1. Type `id` to see your username.
218-
1. Copy and paste the following content.
228+
1. Type `nano notifiarr.service`
229+
1. Copy and paste the following content.
219230
1. Replace `YOUR-API-KEY-FROM-NOTIFIARR.COM` with your API key.
220231
1. **Replace `$USER` with your username.**
221232

222-
```none
223-
# Systemd service unit for notifiarr.
224-
225-
[Unit]
226-
Description=notifiarr - Official chat integration client for Notifiarr.com
227-
228-
[Service]
229-
ExecStart=/home/$USER/notifiarr/notifiarr
230-
Restart=always
231-
RestartSec=10
232-
Type=simple
233-
WorkingDirectory=/home/$USER/notifiarr
234-
Environment=DN_API_KEY=YOUR-API-KEY-FROM-NOTIFIARR.COM
235-
Environment=DN_LOG_FILE=/home/$USER/notifiarr/app.log
236-
Environment=DN_HTTP_LOG=/home/$USER/notifiarr/http.log
237-
Environment=DN_DEBUG_LOG=/home/$USR/notifiarr/debug.log
238-
Environment=DN_SERVICES_LOG_FILE=/home/$USER/notifiarr/services.log
239-
Environment=DN_QUIET=true
240-
241-
[Install]
242-
WantedBy=default.target
243-
```
233+
```none
234+
# Systemd service unit for notifiarr.
235+
236+
[Unit]
237+
Description=notifiarr - Official chat integration client for Notifiarr.com
238+
239+
[Service]
240+
ExecStart=/home/$USER/notifiarr/notifiarr
241+
Restart=always
242+
RestartSec=10
243+
Type=simple
244+
WorkingDirectory=/home/$USER/notifiarr
245+
Environment=DN_API_KEY=YOUR-API-KEY-FROM-NOTIFIARR.COM
246+
Environment=DN_LOG_FILE=/home/$USER/notifiarr/app.log
247+
Environment=DN_HTTP_LOG=/home/$USER/notifiarr/http.log
248+
Environment=DN_DEBUG_LOG=/home/$USR/notifiarr/debug.log
249+
Environment=DN_SERVICES_LOG_FILE=/home/$USER/notifiarr/services.log
250+
Environment=DN_QUIET=true
251+
252+
[Install]
253+
WantedBy=default.target
254+
```
255+
256+
### Start Client
257+
258+
Use these commands to control systemd. Systemd is what launches apps like notifiarr client.
259+
The `stop` and `restart` commands are not listed below, but you can use those too if you need them.
244260

245-
1. Type `systemctl --user enable notifiarr`
246-
1. Type `systemctl --user start notifiarr`
261+
1. Type `systemctl --user enable notifiarr` to make notifiarr auto-start.
262+
1. Type `systemctl --user start notifiarr` to start notifiarr now.
247263
1. Type `systemctl --user status notifiarr` to check if there are any errors.
248264
1. Type `systemctl --user daemon-reload` if you make changes to the above file (to re-load it).
249265
1. On your browser go to `http://your-ultraseedbox-url:5454`
266+
267+
### Configure Proxy
268+
269+
Setting up the proxy is optional, but recommended so you can access the client like your other apps.
270+
250271
1. Log into your Notifarr client and change the base url to `/notifiarr` and save changes
251272
1. Go back to your ssh console
252273
1. Type `cd /home/$USER/.apps/nginx/proxy.d`
@@ -275,4 +296,3 @@ location /notifiarr/api {
275296

276297
1. Type `systemctl --user restart nginx`
277298
1. Now you should be able to browse to `https://your-ultraseedbox-url/notifiarr`
278-
1. Head on over to the [After Install](./afterInstall.md) page.

0 commit comments

Comments
 (0)