Leo Nunner
4f138470fc
Document VM.Config.Cloudinit permission
...
Signed-off-by: Leo Nunner <l.nunner@proxmox.com>
2022-11-17 08:09:52 +01:00
Stefan Sterz
506839a53a
pveum: add the "user_mgmt" reference to the documentation
...
since this key was missing from the PVE documentation, the TFA ui's
help buttons didn't work as they relied on it.
Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
2022-11-11 19:23:44 +01:00
Fabian Grünbichler
b5acae243c
pveum: mention Sys.Incoming privilege
...
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-11-07 16:45:04 +01:00
Oguz Bektas
5d993771a7
pveum: fix syntax for webauthn config
...
the property string needs to be on the same line as the config key
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2022-09-13 10:07:31 +02:00
Thomas Lamprecht
9c2fa0b595
pveum: move attrs. to props. to own heading & expand
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-05-02 17:31:52 +02:00
Dominik Csapak
78881712eb
pveum: add paragraph about syncing user attributes
...
and improve wording for the remove vanished 'Properties' option.
Currently, we use both the word 'attributes' as well as 'properties'
for user fields (such as firstname, etc). I rewrote that a bit by calling
them 'attributes' for the LDAP side and 'properties' for the PVE side.
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2022-05-02 17:28:03 +02:00
Dominik Csapak
217b2caeca
update documentation about sync-options
...
describe the new 'remove-vanished' option and what the options are doing
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2022-04-26 13:06:32 +02:00
Thomas Lamprecht
8d5c645cf7
pveum: tfa: drop webauthn fixme
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-11-15 15:10:43 +01:00
Wolfgang Bumiller
1245cebe0b
update TFA docs
...
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2021-11-15 15:05:25 +01:00
Thomas Lamprecht
e455949ba9
tfa: add pseudo reference for future webauthn section
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-11-11 16:15:11 +01:00
Dylan Whyte
78000a6439
pveum: better LDAP/AD explanation + restructuring
...
Begin "Authentication Realms" section with brief introduction to each
realm (this was there already, but inconsistent in the level of detail
given for each part).
Give each realm type its own subsection
Adds some more information on LDAP and Active Directory configuration.
Restructure the document to bring the "Syncing LDAP-Based Realms" section
closer to the LDAP and AD sections.
Explain LDAP parameters/options individually in list format
Remove some non-relevant information such as how to add system users
Some more minor langauge and formatting fixup
2021-10-04 06:56:36 +02:00
Dylan Whyte
a13a971d00
pveum: add intro to 'limited API Token' section
...
Add a short introduction to the section "Limited API Token for
Monitoring", to provide some context
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-10-04 06:56:36 +02:00
Dylan Whyte
9694224859
pveum: language fixup
...
language cleanup with some minor formatting fixes
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-10-04 06:56:36 +02:00
Thomas Lamprecht
62547dfabf
pveum: fix some typos
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-07-02 16:26:00 +02:00
Dietmar Maurer
f3ee27ebb4
user-management: add OpenId Connect documentation
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-07-02 15:30:40 +02:00
Thomas Lamprecht
f06ba6a611
user: clarify that passing the expiry date won't auto-stop tasks
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-06-23 11:20:45 +02:00
Lorenz Stechauner
8d02d0a2a2
pveum: add warning for disabling or deleting users
...
see #3101
Signed-off-by: Lorenz Stechauner <l.stechauner@proxmox.com>
2021-06-23 11:17:48 +02:00
Lorenz Stechauner
696ebb3c24
fix #3202 : pveum: add Pool.Audit permission
...
Signed-off-by: Lorenz Stechauner <l.stechauner@proxmox.com>
2021-06-01 10:31:05 +02:00
Oguz Bektas
a55d30db1d
change http links to https
...
checked if they work -- some returned certificate errors so didn't
change those ones.
also updated some that didn't point to the right thing (open-iscsi, and
the list of supported CPUs was returning empty).
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2021-05-07 18:26:05 +02:00
Dominik Csapak
58df830bac
pveum: u2f: defuse the warning about certificates
...
since it seems (currently) to work with self-signed certificates as well
tested in chromium/chrome/firefox
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-04-29 13:33:00 +02:00
Oguz Bektas
3a433e9bb0
SPAM: [PATCH v2 docs] fix typos in various adoc files
...
checked for common misspellings. some of the changes (like favourite vs.
favorite or virtualization vs. virtualisation) are because of US vs. UK english
Reviewed-by: Dylan Whyte <d.whyte@proxmox.com>
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2021-04-29 13:26:28 +02:00
Thomas Lamprecht
9135e32190
pveum: adapt CLI examples to newer sub-command syntax
...
most of it is like that since years actually, so not sooo new
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-24 19:51:40 +02:00
Dylan Whyte
23b447be71
resource-pools: add section in docs
...
Adds a second-level heading for resource pools and adds creation of pool
to example.
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-04-24 19:46:04 +02:00
Thomas Lamprecht
4ab527b19f
follouwp: rewrite to active and drop trailing whitespace
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-10-22 18:56:52 +02:00
Dominic Jäger
0fb9147a65
SPAM: [PATCH docs] pveum: Add information about realm certificates
...
As explained by Dominik and Fabian [0].
[0] https://bugzilla.proxmox.com/show_bug.cgi?id=2827
Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-10-22 18:54:55 +02:00
Wolfgang Link
88636df186
update link for YubiKey documentation
...
Signed-off-by: Wolfgang Link <w.link@proxmox.com>
2020-05-11 17:03:27 +02:00
Thomas Lamprecht
41c386baae
pveum: add ldap sync panel screenshots
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-05-08 18:26:32 +02:00
Dominik Csapak
8ab21a40c3
pveum: use correct cli command for realm sync
...
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2020-05-08 13:38:12 +02:00
Thomas Lamprecht
f5eb2299c2
ldap sync: minor wording + reference addition
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-05-05 10:53:35 +02:00
Dominik Csapak
a160926a4d
add documenation for ldap syncing
...
explaining the main Requirements and limitations, as well as the
most important sync options
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2020-05-04 16:46:54 +02:00
Thomas Lamprecht
a10a91c288
pveum: move group and apitoken headings one level up
...
They are major sections, equal to "Users" so do not make them a sub
section of "Users" but rather their own. This makes both also visible
in the full admin guide TOC.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-02-13 11:56:42 +01:00
Thomas Lamprecht
c6e098a291
apitoken: use CAUTION for token-only-once-visible note
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-02-13 11:53:17 +01:00
Thomas Lamprecht
710713eaa6
followup: fix trailing spaces and text width
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-02-13 11:52:40 +01:00
Fabian Grünbichler
181db0988e
document API tokens
...
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2020-02-13 11:13:07 +01:00
Oguz Bektas
74662f51a3
pveum: improve tfa section
...
* s/two factor/two-factor
* add explicit mention of TOTP (Time-based One-time Password)
* wrap lines/paragraphs
* minor edits on wording or punctuation
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2019-11-29 15:52:14 +01:00
Thomas Lamprecht
97d63abc45
add pveum_configure_u2f reference
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-11-26 17:09:32 +01:00
Fabian Ebner
87ba80b03f
Fix typos in pveum.adoc
...
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2019-09-02 12:28:47 +02:00
Thomas Lamprecht
5e6b02ff17
pveum: add role add screenshot
...
also expand the text a bit, mostly for formatting reasons, as else
the screenshot renders into the CLI pveum code example block in the
HTML output...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-04-05 18:27:35 +02:00
Thomas Lamprecht
0523992b63
pveum: add some references for onlineHelp
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-04-05 17:35:58 +02:00
Thomas Lamprecht
2b59fcfb38
user management: add screenshot for TFA setup
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-04-05 17:35:31 +02:00
Wolfgang Bumiller
2837cf1d93
Update TFA documentation
...
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2019-04-05 11:43:12 +02:00
David Limbeck
a35aad4add
fix typos/wording
...
Signed-off-by: David Limbeck <d.limbeck@proxmox.com>
2018-08-23 14:32:54 +02:00
Thomas Lamprecht
44f38275ee
fix a/an and repeated words
...
ddouble words found with /(\b\S+\b)\s+\b\1\b/
(the silver searcher `ag` can find matches even with newlines in
between without extra flags)
Adapt some wording when touching the lines.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2017-10-09 10:06:54 +02:00
Dominik Csapak
470d43137c
fix typos and whitespace all around
...
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2017-09-27 10:25:20 +02:00
Emmanuel Kasper
ced79689c8
Document that Sys.Audit allows also to read cluster paramaters
2017-03-08 07:27:29 +01:00
Dietmar Maurer
a69bfc83f6
remove attributes.txt (use asciidoc/asciidoc-pve.conf instead)
2016-11-08 06:46:43 +01:00
Dietmar Maurer
7d48940bf0
asciidoc-pve.in: detect and avoid xrefs spanning multiple lines
...
Because our parser is not smart enough to do it better.
2016-10-21 07:06:36 +02:00
Dietmar Maurer
194d2f2961
generate default output file mappings automatically
2016-10-14 07:18:04 +02:00
Dietmar Maurer
80c0adcbc3
use/define more/better block IDs
2016-10-13 08:40:48 +02:00
Dietmar Maurer
b2f242abe4
remove empty line between heading and attribute definition, fix man titles
...
To avoid problems with asciidoc.
2016-10-12 06:54:29 +02:00