5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-07 17:17:48 +03:00
Commit Graph

91 Commits

Author SHA1 Message Date
Maximiliano Sandoval
6942acb508 fix some typos
found with:

    typos *.adoc

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-10-14 10:21:29 +02:00
Maximiliano Sandoval
456b17fa59 docs: fix typos
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-09-06 20:26:17 +02:00
Fabian Grünbichler
188d30f0fe totp: fix copy/paste mistake
this should of course talk about PVE's UI, not PBS'.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-05-02 10:55:16 +02:00
Thomas Lamprecht
e2b3622a89 consistently use web UI and web interface wording
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-22 08:49:28 +01:00
Noel Ullreich
ff4ae05288 Fix spelling of command line/command-line
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Thomas Lamprecht
ff62dafe02 user management: add note about case-sensitivity for AD realm
As there its really common to do things case insensitive a docs note
should help users to discover that Proxmox VE allows one to configure
and LDAP/AD realm to also work case insensitive.

While the UI option got added only recently in pve-manager's commit
c34c5418 ("ui: active directory realm: expose case-sensitive option")
mention it already, as there's a good chance that manager gets bumped
sooner than docs.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-07-25 10:28:35 +02:00
Max Carrara
af79dcc5cb pveum: sort roles and privileges alphabetically
Signed-off-by: Max Carrara <m.carrara@proxmox.com>
2023-07-16 00:44:41 +02:00
Max Carrara
19934c36c4 pveum: add missing roles and privileges
Signed-off-by: Max Carrara <m.carrara@proxmox.com>
2023-07-16 00:44:41 +02:00
Fabian Grünbichler
3c67d55903 Update and extend permission documentation
adapt to recent changes:
- PVESDNUser role, SDN.Use privilege
- Permissions.Modify no longer part of PVESysAdmin and PVEAdmin
- PVE reserved prefix for builtin roles

and add some notes and warnings about dangerous aspects of permission
management, and missing parts.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-06-14 13:42:22 +02:00
Thomas Lamprecht
e712afa605 user management: normalize code blocks
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-07 17:45:58 +02:00
Thomas Lamprecht
e253a7876e user management: small follow-up rewording/nits for TFA locks
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-07 17:45:58 +02:00
Wolfgang Bumiller
96a0d13193 user management: document TFA lockout
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-07 17:45:58 +02:00
Dominik Csapak
fd95afe2f5 user management: ldap: specify space and number sign escaping
number sign at the beginning (was missing completely)
space only needs escaping at the start and end

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2023-03-23 17:15:17 +01:00
Dominik Csapak
62d3b56403 pveum: add RFC reference for reserved characters
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2023-03-20 16:59:21 +01:00
Thomas Lamprecht
b35285a8d6 user management: drop extra newlines and avoid broken monospace quote
asciidoc isn't really made for monospace quoting a single space
characters, so just print it without backticks

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-03-20 16:58:23 +01:00
Christoph Heiss
89e5ecc97a pveum: Document reserved characters and quoting of LDAP DNs
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2023-03-20 16:10:46 +01:00
Thomas Lamprecht
7d8e9391fa user management: add doc references for realm types
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-03-20 15:42:04 +01:00
Lukas Wagner
fd1745711f pveum: remove auth part from Keycloak issuer URL
Keycloak seems to have dropped the `auth` part with their 18.0
release.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-02-14 11:46:31 +01:00
Lukas Wagner
7816b93a65 access control: remove misleading 'additionally' in perm-modify description
'additionally' in this context is a bit misleading, as it suggests
that e.g. 'VM.Allocate' AND 'Permissions.Modify' are needed, conflicting
with the previous paragraph.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-02-09 17:23:20 +01:00
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