docs: add manual page for acl.cfg
This commit is contained in:
		
							
								
								
									
										22
									
								
								docs/config/acl/format.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								docs/config/acl/format.rst
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,22 @@
 | 
			
		||||
This file contains the access control list for the Proxmox Backup
 | 
			
		||||
Server API.
 | 
			
		||||
 | 
			
		||||
Each line starts with ``acl:``, followed by 4 additional values
 | 
			
		||||
separated by collon.
 | 
			
		||||
 | 
			
		||||
:propagate: Propagate permissions down the hierachrchy
 | 
			
		||||
 | 
			
		||||
:path: The object path
 | 
			
		||||
 | 
			
		||||
:User/Token: List of users and token
 | 
			
		||||
 | 
			
		||||
:Role: List of assigned roles
 | 
			
		||||
 | 
			
		||||
Here is an example list::
 | 
			
		||||
 | 
			
		||||
   acl:1:/:root@pam!test:Admin
 | 
			
		||||
   acl:1:/datastore/store1:user1@pbs:DatastoreAdmin
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
You can use the ``proxmox-backup-manager acl`` command to manipulate
 | 
			
		||||
this file.
 | 
			
		||||
							
								
								
									
										35
									
								
								docs/config/acl/man5.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								docs/config/acl/man5.rst
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,35 @@
 | 
			
		||||
==========================
 | 
			
		||||
acl.cfg
 | 
			
		||||
==========================
 | 
			
		||||
 | 
			
		||||
.. include:: ../../epilog.rst
 | 
			
		||||
 | 
			
		||||
-------------------------------------------------------------
 | 
			
		||||
Access Control Configuration
 | 
			
		||||
-------------------------------------------------------------
 | 
			
		||||
 | 
			
		||||
:Author: |AUTHOR|
 | 
			
		||||
:Version: Version |VERSION|
 | 
			
		||||
:Manual section: 5
 | 
			
		||||
 | 
			
		||||
Description
 | 
			
		||||
===========
 | 
			
		||||
 | 
			
		||||
The file /etc/proxmox-backup/user.cfg is a configuration file for Proxmox
 | 
			
		||||
Backup Server. It contains the access control configuration for the API.
 | 
			
		||||
 | 
			
		||||
File Format
 | 
			
		||||
===========
 | 
			
		||||
 | 
			
		||||
.. include:: format.rst
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Roles
 | 
			
		||||
=====
 | 
			
		||||
 | 
			
		||||
The following roles exist:
 | 
			
		||||
 | 
			
		||||
.. include:: roles.rst
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
.. include:: ../../pbs-copyright.rst
 | 
			
		||||
		Reference in New Issue
	
	Block a user