Skip to content

Commit

Permalink
docs: update json files due to changed directive comments
Browse files Browse the repository at this point in the history
- updated comments for user ACLs
- removed unused Run_ACL, refer to commit a6dd4ff
  for details
- updated docs
- rebuilt json files
  • Loading branch information
franku committed Sep 5, 2019
1 parent bba92c1 commit a561e67
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 148 deletions.
4 changes: 2 additions & 2 deletions core/src/dird/dird_conf.cc
Expand Up @@ -168,7 +168,6 @@ static ResourceItem dir_items[] = {
"Lists the Storage resources, this resource has access to. The special keyword *all* allows access to all Storage resources." },\
{ "ScheduleACL", CFG_TYPE_ACL, ITEM(resource, ACL_lists), Schedule_ACL, 0, NULL, NULL,\
"Lists the Schedule resources, this resource has access to. The special keyword *all* allows access to all Schedule resources." },\
{ "RunACL", CFG_TYPE_ACL, ITEM(resource, ACL_lists), Run_ACL, 0, NULL, NULL, NULL },\
{ "PoolACL", CFG_TYPE_ACL, ITEM(resource, ACL_lists), Pool_ACL, 0, NULL, NULL,\
"Lists the Pool resources, this resource has access to. The special keyword *all* allows access to all Pool resources." },\
{ "CommandACL", CFG_TYPE_ACL, ITEM(resource, ACL_lists), Command_ACL, 0, NULL, NULL,\
Expand Down Expand Up @@ -203,7 +202,8 @@ static ResourceItem con_items[] = {
USER_ACL(res_con, user_acl.ACL_lists),
ACL_PROFILE(res_con),
{ "UsePamAuthentication", CFG_TYPE_BOOL, ITEM(res_con, use_pam_authentication_), 0, CFG_ITEM_DEFAULT,
"false", "18.2.4-", NULL },
"false", "18.2.4-", "If set to yes, PAM will be used to authenticate the user on this console. Otherwise, "
"only the credentials of this console resource are used for authentication." },
TLS_COMMON_CONFIG(res_con),
TLS_CERT_CONFIG(res_con),
{nullptr, 0, 0, nullptr, 0, 0, nullptr, nullptr, nullptr}
Expand Down
1 change: 0 additions & 1 deletion core/src/dird/dird_conf.h
Expand Up @@ -205,7 +205,6 @@ enum
Client_ACL,
Storage_ACL,
Schedule_ACL,
Run_ACL,
Pool_ACL,
Command_ACL,
FileSet_ACL,
Expand Down
3 changes: 0 additions & 3 deletions core/src/dird/ua_audit.cc
Expand Up @@ -83,9 +83,6 @@ static inline void LogAuditEventAclMsg(UaContext* ua,
case Schedule_ACL:
acl_type_name = _("for Schedule");
break;
case Run_ACL:
acl_type_name = _("for Schedule");
break;
case Pool_ACL:
acl_type_name = _("for Pool");
break;
Expand Down
23 changes: 22 additions & 1 deletion docs/manuals/source/Configuration/Director.rst
Expand Up @@ -2089,12 +2089,33 @@ The Console resource is optional and need not be specified. The following direct

The example at :ref:`section-ConsoleAccessExample` shows how to use a console resource for a connection from a client like :command:`bconsole`.

.. _DirectorResourceUser:

User Resource
-------------

:index:`\ <single: User Resource>`
:index:`\ <single: User>`

Each user who wants to login using PAM needs a dedicated User Resource in the |dir| configuration. The main purpose is to configure ACLs as shown in the table below, they are the same as in the :ref:`DirectorResourceConsole` and the :ref:`DirectorResourceProfile`.

If a user is authenticated with PAM but is not authorized by a user resource, the login will be denied by the |dir|.

Refer to chapter :ref:`PAMConfigurationChapter` for details how to configure PAM.

The following table contains all configurable directives in the User Resource:

.. include:: /include/autogenerated/bareos-dir-resource-user-table.rst.inc

.. include:: /include/autogenerated/bareos-dir-resource-user-description.rst.inc


.. _DirectorResourceProfile:

Profile Resource
----------------

:index:`\ <single: Profile Resource>`\ :index:`\ <single: Resource; Profile>`\
:index:`\ <single: Profile Resource>`\ :index:`\ <single: Resource; Profile>`\

The Profile Resource defines a set of ACLs. :ref:`DirectorResourceConsole` can be tight to one or more profiles (:config:option:`dir/console/Profile`\ ), making it easier to use a common set of ACLs.

Expand Down

0 comments on commit a561e67

Please sign in to comment.