@@ -71,45 +71,67 @@ service notifiarr start
71711. Use the menu bar icon to access the WebUI.
72721. Head on over to [After Install](afterInstall.md).
7373
74- # # Windows Installation
74+ # # Windows
7575
76- # ## Directory Structure
76+ !!! info
77+ Suggested location and structure based on experience with permissions.
7778
78- Create the following in
79+ # ## Desired Outcome
7980
80- ` C:\P rogramData\n otifiarr\` :
81+ - ` C:\P rogramData\n otifiarr\n otifiarr.amd64.exe` - The Application.
82+ - ` C:\P rogramData\n otifiarr\n otifiarr.conf` - The config file. Just the add the API key.
83+ - ` C:\P rogramData\n otifiarr\l ogs` - Folder for log files.
8184
82- ` ` ` none
83- notifiarr.amd64.exe
84- notifiarr.conf
85- logs\
86- ```
85+ # ## Create the folders
86+
87+ 1. Open C:\P rogramData and create a folder ` notifiarr`
88+ 1. Create a new folder named ` logs` , so you now have ` C:\P rogramData\n otifiarr\l ogs`
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:\P rogramData\n otifiarr\l ogs\a pp.log`
91+ - ` C:\P rogramData\n otifiarr\l ogs\d ebug.log`
92+ - ` C:\P rogramData\n otifiarr\l ogs\h ttp.log`
8793
8894# ## New Install
8995
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
96+ 1. Download ` notifiarr.amd64.exe.zip` from [the Releases page](https://github.com/Notifiarr/notifiarr/releases)
97+ 1. Save it in ` C:\P rogramData\n otifiarr`
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:\P rogramData\n otifiarr\n otifiarr.amd64.exe`
100+ - ` C:\P rogramData\n otifiarr\n otifiarr.conf.example`
101+ 1. You can now delete the ` .zip` file that was downloaded and the folder that was extracted
931021. Rename ` notifiarr.conf.example` to ` notifiarr.conf`
94- 1 . Delete the downloaded ` .zip ` and extracted folder
103+ 1. Double-click ` notifiarr.amd64.exe` to launch
104+ 1. Enter your API key when prompted
95105
96- ### Migrating Existing Install
106+ # ## Fix Existing Install
97107
981081. Stop the client
99- 1 . Copy your existing ` .exe ` and ` .conf ` to ` C:\ProgramData\notifiarr\ `
100- 1 . Delete ` C:\Users\<username>\.notifiarr ` if it exists
109+ 1. Copy the existing ` .exe` to ` C:\P rogramData\n otifiarr\n otifiarr.amd64.exe`
110+ 1. Copy the existing conf file to ` C:\P rogramData\n otifiarr\n otifiarr.conf`
111+ 1. If the ` C:\u sers\< your home folder> \. notifiarr` folder exists, delete it
101112
102113# ## First Run & Autostart
103114
104- 1 . Double-click the ` .exe ` to launch
115+ - At this point, the structure should look like the [Desired Outcome mentioned above](# desired-outcome).
116+
117+ # ### First Run
118+
119+ 1. Double-click ` notifiarr.amd64.exe` to launch
1051201. Enter your API key when prompted
106- 1 . Access the Web UI at ` 127.0.0.1:5454 ` using ` admin ` as the username and your API key as the password
121+ 1. Access the Web UI at ` localhost:5454`
122+ - Username: ` admin`
123+ - Password: Your API key
124+
125+ # ### Autostart
107126
108- To enable autostart:
127+ 1. Right-click on the ` .exe` and create a shortcut
128+ 1. Press Windows key + R, type ` shell:startup` , then select OK
129+ 1. Copy the shortcut to the opened Startup folder
109130
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
131+ # ### Finding Password in Logs (if needed)
132+
133+ - ** Option A:** Check ` notifiarr.log` (or ` app.log` ) - password is at the top of the file
134+ - ** Option B:** Right-click the notifiarr tray icon → Logs → View
113135
114136# # Synology
115137
@@ -306,3 +328,4 @@ curl -sSL https://raw.githubusercontent.com/Notifiarr/notifiarr/main/userscripts
306328 1. Now you should be able to browse to ` https://your-ultraseedbox-url/notifiarr`
307329
308330
331+
0 commit comments