user.conf.adoc: add user configuration

diff --git a/gen-user.conf.5-opts.pl b/gen-user.conf.5-opts.pl
new file mode 100755 (executable)
index 0000000..d308bdc
--- /dev/null
+++ b/gen-user.conf.5-opts.pl
@@ -0,0 +1,17 @@
+#!/usr/bin/perl
+
+use lib '.';
+use strict;
+use warnings;
+use PVE::RESTHandler;
+
+use Data::Dumper;
+
+use PMG::UserConfig;
+
+my $schema = $PMG::UserConfig::create_schema;
+my $properties = $schema->{properties};
+    
+print PVE::RESTHandler::dump_properties($properties);
+ 
+exit(0);

diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc
index feeb526c415c64825f6fb1d36bb4cb00c2d8a413..8657b6a08404753ef8bfee894fe124f571dcbf0b 100644 (file)
--- a/pmg-admin-guide.adoc
+++ b/pmg-admin-guide.adoc
@@ -187,6 +187,8 @@ include::pmg.conf.adoc[]
 
 include::cluster.conf.adoc[]
 
+include::user.conf.adoc[]
+
 :leveloffset: 0
 
 :leveloffset: 1

diff --git a/user.conf.5-opts.adoc b/user.conf.5-opts.adoc
new file mode 100644 (file)
index 0000000..c8ba57b
--- /dev/null
+++ b/user.conf.5-opts.adoc
@@ -0,0 +1,44 @@
+`comment`: `<string>` ::
+
+Comment.
+
+`crypt_pass`: `\$\d\$[a-zA-Z0-9\.\/]+\$[a-zA-Z0-9\.\/]+` ::
+
+Encrypted password (see `man crypt`)
+
+`email`: `<string>` ::
+
+Users E-Mail address.
+
+`enable`: `<boolean>` ('default =' `0`)::
+
+Flag to enable or disable the account.
+
+`expire`: `<integer> (0 - N)` ('default =' `0`)::
+
+Account expiration date (seconds since epoch). '0' means no expiration date.
+
+`firstname`: `<string>` ::
+
+First name.
+
+`keys`: `<string>` ::
+
+Keys for two factor auth (yubico).
+
+`lastname`: `<string>` ::
+
+Last name.
+
+`password`: `<string>` ::
+
+Password
+
+`role`: `<admin | audit | qmanager | root>` ::
+
+User role. Role 'root' is reseved for the Unix Superuser.
+
+`userid`: `<string>` ::
+
+User ID
+

diff --git a/user.conf.adoc b/user.conf.adoc
new file mode 100644 (file)
index 0000000..c24aa73
--- /dev/null
+++ b/user.conf.adoc
@@ -0,0 +1,43 @@
+[[pmg_user_configuration_file]]
+ifdef::manvolnum[]
+user.conf(5)
+============
+:pmg-toplevel:
+
+NAME
+----
+
+user.conf - Proxmox Mail Gateway User Configuration
+
+
+SYNOPSIS
+--------
+
+`/etc/pmg/user.conf`
+
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+ifndef::manvolnum[]
+User Configuration
+==================
+endif::manvolnum[]
+
+The file `/etc/pmg/user.conf` contains the user configuration.
+
+
+File Format
+-----------
+
+TODO
+
+Options
+-------
+
+include::user.conf.5-opts.adoc[]
+
+
+ifdef::manvolnum[]
+include::pmg-copyright.adoc[]
+endif::manvolnum[]