Skip to content

Commit a383edb

Browse files
authored
Merge pull request #1782 from freenas/nas-106099-angulargui
DOCS-106099 host allow and deny doc improvement.
2 parents f2154c6 + 6494b56 commit a383edb

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

userguide/sharing.rst

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,16 +203,31 @@ information given when the share was created.
203203
| | | | |
204204
+------------------------------+---------------+----------+---------------------------------------------------------------------------------------------------------------+
205205
| Hosts Allow | string || Enter a list of allowed hostnames or IP addresses. Separate entries with a comma, space, or tab. |
206-
| | | | |
206+
| | | | Please see the :ref:`note <afp allow/deny note>` for more information. |
207207
+------------------------------+---------------+----------+---------------------------------------------------------------------------------------------------------------+
208208
| Hosts Deny | string || Enter a list of denied hostnames or IP addresses. Separate entries with a comma, space, or tab. |
209-
| | | | |
209+
| | | | Please see the :ref:`note <afp allow/deny note>` for more information. |
210210
+------------------------------+---------------+----------+---------------------------------------------------------------------------------------------------------------+
211211
| Auxiliary Parameters | string || Enter any additional `afp.conf <https://www.freebsd.org/cgi/man.cgi?query=afp.conf>`__ parameters |
212212
| | | | not covered by other option fields. |
213213
| | | | |
214214
+------------------------------+---------------+----------+---------------------------------------------------------------------------------------------------------------+
215215

216+
.. note::
217+
:name: afp allow/deny note
218+
219+
If neither *Hosts Allow* or *Hosts Deny* contains an entry, then AFP share
220+
access is allowed for any host.
221+
222+
If there is a *Hosts Allow* list but no *Hosts Deny* list, then only allow
223+
hosts on the *Hosts Allow* list.
224+
225+
If there is a *Hosts Deny* list but no *Hosts Allow* list, then allow all
226+
hosts that are not on the *Hosts Deny* list.
227+
228+
If there is both a *Hosts Allow* and *Hosts Deny* list, then allow all hosts
229+
that are on the *Hosts Allow* list. If there is a host not on the
230+
*Hosts Allow* and not on the *Hosts Deny* list, then allow it.
216231

217232
.. _Creating AFP Guest Shares:
218233

@@ -1866,9 +1881,11 @@ provides more details about each option.
18661881
| | | | permissions. See `smb.conf(5) <https://www.freebsd.org/cgi/man.cgi?query=smb.conf>`__. |
18671882
+--------------------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
18681883
| Hosts Allow | string || Enter a list of allowed hostnames or IP addresses. Separate entries with a comma (:literal:`,`), space, or tab. |
1884+
| | | | Please see the :ref:`note <smb allow/deny note>` for more information. |
18691885
+--------------------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
18701886
| Hosts Deny | string || Enter a list of denied hostnames or IP addresses. Specify :literal:`ALL` and list any hosts from :guilabel:`Hosts Allow` to have those hosts take |
18711887
| | | | precedence. Separate entries with a comma (:literal:`,`), space, or tab. |
1888+
| | | | Please see the :ref:`note <smb allow/deny note>` for more information. |
18721889
+--------------------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
18731890
| Use as Home Share | checkbox || Set to allow this share to hold user home directories. Only one share can be the home share. Note that lower case names for user home directories |
18741891
| | | | are strongly recommended, as Samba maps usernames to all lower case. For example, the username John will be mapped to a home directory named |
@@ -1910,6 +1927,22 @@ provides more details about each option.
19101927
| Auxiliary Parameters | string || Additional `smb.conf <https://www.freebsd.org/cgi/man.cgi?query=smb.conf>`__ parameters. |
19111928
+--------------------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
19121929

1930+
.. note::
1931+
:name: smb allow/deny note
1932+
1933+
If neither *Hosts Allow* or *Hosts Deny* contains an entry, then SMB share
1934+
access is allowed for any host.
1935+
1936+
If there is a *Hosts Allow* list but no *Hosts Deny* list, then only allow
1937+
hosts on the *Hosts Allow* list.
1938+
1939+
If there is a *Hosts Deny* list but no *Hosts Allow* list, then allow all
1940+
hosts that are not on the *Hosts Deny* list.
1941+
1942+
If there is both a *Hosts Allow* and *Hosts Deny* list, then allow all hosts
1943+
that are on the *Hosts Allow* list. If there is a host not on the
1944+
*Hosts Allow* and not on the *Hosts Deny* list, then allow it.
1945+
19131946

19141947
Here are some notes about :guilabel:`ADVANCED MODE` settings:
19151948

0 commit comments

Comments
 (0)