Skip to content

Commit 86a3829

Browse files
ljm42grizzlechips
andauthored
Content updates Oct 14, 2025 (#360)
Before Submitting This PR, Please Ensure You Have Completed The Following: 1. [ ] Are internal links to wiki documents using [relative file links](https://docusaurus.io/docs/markdown-features/links)? 2. [ ] Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)? 3. [ ] Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files? 4. [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? 5. [ ] Is the build succeeding? <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a License link (CC BY‑SA 4.0) to the site footer. * **Documentation** * Expanded Notification Settings with step‑by‑step setup, SMTP/Gmail examples, delivery agents, and usage tips. * Reworked upgrade/downgrade guidance with manual workflows, verification steps, and enhanced troubleshooting. * Updated Tailscale guidance (hostname resolution option, subnet routing, logging, and update workflows). * Overhauled unclean shutdowns with VM‑hibernation‑first strategy and tabbed timeout guidance. * Enhanced VM docs (snapshots, conversion/migration, GPU/passthrough, caution links). * Added ZFS guidance: recommended drive counts and optimization tips. * **Localization** * Added footer localization entries for the new License link. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: grizzlechips <zach@zachtuttle.com>
1 parent ab1b05b commit 86a3829

File tree

33 files changed

+1083
-400
lines changed

33 files changed

+1083
-400
lines changed

docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -166,13 +166,27 @@ When you set up a %%ZFS|zfs%% pool, your allocation profile determines how your
166166
![](/img/zfs11.png)
167167
</div>
168168

169-
| Profile | Redundancy | Performance | Expansion | Space Efficiency | Typical Use Case |
170-
| ------- | ----------------------------- | --------------------------------------------------------- | ---------------- | ---------------- | ---------------------------------------- |
171-
| Stripe | None | Fast, but risky | Add more disks | 100% | Temporary/scratch storage |
172-
| Mirror | 1:1 (%%RAID 1\|raid1%% style) | Excellent for random I/O | Add more mirrors | 50% | High performance, easy expansion |
173-
| RAIDZ1 | 1 disk per vdev | Fast for big files. Not ideal for small or random writes. | Add new vdevs | High | General use, 1-disk fault tolerance |
174-
| RAIDZ2 | 2 disks per vdev | Like Z1 but slightly slower writes (extra parity) | Add new vdevs | Moderate | Important data, 2-disk fault tolerance |
175-
| RAIDZ3 | 3 disks per vdev | Like Z2, with more write overhead (for maximum safety) | Add new vdevs | Lower | Mission-critical, 3-disk fault tolerance |
169+
| Profile | Redundancy | Performance | Expansion | Space Efficiency | Typical Use Case | Recommended Drive Count Per vdev |
170+
| ------- | ----------------------------- | --------------------------------------------------------- | ---------------- | ---------------- | ---------------------------------------- | ----------------------------------- |
171+
| Stripe | None | Fast, but risky | Add more disks | 100% | Temporary/scratch storage | Any number |
172+
| Mirror | 1:1 (%%RAID 1\|raid1%% style) | Excellent for random I/O | Add more mirrors | 50% | High performance, easy expansion | 2 drives (can add more mirrors) |
173+
| RAIDZ1 | 1 disk per vdev | Fast for big files. Not ideal for small or random writes. | Add new vdevs | High | General use, 1-disk fault tolerance | 3-6 drives (max 8) |
174+
| RAIDZ2 | 2 disks per vdev | Like Z1 but slightly slower writes (extra parity) | Add new vdevs | Moderate | Important data, 2-disk fault tolerance | 6-12 drives (max 14) |
175+
| RAIDZ3 | 3 disks per vdev | Like Z2, with more write overhead (for maximum safety) | Add new vdevs | Lower | Mission-critical, 3-disk fault tolerance | 10-16 drives (max 20) |
176+
177+
:::tip[Optimizing drive counts]
178+
179+
The recommended drive counts in the table above work well for most users. For even better performance, you can optimize within those ranges by choosing configurations where the number of data disks (total disks minus parity disks) is a **power of 2** (e.g., 2, 4, 8, 16). This helps align data stripes correctly, preventing wasted space and uneven I/O.
180+
181+
**Examples of optimized configurations:**
182+
183+
- **RAIDZ1**: 3, 5, or 9 drives (data disks = 2, 4, or 8)
184+
- **RAIDZ2**: 4, 6, or 10 drives (data disks = 2, 4, or 8)
185+
- **RAIDZ3**: 5, 9, or 17 drives (data disks = 2, 6, or 14)
186+
187+
Note that these optimizations are optional - the recommendations above should work well for most use cases.
188+
189+
:::
176190

177191
:::important[How to choose]
178192

docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx

Lines changed: 152 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,12 +209,163 @@ Customize the Unraid %%WebGUI|web-gui%% appearance on this page by adjusting the
209209

210210
### Notification Settings
211211

212-
You can configure browser and email notifications on this page, subscribing to different types and setting custom alerts for %%SMART|smart%% attribute values.
212+
Unraid can send you notifications about important system events, updates, and alerts through your browser, email, or third-party notification services. The Notification Settings page allows you to control how and when you receive these notifications.
213+
214+
To access Notification Settings, navigate to ***Settings → User Preferences → Notification Settings***.
213215

214216
<div style={{ margin: 'auto', maxWidth: '400px'}}>
215217
![Notification Settings](/img/settings-notifications.png)
216218
</div>
217219

220+
#### Display and behavior settings
221+
222+
Configure how notifications appear in your browser:
223+
224+
- **Notifications display**: Choose between *Detailed* or *Summarized* notification styles
225+
- **Display position**: Set where notifications appear (*top-right*, *top-left*, *bottom-right*, *bottom-left*, or *center*)
226+
- **Auto-close (seconds)**: How long notifications stay visible before automatically closing
227+
- **Date format**: Choose your preferred date format for notification timestamps
228+
- **Time format**: Choose between *12 hours* or *24 hours* time display
229+
- **Store notifications to flash**: Save notification history to your USB flash device (requires flash storage space)
230+
231+
#### Notification types
232+
233+
Control which events trigger notifications:
234+
235+
- **System notifications**: General system events and messages
236+
- **Unraid OS update notification**: Alerts when new Unraid OS versions are available
237+
- **Plugins update notification**: Alerts when plugin updates are available
238+
- **Docker update notification**: Alerts when Docker container updates are available
239+
- **Language update notification**: Alerts when language pack updates are available
240+
- **Array status notification**: Alerts about %%array|array%% events and status changes
241+
242+
For each notification type, you're able to set the frequency to *Never check*, or checking daily, weekly, monthly, or, in some cases, even multiple times a day.
243+
244+
#### Delivery methods
245+
246+
Choose how you want to receive notifications for each category (*Notices*, *Warnings*, and *Alerts*):
247+
248+
- **Browser**: Display notifications in the %%WebGUI|web-gui%% when you're logged in
249+
- **Email**: Send notifications via email (requires [SMTP configuration](#smtp-settings))
250+
- **Agents**: Send notifications through configured third-party services
251+
252+
:::tip
253+
254+
Enable **Browser** notifications for immediate visibility when using the %%WebGUI|web-gui%%, and **Email** for alerts when you're away from your server. Use **Agents** to integrate with mobile apps and services like Discord or Telegram.
255+
256+
:::
257+
258+
#### SMTP Settings
259+
260+
To receive email notifications, you need to configure your email server settings. Unraid supports many email providers including Gmail, Outlook, and custom SMTP servers.
261+
262+
The SMTP Settings can be found at ***Settings → User Preferences → Notification Settings → SMTP Settings***.
263+
264+
**Basic configuration:**
265+
266+
- **Preset service**: Select a preset configuration (*Gmail*, *Outlook/Hotmail*, or *Custom*) to auto-fill common settings
267+
- **Sending email address**: The email address notifications will be sent from
268+
- **Email recipients**: Comma-separated list of email addresses to receive notifications
269+
- **Priority in header**: Mark emails as high priority (*Yes* or *No*)
270+
- **Email subject prefix**: Text to prepend to all notification email subjects (default: *Unraid Status:*)
271+
272+
**Server settings:**
273+
274+
- **Mail server**: SMTP server address (e.g., `smtp.gmail.com`)
275+
- **Mail server port**: SMTP port number (common ports: `465` for SSL/TLS, `587` for STARTTLS, `25` for unencrypted)
276+
- **Use SSL/TLS**: Enable SSL/TLS encryption (*Yes* or *No*)
277+
- **Use STARTTLS**: Use STARTTLS for encryption (*Yes* or *No*)
278+
- **Define a TLS certificate**: Specify a custom TLS certificate if needed (*Yes* or *No*)
279+
- **TLS certificate location**: Path to custom certificate file (only if *Define a TLS certificate* is enabled)
280+
281+
**Authentication:**
282+
283+
- **Authentication method**: Choose *None*, *CRAM-MD5*, or *Login* (username/password)
284+
- **Username**: Your email account username (usually your full email address)
285+
- **Password**: Your email account password or app-specific password
286+
287+
After configuring your settings, use the **TEST** button to verify your email configuration is working correctly.
288+
289+
##### Configuring Gmail with app passwords
290+
291+
Gmail requires app-specific passwords when using SMTP with accounts that have 2-step verification enabled (which is recommended for security).
292+
293+
**To set up Gmail notifications:**
294+
295+
1. In **Preset service**, select *Gmail* (this will auto-fill the **Mail server** and **Mail server port**)
296+
2. Enter your Gmail address in **Sending email address**
297+
3. Enter recipient email address(es) in **Email recipients**
298+
4. Set **Username** to your full Gmail address (e.g., `yourname@gmail.com`)
299+
5. For **Password**, you'll need to generate an app password:
300+
- Go to your [Google Account settings](https://myaccount.google.com/)
301+
- Navigate to **Security**
302+
- Under "How you sign in to Google," ensure **2-Step Verification** is enabled (required for app passwords)
303+
- In the same section, find and click **App passwords** (or search for "App passwords" in the search bar)
304+
- You may need to verify your identity
305+
- Enter a custom name for the App name, like "Unraid Server".
306+
- Click **Create**
307+
- Google will generate a 16-character password.
308+
- Copy this password and paste it into the **Password** field in Unraid
309+
6. Click **TEST** to verify the configuration
310+
7. Click **DONE** to save your settings
311+
312+
:::tip[Default Gmail settings]
313+
314+
- **Mail server**: `smtp.gmail.com`
315+
- **Mail server port**: `465`
316+
- **Use SSL/TLS**: `Yes`
317+
- **Use STARTTLS**: `No`
318+
- **Authentication method**: `Login`
319+
320+
:::
321+
322+
:::warning[Security recommendation]
323+
324+
Always use app passwords instead of your main Gmail password. App passwords can be revoked individually without changing your main account password, providing better security if your Unraid configuration is ever compromised.
325+
326+
:::
327+
328+
#### Notification Agents
329+
330+
Notification agents allow you to send alerts to third-party services and mobile apps. Unraid includes built-in support for many popular notification services.
331+
332+
To access Notification Agents, click the **Notification Agents** link on the Notification Settings page, or navigate to ***Settings → User Preferences → Notification Settings → Notification Agents***.
333+
334+
**Built-in agents include:**
335+
336+
- <img src="/img/customize-unraid-settings/icons/icon-bark.png" alt="Bark" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Bark**: iOS notification app
337+
- <img src="/img/customize-unraid-settings/icons/icon-boxcar.png" alt="Boxcar" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Boxcar**: Push notification service
338+
- <img src="/img/customize-unraid-settings/icons/icon-discord.png" alt="Discord" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Discord**: Send notifications to Discord channels via webhook
339+
- <img src="/img/customize-unraid-settings/icons/icon-gotify.png" alt="Gotify" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Gotify**: Self-hosted notification server
340+
- <img src="/img/customize-unraid-settings/icons/icon-ntfy.png" alt="ntfy.sh" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **ntfy.sh**: Simple HTTP-based notification service
341+
- <img src="/img/customize-unraid-settings/icons/icon-prowl.png" alt="Prowl" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Prowl**: iOS push notifications
342+
- <img src="/img/customize-unraid-settings/icons/icon-pushbits.png" alt="Pushbits" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Pushbits**: Self-hosted notification relay
343+
- <img src="/img/customize-unraid-settings/icons/icon-pushbullet.png" alt="Pushbullet" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Pushbullet**: Cross-platform notification service
344+
- <img src="/img/customize-unraid-settings/icons/icon-pushover.png" alt="Pushover" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Pushover**: Push notification service for iOS and Android
345+
- <img src="/img/customize-unraid-settings/icons/icon-pushplus.png" alt="Pushplus" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Pushplus**: Chinese push notification service
346+
- <img src="/img/customize-unraid-settings/icons/icon-serverchan.png" alt="ServerChan" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **ServerChan**: Chinese server monitoring and notification service
347+
- <img src="/img/customize-unraid-settings/icons/icon-slack.png" alt="Slack" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Slack**: Send notifications to Slack channels via webhook
348+
- <img src="/img/customize-unraid-settings/icons/icon-telegram.png" alt="Telegram" style={{height: '20px', verticalAlign: 'middle', marginRight: '8px'}} /> **Telegram**: Send messages to Telegram bot
349+
350+
**Configuring an agent:**
351+
352+
1. Select the agent you want to configure from the list
353+
2. Change **Agent function** from *Disabled* to *Enabled*
354+
3. Fill in the required fields for that service:
355+
- Most agents require a **webhook URL**, **API token**, or **access token**
356+
- Some services require additional configuration like channel IDs or group codes
357+
4. Configure **Notification title** (usually set to *Subject* to use the notification subject)
358+
5. Configure **Notification message** (usually set to *Description* to use the full notification text)
359+
6. Click **DONE** to save
360+
361+
Each agent has different requirements - consult the documentation for your chosen service to obtain the necessary API keys, webhook URLs, or tokens.
362+
363+
:::tip
364+
365+
You can enable multiple agents simultaneously. For example, you might use Discord for team notifications and Pushover for personal mobile alerts. Note that **all notifications** are sent to **all enabled agents**, so using multiple agents may result in receiving duplicate notifications.
366+
367+
:::
368+
218369
### Scheduler
219370

220371
The Scheduler settings page allows you to easily configure the frequency for automated tasks including %%parity checks|parity-check%%, the cache %%Mover|mover%%, and %%TRIM/Discard|trim-discard%% operations for SSDs.

0 commit comments

Comments
 (0)