Skip to content
43 changes: 28 additions & 15 deletions docs/pages/client/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ service notifiarr start
## Windows

!!! info
Suggested location and structure based on experience with permissions.
Suggested location and structure based on experience with permissions.

### Desired Outcome

Expand All @@ -86,20 +86,22 @@ service notifiarr start

1. Open C:\ProgramData and create a folder `notifiarr`
1. Create a new folder named `logs`, so you now have `C:\ProgramData\notifiarr\logs`
- When you add the log paths in the client UI (later steps), make sure you point them to a file such as:
- `C:\ProgramData\notifiarr\logs\app.log`
- `C:\ProgramData\notifiarr\logs\debug.log`
- `C:\ProgramData\notifiarr\logs\http.log`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These indents are supposed to be here.

- When you add the log paths in the client UI (later steps), make sure you point them to a file such as:
- `C:\ProgramData\notifiarr\logs\app.log`
- `C:\ProgramData\notifiarr\logs\debug.log`
- `C:\ProgramData\notifiarr\logs\http.log`

### New Install

1. Download `notifiarr.amd64.exe.zip` from [the Releases page](https://github.com/Notifiarr/notifiarr/releases)
1. Save it in `C:\ProgramData\notifiarr`
1. Open the folder that was created from extracting and copy the `.exe` + example `.conf` files up one directory so it is located at:
- `C:\ProgramData\notifiarr\notifiarr.amd64.exe`
- `C:\ProgramData\notifiarr\notifiarr.conf.example`
- `C:\ProgramData\notifiarr\notifiarr.amd64.exe`
- `C:\ProgramData\notifiarr\notifiarr.conf.example`
1. You can now delete the `.zip` file that was downloaded and the folder that was extracted
1. Rename `notifiarr.conf.example` to `notifiarr.conf`
1. Double-click `notifiarr.amd64.exe` to launch the client. The webui will be available at [http://127.0.0.1:5454](http://127.0.0.1:5454)
1. Enter your API key when prompted

### Fix Existing Install

Expand All @@ -108,17 +110,28 @@ service notifiarr start
1. Copy the existing conf file to `C:\ProgramData\notifiarr\notifiarr.conf`
1. If the `C:\users\<your home folder>\.notifiarr` folder exists, delete it

### Autostart & Password
### First Run & Autostart

- At this point, the structure should look like the [Desired Outcome mentioned above](#desired-outcome).

1. Right click on the `.exe` and create a shortcut
1. Windows logo key + R, type `shell:startup`, then select OK. This opens the Startup folder.
1. Copy and paste the newly created shortcut from its current location to the opened Startup folder.
1. Double click on the shortcut and the client is now running
1. If this is the first time you have ran it:
1. Option A: Look at the notifiarr.log (or app.log) and you will see the password at the top of the file.
1. Option B: Right click on the notifiarr icon and pick Logs -> View and get the login credentials from there.
#### First Run

1. Double-click `notifiarr.amd64.exe` to launch
1. Enter your API key when prompted
1. Access the Web UI at `http://127.0.0.1:5454`
- Username: `admin`
- Password: Your API key

#### Autostart

1. Right-click on `notifiarr.amd64.exe` and create a shortcut.
1. Press Windows key + R, type `shell:startup`, then select OK
1. Copy the shortcut to the opened Startup folder

#### Finding Password in Logs (if needed)

- **Option A:** Check `notifiarr.log` (or `app.log`) - password is at the top of the file
- **Option B:** Right-click the notifiarr tray icon → Logs → View

## Synology

Expand Down