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