ich777/lang-de_DE
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Consolidated all help text in a single file

Browse Source
This commit is contained in:
bergware
2020-05-09 09:29:53 +02:00
parent 34b29b5df2
commit e54bded277
7 changed files with 2052 additions and 2157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
docker.txt
View File

@@ -126,93 +126,4 @@ wait=
Was this container created using this plugin=
Web=
WebUI=
Writable=
:help1
> Templates are a quicker way to setting up Docker Containers on your Unraid server. There are two types of templates:
>
> **Default templates**<br>
> When valid repositories are added to your Docker Repositories page, they will appear in a section on this drop down for you to choose (master categorized by author, then by application template).
> After selecting a default template, the page will populate with new information about the application in the Description field, and will typically provide instructions for how to setup the container.
> Select a default template when it is the first time you are configuring this application.
>
> **User-defined templates**<br>
> Once you've added an application to your system through a Default template,
> the settings you specified are saved to your USB flash device to make it easy to rebuild your applications in the event an upgrade were to fail or if another issue occurred.
> To rebuild, simply select the previously loaded application from the User-defined list and all the settings for the container will appear populated from your previous setup.
> Clicking create will redownload the necessary files for the application and should restore you to a working state.
> To delete a User-defined template, select it from the list above and click the red X to the right of it.
:end
:help2
> Give the container a name or leave it as default.
:end
:help3
> A description for the application container. Supports basic HTML mark-up.
:end
:help4
> The repository for the application on the Docker Registry. Format of authorname/appname.
> Optionally you can add a : after appname and request a specific version for the container image.
:end
:help5
> Link to a support thread on Lime-Technology's forum.
:end
:help6
> Link to the project page (eg: www.plex.tv)
:end
:help7
> Text to appear on Donation Links Within The Apps Tab
:end
:help8
> Link to the donation page. If using donation's, both the image and link must be set
:end
:help9
> The path to the container's repository location on the Docker Hub.
:end
:help10
> This URL is used to keep the template updated.
:end
:help11
> Link to the icon image for your application (only displayed on dashboard if Show Dashboard apps under Display Settings is set to Icons).
:end
:help12
> When you click on an application icon from the Docker Containers page, the WebUI option will link to the path in this field.
> Use [IP] to identify the IP of your host and [PORT:####] replacing the #'s for your port.
:end
:help13
> If you wish to append additional commands to your Docker container at run-time, you can specify them here.<br>
> For all possible Docker run-time commands, see here: <a href="https://docs.docker.com/reference/run/" target="_blank">https://docs.docker.com/reference/run/</a>
:end
:help14
> If you wish to append additional arguments AFTER the container definition, you can specify them here.
> The content of this field is container specific.
:end
:help15
> Checking a CPU core(s) will limit the container to run on the selected cores only. Selecting no cores lets the container run on all available cores (default)
:end
:help16
> If the Bridge type is selected, the application’s network access will be restricted to only communicating on the ports specified in the port mappings section.
> If the Host type is selected, the application will be given access to communicate using any port on the host that isn’t already mapped to another in-use application/service.
> Generally speaking, it is recommended to leave this setting to its default value as specified per application template.
>
> IMPORTANT NOTE: If adjusting port mappings, do not modify the settings for the Container port as only the Host port can be adjusted.
:end
:help17
> For containers that require the use of host-device access directly or need full exposure to host capabilities, this option will need to be selected.
> For more information, see this link: <a href="https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities" target="_blank">https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities</a>
:end
Writable=

2046
helptext.txt Normal file
View File

File diff suppressed because it is too large Load Diff

447
main.txt
View File

@@ -287,449 +287,4 @@ Writes=
Wrong key=
xfs_repair status=
You may not add new disks and also remove existing disks=
your server=
:help1
> **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
:help2
> **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
:help3
> **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
:help4
> **Slots** select the number of device slots in your server designated for Cache devices.
:end
:help5
> 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
:help6
> **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
:help7
> #### 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 singe 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 recored 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
:help8
> #### 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
:help9
> *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
:help10
> *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
:help11
> 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
:help12
> This text will appear under the *Comments* column for the share in Windows Explorer.
> Enter anything you like, up to 256 characters.
:end
:help13
> *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
:help14
> *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
:help15
> **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 perfomred, 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
:help16
> **Cancel** will cancel the balance operation in progress.
:end
:help17
> **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
:help18
> **Cancel** will cancel the Scrub operation in progress.
:end
:help19
> **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
:help20
> **Cancel** will cancel the Check operation in progress.
:end
:help21
> **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
:help22
> **Cancel** will cancel the Check operation in progress.
:end
:help23
> **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
:help24
> **Cancel** will cancel the Check operation in progress.
:end
:help25
> 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
:help26
> 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
:help27
> 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
:help28
> 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
:help29
> 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
:help30
> 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
:help31
> 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
:help32
> 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
:help33
> 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
:help34
> 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
:help35
> This list shows the SMART capabilities supported by this disk.
>
> Observe here the estimated duration of the SMART short and extended self-tests.
:end
:help36
> This list shows the SMART identity information of this disk
:end
:help37
> These are devices installed in your server but not assigned to either the parity-protected
> array or the cache disk/pool.
:end
:help38
> 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
:help39
> 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
:help40
> 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
:help41
> 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
your server=

17
plugins.txt
View File

@@ -25,19 +25,4 @@ Support Thread=
Uninstall=
Update All Plugins=
Upgrade=
View Release Notes=
:help1
> To download and install a plugin, enter the plg file URL and click **Install**. A window will open
> that displays install progress. Do not close this window until install has completed. You may also specify
> the local file name of an extension.
:end
:help2
> These plugins were not installed because of some kind of installation error. You should delete these
> plugins and then **reboot** your server.*
:end
:help3
> These plugins were not installed because newer code already exists. It is safe to simply delete these.
:end
View Release Notes=

1238
settings.txt
View File

File diff suppressed because it is too large Load Diff

339
shares.txt
View File

@@ -59,341 +59,4 @@ Unknown encryption state=
Use cache pool for new filesdirectories=Use cache pool (for new files/directories)
User Shares=
Volume dbpath=
You cannot use the following within share names=
:help1
> **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.
> + AFP security mode displayed in *italics* indicates exported time-machine user shares.
> + NFS does not have special modes for user shares.
:end
:help2
> **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.
> + AFP security mode displayed in *italics* indicates exported time-machine disk shares.
> + NFS does not have special modes for disk shares.
:end
:help3
> 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.
<?if ($name):?>
>
> *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.
<?endif;?>
:end
:help4
> 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, cach2, .., disk1, disk2, ..
>
> We highly recommend to make your life easier and avoid special characters.
:end
:help5
> Anything you like, up to 256 characters.
:end
:help6
> 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
:help7
> 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
:help8
> 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 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
:help9
> 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
:help10
> Specify the disks which can *not* be used by the share. By default no disks are excluded.
:end
:help11
> 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 writen 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
:help12
> 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
:help13
> Share does *not* contain any data and may be deleted if not needed any longer.
:end
:help14
> 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
:help15
> *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
:help16
> 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
:help17
> 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
:help18
> 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
:help19
> 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 or
> read-only access.
:end
:help20
> *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
:help21
> *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
:help22
> This section is used to configure the security settings for the share when accessed using AFP and
> appears only when AFP is enabled on the Network Services page.
>
> *Read settings from* is used to preset the AFP 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 AFP security settings from the selected source.
>
> *Write settings to* is used to copy the AFP security settings of the current selected share to one or more other existing shares.
>
> Select the desired destinations and press **Write** to copy the AFP security settings to the selected shares.
:end
:help22
> This section is used to configure the security settings for the share when accessed using AFP and
> appears only when AFP is enabled on the Network Services page.
>
> *Read settings from* is used to preset the AFP 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 AFP security settings from the selected source.
>
> *Write settings to* is used to copy the AFP security settings of the current selected share to one or more other existing shares.
>
> Select the desired destinations and press **Write** to copy the AFP security settings to the selected shares.
:end
:help23
> The Export setting determines whether this share is exported via AFP (Yes or No)
> The Export setting also includes a third option (Yes - Time Machine). This setting enables various
> special options for Time Machine; in particular a "volume size limit". Note: Apple recommends not
> to use the volume for anything but Time Machine due to the way locks are used.
:end
:help24
> 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
:help25
> Sets where to store netatalk database information. A directory with same name as the share will be
> created here.
>
> Leave this field blank to have the database created in the root of the share.
:end
:help26
> The Unraid AFP implementation supports Guest access and fully supports the three security
> modes: Public, Secure, and Private.
> In general, when you click on your server's icon in Finder, you will be asked to log in as Guest or to
> specify a set of login credentials (user name/password). In order to use Secure or Private security on
> a share, you must have a user already defined on the server with appropriate access rights.
>
> Note: netatalk does not permit the user name <tt>root</tt> to be used for log in purposes.
>
> **Public** When logged into the server as Guest, a macOS user can view and read/write all shares set as
> Public. Files created or modified in the share will be owned by user `nobody` of
> the `users` group.<br>
> macOS users logged in with a user name/password previously created on the server can also view
> and read/write all shares set as Public. In this case, files created or modified on the server will
> be owned by the logged in user.
>
> **Secure** When logged into the server as Guest, a macOS user can view and read (but not write) all
> shares set as Secure.<br>
> macOS users logged in with a user name/password previously created on the server can also view and
> read all shares set as Secure. If their access right is set to read/write for the share on the server,
> they may also write the share.
>
> **Private** When logged onto the server as Guest, no Private shares are visible or accessible to any
> macOS user.<br>
> macOS users logged in with a user name/password previously created on the server may read or
> read/write (or have no access) according their access right for the share on the server.
:end
:help27
> *Read settings from* is used to preset the AFP 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 AFP security settings from the selected source.
>
> *Write settings to* is used to copy the AFP User Access settings of the current share to one or more other existing shares.
>
> Select the desired destinations and press **Write** to copy the AFP User access settings to the selected shares.
:end
:help28
> *Read settings from* is used to preset the AFP 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 AFP security settings from the selected source.
>
> *Write settings to* is used to copy the AFP User Access settings of the current share to one or more other existing shares.
>
> Select the desired destinations and press **Write** to copy the AFP User access settings to the selected shares.
:end
:help29
> *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
You cannot use the following within share names=

31
users.txt
View File

@@ -13,33 +13,4 @@ Show Hide password=Show / Hide password
Use a password up to 128 characters=
Use only lowercase letters, digits, underscores and dashes=
User %s has been deleted=
User name=
:help1
> Usernames may be up to 32 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
:help2
> Up to 64 characters. The characters ampersand (&amp;) quote (&quot;) and colon (:) are not allowed.
:end
:help3
> The image will be scaled to 48x48 pixels in size. The maximum image file upload size is 95 kB (97,280 bytes).
:end
:help4
> Up to 128 characters.
:end
:help5
> Up to 64 characters. The characters ampersand (&amp;) quote (&quot;) and colon (:) are not allowed.
:end
:help6
> The image will be scaled to 48x48 pixels in size. The maximum image file upload size is 512 kB (524,288 bytes).
:end
:help7
> Up to 128 characters.
:end
User name=