-
Notifications
You must be signed in to change notification settings - Fork 6
/
helptext.txt
2524 lines (1826 loc) · 114 KB
/
helptext.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
:main_array_devices_help:
**Colored Status Indicator** the significance of the color indicator at the beginning of each line in *Array Devices* is as follows:
<i class='fa fa-circle orb green-orb'></i>Normal operation, device is active.
<i class='fa fa-circle orb grey-orb'></i>Device is in standby mode (spun-down).
<i class='fa fa-warning orb yellow-orb'></i>Device contents emulated.
<i class='fa fa-times orb red-orb'></i>Device is disabled, contents emulated.
<i class='fa fa-square orb blue-orb'></i>New device.
<i class='fa fa-square orb grey-orb'></i>No device present, position is empty.
**Identification** is the *signature* that uniquely identifies a storage device. The signature
includes the device model number, serial number, linux device id, and the device size.
**Temp.** (temperature) is read directly from the device. You configure which units to use on
the [Display Preferences](Settings/DisplaySettings) page. We do not read the temperature of spun-down hard
drives since this typically causes them to spin up; instead we display the `*` symbol. We also
display the `*` symbol for SSD and Flash devices, though sometimes these devices do report a valid
temperature, and sometimes they return the value `0`.
**Size, Used, Free** reports the total device size, used space, and remaining space for files. These
units are also configured on the [Display Preferences](Settings/DisplaySettings) page. The
amount of space used will be non-zero even for an empty disk due to file system overhead.
*Note: for a multi-device cache pool, this data is for the entire pool as returned by btrfs.*
**Reads, Writes** are a count of I/O requests sent to the device I/O drivers. These statistics may
be cleared at any time, refer to the Array Status section below.
**Errors** counts the number of *unrecoverable* errors reported by the device
I/O drivers. Missing data due to unrecoverable array read errors is filled in on-the-fly using parity
reconstruct (and we attempt to write this data back to the sector(s) which failed). Any unrecoverable
write error results in *disabling* the disk.
**FS** indicates the file system detected in partition 1 of the device.
**View** column contains a folder icon indicating the device is *mounted*. Click the icon to
browse the file system.
If "Display array totals" is enable on the [Display Preferences](Settings/DisplaySettings) page, a
**Total** line is included which provides a tally of the device statistics, including the average temperature
of your devices.
The Array must be Stopped in order to change Array device assignments.
An Unraid array consists of one or two Parity disks and a number of Data disks. The Data
disks are exclusively used to store user data, and the Parity disk(s) provides the redundancy necessary
to recover from disk failures.
Since data is not striped across the array, the Parity disk(s) must be as large, or larger than the largest Data
disk. Parity should also be your highest performance drive.
Each Data disk has its own file system and can be exported as a
separate share.
Click on the Device name to configure individual device settings and launch certain utilities.
:end
:main_slots_help:
**Slots** select the number of device slots in your server designated for Array devices.
The minimum number of Array slots is 2, and you must have at least one device assigned to the array.
:end
:cache_devices_help:
**Colored Status Indicator** the significance of the color indicator at the beginning of each line in *Pool Devices* is as follows:
<i class='fa fa-circle orb green-orb'></i>Normal operation, device is active.
<i class='fa fa-circle orb grey-orb'></i>Device is in standby mode (spun-down).
<i class='fa fa-square orb blue-orb'></i>New device.
<i class='fa fa-square orb grey-orb'></i>No device present, position is empty.
**Pool Devices** is a single device, or pool of multiple devices, *outside* the Unraid array. It may be exported for network access just
like an Array device. Being outside the Unraid array results in significantly faster write access.
There are two ways to configure the Pool devices:
1. As a single device, or
2. As a multi-device pool.
When configured as a single device you may format the device using any supported file system (btrfs, reiserfs,
or xfs). This configuration offers the highest performance, but at the cost of no data protection - if the
single pool device fails all data contained on it may be lost.
When configured as a multi-device pool, Unraid OS will automatically select *btrfs-raid1* format (for both data
and meta-data). btrfs permits any number of devices to be added to the pool and each copy of data is guaranteed
to be written to two different devices. Hence the pool can withstand a single-disk failure without losing data.
When [User Shares](/Settings/ShareSettings) are enabled, user shares may be configured to
automatically make use of the Pool device in order to
speed up writes. A special background process called the *mover* can be scheduled to run
periodically to move user share files off the Cache and onto the Array.
:end
:cache_slots_help:
**Slots** select the number of device slots in your server designated for Cache devices.
:end
:boot_device_help:
Vital array configuration is maintained on the USB Flash device; for this reason, it must remain
plugged in to your server. Click on [Flash](/Main/Flash?name=flash) to see the GUID and registration
information, and to configure export settings. Since the USB Flash device is formatted using FAT file system,
it may only be exported using SMB protocol.
:end
:array_status_help:
**Colored Status Indicator** the significance of the color indicator of the *Array* is as follows:
<i class='fa fa-circle orb green-orb'></i>Array is Started and Parity is valid.
<i class='fa fa-circle orb grey-orb'></i>Array is Stopped, Parity is valid.
<i class='fa fa-warning orb yellow-orb'></i>Array is Started, but Parity is invalid.
<i class='fa fa-warning orb grey-orb'></i>Array is Stopped, Parity is invalid.
:end
:array_devices_help:
#### Assigning Devices
An unRAID disk array consists of a single parity disk and a number of data disks. The data
disks are exclusively used to store user data, and the parity disk provides the redundancy necessary
to recover from any single disk failure.
Note that we are careful to use the term *disk* when referring to an array storage device. We
use the term *hard drive* (or sometimes just *drive*) when referring to an actual hard disk drive (HDD)
device. This is because in a RAID system it is possible to read/write an array disk whose corresponding
hard drive is disabled or even missing! In addition, it is useful to be able to ask, "which device is
assigned to be the parity disk?"; or, "which device corresponds to disk2?".
We therefore need a way to assign hard drives to array disks. This is accomplished here on the
Main page when the array is stopped. There is a drop-down box for each array disk which lists all the
unassigned devices. To assign a device simply select it from the list. Each time a device
assignment is made, the system updates a configuration file to record the assignment.
#### Requirements
Unlike traditional RAID systems which stripe data across all the array devices, an unRAID server
stores files on individual hard drives. Consequently, all file write operations will involve both the
data disk the file is being written to, and the parity disk. For these reasons,
* the parity disk size must be as large or larger than any of the data disks,
and
* given a choice, the parity disk should be the fastest disk in your collection.
#### Guidelines
Here are the steps you should follow when designing your unRAID disk array:
1. Decide which hard drive you will use for parity, and which hard drives you will use for
data disk1, disk2, etc., and label them in some fashion. Also, find the serial number of each hard
drive and jot it down somewhere; you will need this information later.
2. Install your hard drive devices, boot unRAID Server and bring up the webGui. If this is a fresh system
build, then the Main page will show no disks installed. This doesn't mean the system can't detect your
hard drives; it just means that none have been assigned yet.
3. Remember the serial numbers you recorded back in step 1? For parity and each data disk, select the
proper hard drive based on its serial number from the drop down list.
#### Hot Plug
You may also *hot plug* hard drives into your server if your hardware supports it. For example,
if you are using hard drive cages, you may simply plug them into your server while powered on and
with array Stopped. Refresh the Main page to have new unassigned devices appear in the assignment
dropdown lists.
#### Next Steps
Once you have assigned all of your hard drives, refer to the Array Status section below
and Start the array.
:end
:encryption_help:
#### Encryption input
With array Stopped, the user can specify a new encryption key. Note that once a device
is formatted with a particular key it may only be opened using that same key. Changing the encryption key requires
encrypted devices to be reformatted **resulting in permanent loss of all existing data on those devices.**
#### Passphrase
Enter a passphrase of up to 512 characters. It is highly advisable to only use the 95 printable characters from the
first 128 characters of the [ASCII table](https://en.wikipedia.org/wiki/ASCII), as they will always have the same binary
representation. Other characters may have different encoding depending on system configuration and your passphrase will
not work with a different encoding. If you want a longer passphrase or to include binary data, upload a keyfile instead.
Please refer to the [cryptsetup FAQ](https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions#5-security-aspects)
for what constitutes a *secure* passphrase.
**Memorize** this passphrase. **IF LOST, ENCRYPTED CONTENT CANNOT BE RECOVERED!**
#### Keyfile
Select a local keyfile with a stored encryption key or a binary file. The maximum size of the keyfile is 8M (8388608 byte).
**Backup** your local keyfile. **IF LOST, ENCRYPTED CONTENT CANNOT BE RECOVERED!**
:end
:info_warning_temp_help:
*Warning disk temperature* sets the warning threshold for this hard disk temperature. Exceeding this threshold will result in a warning notification.
A value of zero will disable the warning threshold (including notifications).
:end
:info_critical_temp_help:
*Critical disk temperature* sets the critical threshold for this hard disk temperature. Exceeding this threshold will result in an alert notification.
A value of zero will disable the critical threshold (including notifications).
:end
:info_file_system_help:
Enter the desired file system type. Changing the file system type of a device will permit you to reformat
that device using the new file system. Be aware that **all existing data on the device will be lost**.
:end
:info_comments_help:
This text will appear under the *Comments* column for the share in Windows Explorer.
Enter anything you like, up to 256 characters.
:end
:info_warning_utilization_help:
*Warning disk utilization* sets the warning threshold for this hard disk utilization. Exceeding this threshold will result in a warning notification.
When the warning threshold is set equal or greater than the critical threshold, there will be only critical notifications (warnings are not existing).
A value of zero will disable the warning threshold (including notifications).
:end
:info_critical_utilization_help:
*Critical disk utilization* sets the critical threshold for this hard disk utilization. Exceeding this threshold will result in an alert notification.
A value of zero will disable the critical threshold (including notifications).
:end
:info_btrfs_balance_help:
**Balance** will run the *btrfs balance* program to restripe the extents across all pool devices, for example,
to convert the pool from raid1 to raid0 or vice-versa.
When a *full balance* is performed, it basically rewrites everything in the current filesystem.
A *mode conversion* affects the btrfs data extents; metadata always uses raid1 and is converted to raid1 if necessary by any balance operation.
The run time is potentially very long, depending on the filesystem size and speed of the device.
Unraid uses these default options when creating a multiple-device pool:
`-dconvert=raid1 -mconvert=raid1`
For more complete documentation, please refer to the btrfs-balance [Manpage](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs-balance)
*Note: raid5 and raid6 are generally still considered **experimental** by the Linux community*
:end
:info_balance_cancel_help:
**Cancel** will cancel the balance operation in progress.
:end
:info_btrfs_scrub_help:
**Scrub** runs the *btrfs scrub* program which will read all data and metadata blocks from all
devices and verify checksums.
If *Repair corrupted blocks* is checked, *btrfs scrub* will repair corrupted blocks if there’s a correct copy available.
:end
:info_scrub_cancel_help:
**Cancel** will cancel the Scrub operation in progress.
:end
:info_btrfs_check_help:
**Check** will run the *btrfs check* program to check file system integrity on the device.
The *Options* field is initialized with *--readonly* which specifies check-only. If repair is needed, you should run
a second Check pass, setting the *Options* to *--repair*; this will permit *btrfs check* to fix the file system.
After starting a Check, you should Refresh to monitor progress and status. Depending on
how large the file system is, and what errors might be present, the operation can take **a long time** to finish (hours).
Not much info is printed in the window, but you can verify the operation is running by observing the read/write counters
increasing for the device on the Main page.
:end
:info_check_cancel_help:
**Cancel** will cancel the Check operation in progress.
:end
:info_reiserfs_check_help:
**Check** will run the *reiserfsck* program to check file system integrity on the device.
The *Options* field may be filled in with specific options used to fix problems in the file system. Typically, you
first run a Check pass leaving *Options* blank. Upon completion, if *reiserfsck* finds any problems, you must
run a second Check pass, using a specific option as instructed by the first *reiserfsck* pass.
After starting a Check you should Refresh to monitor progress and status. Depending on
how large the file system is, and what errors might be present, the operation can take **a long time** to finish (hours).
Not much info is printed in the window, but you can verify the operation is running by observing the read/write counters
increasing for the device on the Main page.
:end
:info_reiserfs_cancel_help:
**Cancel** will cancel the Check operation in progress.
:end
:info_xfs_check_help:
**Check** will run the *xfs_repair* program to check file system integrity on the device.
The *Options* field is initialized with *-n* which specifies check-only. If repair is needed, you should run
a second Check pass, setting the *Options* blank; this will permit *xfs_repair* to fix the file system.
After starting a Check, you should Refresh to monitor progress and status. Depending on
how large the file system is, and what errors might be present, the operation can take **a long time** to finish (hours).
Not much info is printed in the window, but you can verify the operation is running by observing the read/write counters
increasing for the device on the Main page.
:end
:info_xfs_cancel_help:
**Cancel** will cancel the Check operation in progress.
:end
:info_smart_notifications_help:
SMART notifications are generated on either an increasing RAW value of the attribute, or a decreasing NORMALIZED value which reaches a predefined threshold set by the manufacturer.
Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings).
:end
:info_tolerance_level_help:
A tolerance level may be given to prevent that small changes result in a notification. Setting a too high tolerance level may result in critical changes without a notification.
Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings).
:end
:info_controller_type_help:
By default automatic controller selection is done by smartctl to read the SMART information. Certain controllers however need specific settings for smartctl to work.
Use this setting to select your controller type and fill-in the specific disk index and device name for your situation. Use the manufacturer's documentation to find the relevant information.
Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings).
:end
:info_attribute_notifications_help:
The user can enable or disable notifications for the given SMART attributes. It is recommended to keep the default, which is ALL selected attributes,
when certain attributes are not present on your hard disk or do not provide the correct information, these may be excluded.
In addition custom SMART attributes can be entered to generate notifications. Be careful in this selection,
it may cause an avalance of notifcations if inappropriate SMART attributes are chosen.
Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings).
:end
:selftest_history_help:
Press **Show** to view the self-test history as is kept on the disk itself.
This feature is only available when the disk is in active mode.
:end
:selftest_error_log_help:
Press **Show** to view the error report as is kept on the disk itself.
This feature is only available when the disk is in active mode.
:end
:selftest_short_test_help:
Starts a *short* SMART self-test, the estimated duration can be viewed under the *Capabilities* section. This is usually a few minutes.
When the disk is spun down, it will abort any running self-test.
This feature is only available when the disk is in active mode.
:end
:selftest_long_test_help:
Starts an *extended* SMART self-test, the estimated duration can be viewed under the *Capabilities* section. This is usually several hours.
When the disk is spun down, it will abort any running self-test. It is advised to disable the spin down timer of the disk
to avoid interruption of this self-test.
This feature is only available when the disk is in active mode.
:end
:selftest_result_help:
When no test is running it will show here the latest obtained self-test result (if available).
Otherwise a progress indicator (percentage value) is shown for a running test.
:end
:smart_attributes_help:
This list shows the SMART attributes supported by this disk. For more information about each SMART attribute, it is recommended to search online.
Attributes in *orange* may require your attention. They have a **raw value** greater than zero and may indicate a pending disk failure.
Special attention is required when the particular attribute raw value starts to increase over time. When in doubt, consult the Limetech forum for advice.
:end
:smart_capabilities_help:
This list shows the SMART capabilities supported by this disk.
Observe here the estimated duration of the SMART short and extended self-tests.
:end
:smart_identity_help:
This list shows the SMART identity information of this disk
:end
:open_devices_help:
These are devices installed in your server but not assigned to either the parity-protected
array or the cache disk/pool.
:end
:flash_backup_help:
Use *Flash backup* to create a single zip file of the current contents of the flash device and store it locally on your computer.
:end
:syslinux_cfg_help:
Use this page to make changes to your `syslinux.cfg` file.
You will need to reboot your server for these changes to take effect.
:end
:syslinux_button_help:
Click the **Default** button to initialize the edit box with the
factory-default contents. You still need to click **Apply** in order to
commit the change.
Click the **Apply** button to commit the current edits. Click **Reset** to
undo any changes you make (before Saving). Click **Done** to exit this page.
:end
:info_share_assignment_help:
The selected pool is available for user shares.
:end
:info_free_space_help:
This defines a "floor" for the amount of free space remaining in the volume.
If the free space becomes less than this value, then new files written via user shares will fail with "not enough space" error.
Enter a numeric value with one of these suffixes:
**KB** = 1,000<br>
**MB** = 1,000,000<br>
**GB** = 1,000,000,000<br>
**TB** = 1,000,000,000,000<br>
**K** = 1,024 (ie, 2^10)<br>
**M** = 1,048,576 (ie, 2^20)<br>
**G** = 1,073,741,824 (ie, 2^30)<br>
**T** = 1,099,511,627,776 (ie, 2^40)<br>
If no suffix, a count of 1024-byte blocks is assumed.
:end
:share_list_help:
**Colored Status Indicator** -- the significance of the color indicator at the beginning of each line in *User Shares* is as follows:
<i class='fa fa-circle orb green-orb'></i>All files are on protected storage.
<i class='fa fa-warning orb yellow-orb'></i>Some or all files are on unprotected storage.
**Security modes:**
+ '-' -- user share is not exported and unavailable on the network
+ *Public* -- all users including guests have full read/write access (open access)
+ *Secure* -- all users including guests have read access, write access is set per user (limited access)
+ *Private* -- no guest access at all, read/write or read-only access is set per user (closed access)
**Special modes:**
+ SMB security mode displayed in *italics* indicates exported hidden user shares.
+ NFS does not have special modes for user shares.
:end
:disk_list_help:
**Colored Status Indicator** -- the significance of the color indicator at the beginning of each line in *Disk Shares* is as follows:
<i class='fa fa-circle orb green-orb'></i>Mounted, underlying device has redundancy/protection.
<i class='fa fa-warning orb yellow-orb'></i>Mounted, underlying device does not have redundancy/protection.
**Security modes:**
+ '-' -- disk share is not exported and unavailable on the network
+ *Public* -- all users including guests have full read/write access (open access)
+ *Secure* -- all users including guests have read access, write access is set per user (limited access)
+ *Private* -- no guest access at all, read/write or read-only access is set per user (closed access)
**Special modes:**
+ SMB security mode displayed in *italics* indicates exported hidden disk shares.
+ NFS does not have special modes for disk shares.
:end
:share_edit_global1_help:
A *Share*, also called a *User Share*, is simply the name of a top-level directory that exists on one or more of your
storage devices (array and cache). Each share can be exported for network access. When browsing a share, we return the
composite view of all files and subdirectories for which that top-level directory exists on each storage device.
*Read settings from* is used to preset the settings of the new share with the settings of an existing share.
Select the desired share name and press **Read** to copy the settings from the selected source.
:end
:share_edit_global2_help:
*Write settings to* is used to copy the settings of the current share to one or more other existing shares.
Select the desired destinations and press **Write** to copy the settings to the selected shares.
:end
:share_edit_name_help:
The share name can be up to 40 characters, and is case-sensitive with these restrictions:
* cannot contain a double-quote character (") or the following characters: / \ * < > |
* cannot be one of the reserved share names: flash, cache, cache2, .., disk1, disk2, ..
We highly recommend to make your life easier and avoid special characters.
:end
:share_edit_comments_help:
Anything you like, up to 256 characters.
:end
:share_edit_allocation_method_help:
This setting determines how Unraid OS will choose which disk to use when creating a new file or directory:
**High-water**
Choose the lowest numbered disk with free space still above the current *high water mark*. The
*high water mark* is initialized with the size of the largest data disk divided by 2. If no disk
has free space above the current *high water mark*, divide the *high water mark* by 2 and choose again.
The goal of **High-water** is to write as much data as possible to each disk (in order to minimize
how often disks need to be spun up), while at the same time, try to keep the same amount of free space on
each disk (in order to distribute data evenly across the array).
**Fill-up**
Choose the lowest numbered disk that still has free space above the current **Minimum free space**
setting.
**Most-free**
Choose the disk that currently has the most free space.
:end
:share_edit_free_space_help:
The *minimum free space* available to allow writing to any disk belonging to the share.<br>
Choose a value which is equal or greater than the biggest single file size you intend to copy to the share.
Include units KB, MB, GB and TB as appropriate, e.g. 10MB.
:end
:share_edit_split_level_help:
Determines whether a directory is allowed to expand onto multiple disks.
**Automatically split any directory as required**
When a new file or subdirectory needs to be created in a share, Unraid OS first chooses which disk
it should be created on, according to the configured *Allocation method*. If the parent directory containing
the new file or subdirectory does not exist on this disk, then Unraid OS will first create all necessary
parent directories, and then create the new file or subdirectory.
**Automatically split only the top level directory as required**
When a new file or subdirectory is being created in the first level subdirectory of a share, if that first
level subdirectory does not exist on the disk being written, then the subdirectory will be created first.
If a new file or subdirectory is being created in the second or lower level subdirectory of a share, the new
file or subdirectory is created on the same disk as the new file or subdirectory's parent directory.
**Automatically split only the top "N" level directories as required**
Similar to previous: when a new file or subdirectory is being created, if the parent directory is at level "N",
and does not exist on the chosen disk, Unraid OS will first create all necessary parent directories. If the
parent directory of the new file or subdirectory is beyond level "N", then the new file or subdirectory is
created on the same disk where the parent directory exists.
**Manual: do not automatically split directories**
When a new file or subdirectory needs to be created in a share, Unraid OS will only consider disks where the
parent directory already exists.
:end
:share_edit_included_disks_help:
Specify the disks which can be used by the share. By default all disks are included; that is, if specific
disks are not selected here, then the share may expand into *all* array disks.
:end
:share_edit_excluded_disks_help:
Specify the disks which can *not* be used by the share. By default no disks are excluded.
:end
:share_edit_cache_pool_help:
Specify whether new files and directories written on the share can be written onto the Cache disk/pool if present.
This setting also affects *mover* behavior.
**No** prohibits new files and subdirectories from being written onto the Cache disk/pool.
*Mover* will take no action so any existing files for this share that are on the cache are left there.
**Yes** indicates that all new files and subdirectories should be written to the Cache disk/pool, provided
enough free space exists on the Cache disk/pool.
If there is insufficient space on the Cache disk/pool, then new files and directories are created on the array.
When the *mover* is invoked, files and subdirectories are transferred off the Cache disk/pool and onto the array.
**Only** indicates that all new files and subdirectories must be written to the Cache disk/pool.
If there is insufficient free space on the Cache disk/pool, *create* operations will fail with *out of space* status.
*Mover* will take no action so any existing files for this share that are on the array are left there.
**Prefer** indicates that all new files and subdirectories should be written to the Cache disk/pool, provided
enough free space exists on the Cache disk/pool.
If there is insufficient space on the Cache disk/pool, then new files and directories are created on the array.
When the *mover* is invoked, files and subdirectories are transferred off the array and onto the Cache disk/pool.
**NOTE:** Mover will never move any files that are currently in use.
This means if you want to move files associated with system services such as Docker or VMs then you need to
disable these services while mover is running.
:end
:share_edit_copy_on_write_help:
Set to **No** to cause the *btrfs* NOCOW (No Copy-on-Write) attribute to be set on the share directory
when created on a device formatted with *btrfs* file system. Once set, newly created files and
subdirectories on the device will inherit the NOCOW attribute. We recommend this setting for shares
used to store vdisk images, including the Docker loopback image file. This setting has no effect
on non-btrfs file systems.
Set to **Auto** for normal operation, meaning COW **will** be in effect on devices formatted with *btrfs*.
:end
:share_edit_status_help:
Share does *not* contain any data and may be deleted if not needed any longer.
:end
:share_edit_delete_help:
Share can *not* be deleted as long as it contains data. Be aware that some data can be hidden. See also [SMB Settings](/Settings/SMB) -> Hide "dot" files.
:end
:smb_security_help:
*Read settings from* is used to preset the SMB security settings of the current selected share with the settings of an existing share.
Select the desired share name and press **Read** to copy the SMB security settings from the selected source.
*Write settings to* is used to copy the SMB security settings of the current selected share to one or more other existing shares.
Select the desired destinations and press **Write** to copy the SMB security settings to the selected shares.
:end
:smb_export_help:
This setting determines whether the share is visible and/or accessible. The 'Yes (hidden)' setting
will *hide* the share from *browsing* but is still accessible if you know the share name.
:end
:smb_time_machine_volume_help:
This limits the reported volume size, preventing Time Machine from using the entire real disk space
for backup. For example, setting this value to "1024" would limit the reported disk space to 1GB.
:end
:smb_case_sensitive_names_help:
Controls whether filenames are case-sensitive.
The default setting of **auto** allows clients that support case sensitive filenames (Linux CIFSVFS)
to tell the Samba server on a per-packet basis that they wish to access the file system in a case-sensitive manner (to support UNIX
case sensitive semantics). No Windows system supports case-sensitive filenames so setting this option to **auto** is the same as
setting it to No for them; however, the case of filenames passed by a Windows client will be preserved. This setting can result
in reduced performance with very large directories because Samba must do a filename search and match on passed names.
A setting of **Yes** means that files are created with the case that the client passes, and only accessible using this same case.
This will speed very large directory access, but some Windows applications may not function properly with this setting. For
example, if "MyFile" is created but a Windows app attempts to open "MYFILE" (which is permitted in Windows), it will not be found.
A value of **Forced lower** is special: the case of all incoming client filenames, not just new filenames, will be set to lower-case.
In other words, no matter what mixed case name is created on the Windows side, it will be stored and accessed in all lower-case. This
ensures all Windows apps will properly find any file regardless of case, but case will not be preserved in folder listings.
Note this setting should only be configured for new shares.
:end
:smb_security_modes_help:
Summary of security modes:
**Public** All users including guests have full read/write access.
**Secure** All users including guests have read access, you select which of your users have write access.
**Private** No guest access at all, you select which of your users have read/write, read-only access or no access.
:end
:smb_secure_access_help:
*Read settings from* is used to preset the SMB User Access settings of the current selected share with the settings of an existing share.
Select the desired share name and press **Read** to copy the SMB security settings from the selected source.
*Write settings to* is used to copy the SMB User Access settings of the current share to one or more other existing shares.
Select the desired destinations and press **Write** to copy the SMB User access settings to the selected shares.
:end
:smb_private_access_help:
*Read settings from* is used to preset the SMB User Access settings of the current selected share with the settings of an existing share.
Select the desired share name and press **Read** to copy the SMB security settings from the selected source.
*Write settings to* is used to copy the SMB User Access settings of the current share to one or more other existing shares.
Select the desired destinations and press **Write** to copy the SMB User access settings to the selected shares.
:end
:nfs_security_help:
*Read settings from* is used to preset the NFS security settings of the current selected share with the settings of an existing share.
Select the desired share name and press **Read** to copy the NFS security settings from the selected source.
*Write settings to* is used to copy the NFS security settings of the current selected share to one or more other existing shares.
Select the desired destinations and press **Write** to copy the NFS security settings to the selected shares.
:end
:user_add_username_help:
Usernames may be up to 40 characters long and must start with a **lower case letter** or an underscore,
followed by **lower case letters**, digits, underscores, or dashes. They can end with a dollar sign.
:end
:user_add_description_help:
Up to 64 characters. The characters ampersand (&) quote (") and colon (:) are not allowed.
:end
:user_add_custom_image_help:
The image will be scaled to 48x48 pixels in size. The maximum image file upload size is 95 kB (97,280 bytes).
:end
:user_password_help:
Up to 128 characters.
:end
:user_edit_description_help:
Up to 64 characters. The characters ampersand (&) quote (") and colon (:) are not allowed.
:end
:user_edit_custom_image_help:
The image will be scaled to 48x48 pixels in size. The maximum image file upload size is 512 kB (524,288 bytes).
:end
:cpu_vms_help:
This page gives a total view of the current CPU pinning assignments for VMs.<br>
It also allows to modify these assignments.
Running VMs are **stopped first** and restarted after the modification.<br>
Stopped VMs are instantly modified and new assignments become active when the VM is started.
When ***Apply*** is pressed a scan is performed to find the changes, subsequently only VMs which have changes are modified in parallel.
*Important: Please wait until all updates are finished before leaving this page*.
:end
:cpu_pinning_help:
This page gives a total view of the current CPU pinning assignments for Docker containers.<br>
It also allows to modify these assignments.
Running containers are **stopped first** and restarted after the modification.<br>
Stopped containers are instantly modified and new assignments become active when the user manually starts the container.
When ***Apply*** is pressed a scan is performed to find the changes, subsequently containers which have changes are modified in parallel.
*Important: Please wait until all updates are finished before leaving this page*.
By default NO cores are selected for a Docker container, which means it uses all available cores.<br>
Do not select **ALL** cores for containers, just select **NO** cores if you want unrestricted core use.
Do not select cores for containers which are *isolated*.
By design a container will only use a single core (the lowest numbered core) when multiple isolated cores are selected.<br>
Usually this is not what a user wants when selecting multiple cores.
:end
:cpu_isolation_help:
CPU isolation allows the user to specify CPU cores that are to be explicitly reserved for assignment (to VMs or Docker containers).
This is incredibly important for gaming VMs to run smoothly because even if you manually pin your Docker containers to not overlap with your gaming VM,
the host OS can still utilize those same cores as the guest VM needs for things like returning responses for the webGui, running a parity check, btrfs operations, etc.
:end
:timezone_help:
Select your applicable time zone from the drop-down list.
:end
:use_ntp_help:
Select 'Yes' to use Network Time Protocol to keep your server time accurate.
We **highly** recommend the use of a network time server, especially if you plan on using Active Directory.
Note: if using `pool.ntp.org` time servers, please also refer to [their documentation](http://www.pool.ntp.org/en/use.html).
:end
:ntp_server1_help:
This is the primary NTP server to use. Enter a FQDN or an IP address.
:end
:ntp_server2_help:
This is the alternate NTP server to use if NTP Server 1 is down.
:end
:ntp_server3_help:
This is the alternate NTP Server to use if NTP Servers 1 and 2 are both down.
:end
:ntp_server4_help:
This is the alternate NTP Server to use if NTP Servers 1, 2, and 3 are all down.
:end
:current_time_help:
Enter the current time-of-day. Use format YYYY-MM-DD HH:MM:SS. Greyed out when using NTP.
:end
:disk_enable_autostart_help:
If set to 'Yes' then if the device configuration is correct upon server start-up,
the array will be automatically Started and shares exported.<br>
If set to 'No' then you must Start the array yourself.
:end
:disk_spindown_delay_help:
This setting defines the 'default' time-out for spinning hard drives down after a period
of no I/O activity. You may override the default value for an individual disk on the Disk Settings
page for that disk.
:end
:disk_spinup_groups_help:
If set to 'Yes' then the [Spinup Groups](/Help) feature is enabled.
:end
:disk_default_partition_format_help:
Defines the type of partition layout to create when formatting hard drives 2TB in size and
smaller **only**. (All devices larger than 2TB are always set up with GPT partition tables.)
**MBR: unaligned** setting will create MBR-style partition table, where the single
partition 1 will start in the **63rd sector** from the start of the disk. This is the *traditional*
setting for virtually all MBR-style partition tables.
**MBR: 4K-aligned** setting will create an MBR-style partition table, where the single
partition 1 will start in the **64th sector** from the start of the disk. Since the sector size is 512 bytes,
this will *align* the start of partition 1 on a 4K-byte boundary. This is required for proper
support of so-called *Advanced Format* drives.
Unless you have a specific requirement do not change this setting from the default **MBR: 4K-aligned**.
:end
:disk_default_file_system_help:
Defines the default file system type to create when an *unmountable* array device is formatted.
The default file system type for a single or multi-device cache is always Btrfs.
:end
:disk_shutdown_timeout_help:
When shutting down the server, this defines how long to wait in seconds for *graceful* shutdown before forcing
shutdown to continue.
:end
:disk_tunable_poll_attributes_help:
This defines the disk SMART polling interval, in seconds. A value of 0 disables SMART polling (not recommended).
:end
:disk_tunable_enable_ncq_help:
If set to **No** then *Native Command Queuing* is disabled for all array devices that support NCQ.
**Auto** leaves the setting for each device as-is.
Note: You must reboot after selecting Auto for setting to take effect.
:end
:disk_tunable_nr_requests_help:
This defines the `nr_requests` device driver setting for all array devices.
**Auto** leaves the setting for each device as-is.
Note: if you set to blank and click Apply, the setting is restored to its default, and you must reboot for setting to take effect.
:end
:disk_tunable_scheduler_help:
Selects which kernel I/O scheduler to use for all array devices.
**Auto** leaves the setting for each device as-is (mq-deadline).
Note: You must reboot after selecting Auto for setting to take effect.
:end
:disk_tunable_md_num_stripes_help:
This is the size of the *stripe pool* in number of *stripes*. A *stripe* refers to a data structure that facilitates parallel 4K read/write
operations necessary for a parity-protected array.
Note: if you set to blank and click Apply, the setting is restored to its default, and will take effect after reboot.
:end
:disk_tunable_md_queue_limit_help:
This is a number in [1..100] which is the maximum steady-load percentage of the stripe pool permitted to be in use.
Note: if you set to blank and click Apply, the setting is restored to its default.
:end
:disk_tunable_md_sync_limit_help:
This is a number in [0..100] which is the maximum percentage of the stripe pool allocated for parity sync/check in the presence of other I/O.
Note: if you set to blank and click Apply, the setting is restored to its default.
:end
:disk_tunable_md_write_method_help:
Selects the method to employ when writing to enabled disk in parity protected array.
*Auto* selects `read/modify/write`.
:end
:disk_default_warning_utilization_help:
*Warning disk utilization* sets the default warning threshold for all hard disks utilization. Exceeding this threshold will result in a warning notification.
When the warning threshold is set equal or greater than the critical threshold, there will be only critical notifications (warnings are not existing).
A value of zero will disable the warning threshold (including notifications).
:end
:disk_default_critical_utilization_help:
*Critical disk utilization* sets the default critical threshold for all hard disks utilization. Exceeding this threshold will result in an alert notification.
A value of zero will disable the critical threshold (including notifications).
:end
:disk_default_warning_temperature_help:
*Warning disk temperature* sets the default warning threshold for all hard disks temperature. Exceeding this threshold will result in a warning notification.
A value of zero will disable the warning threshold (including notifications).
:end
:disk_default_critical_temperature_help:
*Critical disk temperature* sets the default critical threshold for all hard disks temperature. Exceeding this threshold will result in an alert notification.
A value of zero will disable the critical threshold (including notifications).
:end
:disk_default_smart_notification_help:
SMART notifications are generated on either an increasing RAW value of the attribute, or a decreasing NORMALIZED value which reaches a predefined threshold set by the manufacturer.
This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks.
:end
:disk_default_smart_tolerance_help:
A tolerance level may be given to prevent that small changes result in a notification. Setting a too high tolerance level may result in critical changes without a notification.
This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks.
:end
:disk_default_smart_controller_help:
By default automatic controller selection is done by smartctl to read the SMART information. Certain controllers however need specific settings for smartctl to work.
Use this setting to select your controller type and fill-in the specific disk index and device name for your situation. Use the manufacturer's documentation to find the relevant information.
This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks.
:end
:disk_default_smart_attribute_help:
The user can enable or disable notifications for the given SMART attributes. It is recommended to keep the default, which is ALL selected attributes,
when certain attributes are not present on your hard disk or do not provide the correct information, these may be excluded.
In addition custom SMART attributes can be entered to generate notifications. Be careful in this selection,
it may cause an avalance of notifcations if inappropriate SMART attributes are chosen.
This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks.
:end
:docker_repositories_help:
Use this field to add template repositories.
Docker templates are used to facilitate the creation and re-creation of Docker containers. Please setup one per line.
For a list of popular community-supported repositories, visit here: <a href="http://lime-technology.com/forum/index.php?topic=37958.0" target="_blank">http://lime-technology.com/forum/index.php?topic=37958.0</a>
:end
:docker_enable_help:
Before you can start the Docker service for the first time, please specify an image file for Docker to install to.
Once started, Docker will always automatically start after the array has been started.
:end
:docker_timeout_help:
The time in seconds to allow a container to gracefully stop before forcing it to stop
:end
:docker_vdisk_type_help:
Select where to keep the Docker persistent state.
This can be an image file with a specific size or a dedicated folder.
:end
:docker_vdisk_size_help:
If the system needs to create a new docker image file, this is the default size to use specified in GB.
To resize an existing image file, specify the new size here. Next time the Docker service is started the file (and file system) will be increased to the new size (but never decreased).
:end
:docker_vdisk_location_help:
You must specify an image file for Docker. The system will automatically create this file when the Docker service is first started.
The image file name must have the extension .img, If not the input is not accepted and marked red.
It is recommended to create this image file outside the array, e.g. on the Cache pool. For best performance SSD devices are preferred.
:end
:docker_vdisk_directory_help:
You must specify a folder for Docker. The system will automatically create this folder when the Docker service is first started.
It is recommended to create this folder under a share which resides on the Cache pool (setting: cache=Only). For best performance SSD devices are preferred.
:end
:docker_appdata_location_help:
You can specify a folder to automatically generate and store subfolders containing configuration files for each Docker app (via the /config mapped volume).
The folder's path must end with a trailing slash (/) character. If not the input is not accepted and marked red.
It is recommended to create this folder outside the array, e.g. on the Cache pool. For best performance SSD devices are preferred.
Only used when adding new Docker apps. Editing existing Docker apps will not be affected by this setting.
:end