Skip to content

Commit 7ddefdd

Browse files
authored
fix cleanup client windows install docs
1 parent 21bfcd4 commit 7ddefdd

File tree

1 file changed

+27
-35
lines changed

1 file changed

+27
-35
lines changed

docs/pages/client/install.md

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -71,54 +71,45 @@ service notifiarr start
7171
1. Use the menu bar icon to access the WebUI.
7272
1. Head on over to [After Install](afterInstall.md).
7373

74-
## Windows
74+
# Windows Installation
7575

76-
!!! info
77-
Suggested location and structure based on experience with permissions.
76+
## Directory Structure
7877

79-
### Desired Outcome
78+
Create the following in
8079

81-
- `C:\ProgramData\notifiarr\notifiarr.amd64.exe` - The Application.
82-
- `C:\ProgramData\notifiarr\notifiarr.conf` - The config file. Just the add the API key.
83-
- `C:\ProgramData\notifiarr\logs` - Folder for log files.
80+
`C:\ProgramData\notifiarr\`:
8481
85-
### Create the folders
86-
87-
1. Open C:\ProgramData and create a folder `notifiarr`
88-
1. Create a new folder named `logs`, so you now have `C:\ProgramData\notifiarr\logs`
89-
- When you add the log paths in the client UI (later steps), make sure you point them to a file such as:
90-
- `C:\ProgramData\notifiarr\logs\app.log`
91-
- `C:\ProgramData\notifiarr\logs\debug.log`
92-
- `C:\ProgramData\notifiarr\logs\http.log`
82+
```none
83+
notifiarr.amd64.exe
84+
notifiarr.conf
85+
logs\
86+
```
9387

94-
### New Install
88+
## New Install
9589

96-
1. Download `notifiarr.amd64.exe.zip` from [the Releases page](https://github.com/Notifiarr/notifiarr/releases)
97-
1. Save it in `C:\ProgramData\notifiarr`
98-
1. Open the folder that was created from extracting and copy the `.exe` + example `.conf` files up one directory so it is located at:
99-
- `C:\ProgramData\notifiarr\notifiarr.amd64.exe`
100-
- `C:\ProgramData\notifiarr\notifiarr.conf.example`
101-
1. You can now delete the `.zip` file that was downloaded and the folder that was extracted
90+
1. Download `notifiarr.amd64.exe.zip` from the [Releases page](https://github.com/Notifiarr/notifiarr/releases)
91+
1. Extract to `C:\ProgramData\notifiarr\`
92+
1. Move the `.exe` and `.conf.example` files to the root of that folder
10293
1. Rename `notifiarr.conf.example` to `notifiarr.conf`
94+
1. Delete the downloaded `.zip` and extracted folder
10395

104-
### Fix Existing Install
96+
## Migrating Existing Install
10597

10698
1. Stop the client
107-
1. Copy the existing `.exe` to `C:\ProgramData\notifiarr\notifiarr.amd64.exe`
108-
1. Copy the existing conf file to `C:\ProgramData\notifiarr\notifiarr.conf`
109-
1. If the `C:\users\<your home folder>\.notifiarr` folder exists, delete it
99+
1. Copy your existing `.exe` and `.conf` to `C:\ProgramData\notifiarr\`
100+
1. Delete `C:\Users\<username>\.notifiarr` if it exists
110101

111-
### Autostart & Password
102+
## First Run & Autostart
112103

113-
- At this point, the structure should look like the [Desired Outcome mentioned above](#desired-outcome).
104+
1. Double-click the `.exe` to launch
105+
1. Enter your API key when prompted
106+
1. Access the Web UI at `localhost:5454` using `admin` as the username and your API key as the password
114107

115-
1. Right click on the `.exe` and create a shortcut
116-
1. Windows logo key + R, type `shell:startup`, then select OK. This opens the Startup folder.
117-
1. Copy and paste the newly created shortcut from its current location to the opened Startup folder.
118-
1. Double click on the shortcut and the client is now running
119-
1. If this is the first time you have ran it:
120-
1. Option A: Look at the notifiarr.log (or app.log) and you will see the password at the top of the file.
121-
1. Option B: Right click on the notifiarr icon and pick Logs -> View and get the login credentials from there.
108+
To enable autostart:
109+
110+
1. Right-click the `.exe` and create a shortcut
111+
1. Press `Win+R`, type `shell:startup`, press Enter
112+
1. Move the shortcut to the opened Startup folder
122113

123114
## Synology
124115

@@ -313,3 +304,4 @@ curl -sSL https://raw.githubusercontent.com/Notifiarr/notifiarr/main/userscripts
313304

314305
1. Type `systemctl --user restart nginx`
315306
1. Now you should be able to browse to `https://your-ultraseedbox-url/notifiarr`
307+

0 commit comments

Comments
 (0)