5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-03-01 04:58:17 +03:00

51 Commits

Author SHA1 Message Date
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
Dietmar Maurer
404a158e1b fix pve-toplevel attribute for man pages
remove empty line to avoid problems with asciidoc.
2016-10-11 09:06:13 +02:00
Dietmar Maurer
7e2fdb3dfd store manpage section inside .adoc file 2016-10-10 17:46:48 +02:00
Dietmar Maurer
5f09af76d7 mark toplevel docs 2016-10-08 17:58:35 +02:00
Fabian Grünbichler
49a5e11cd1 correct spelling of SYNOPSIS in man pages 2016-10-07 09:34:38 +02:00
Wolfgang Bumiller
a8b13bd9c7 move inheritance section / remove redundant general text
As inheritance is a property of paths, so it makes sense to
make them a subsection of them.

The permissions paragraph in what used to be a 'terms and
definitions' section now doesn't fit in and is redundant now
that there's a general introduction paragraph.
2016-10-06 09:21:54 +02:00
Wolfgang Bumiller
b8eeec5219 move and expand the Objects and Paths section
It now gets more technical to finish the documentation of
the permission checks found in the API documentation, and is
the final section about the various parts making up the
access control lists.
2016-10-06 09:21:31 +02:00
Wolfgang Bumiller
0e1fda7000 clarify that privileges are always part of roles 2016-10-06 09:21:05 +02:00
Wolfgang Bumiller
853d288bd5 reorder the roles section
As they provide an overview of predefined roles and give an
idea of what kind of permissions are available, they fit
better right after the new general permission introduction.
2016-10-06 09:20:55 +02:00
Wolfgang Bumiller
04f44730da replace Terms and Definitions with a general introduction 2016-10-06 09:20:39 +02:00
Wolfgang Bumiller
c80b9ee6b4 Reorder users and groups section above realms section.
You now first read about users, learning the fact that
they're part of groups and realms, which are described
afterwards.
This seems more natural then starting with realms and then
describing users in a "Terms and Definitions" section.
2016-10-06 09:20:19 +02:00
Wolfgang Bumiller
5462c16110 reordering 2016-10-06 09:16:37 +02:00
Wolfgang Bumiller
74936daf59 document permission syntax 2016-10-06 08:58:32 +02:00
Wolfgang Bumiller
9e8f2770b0 describe two factor authentication 2016-10-06 08:57:57 +02:00
Wolfgang Bumiller
d66142027a expand the authentication realm descriptions 2016-10-06 08:57:31 +02:00
Wolfgang Bumiller
4f6e7e059c remove first person reference 2016-10-06 08:56:15 +02:00
Fabian Grünbichler
5eba07434f spelling/grammar/capitalization
especially:
- filesystem -> file system
- mountpoint -> mount point
- lxc -> LXC
- pve -> PVE
- it's -> its (where appropriate)
- VM´s -> VMs (and similar)
- Ressource -> Resource
- maximal -> maximum or at most
- format of section headers and block headers
2016-09-27 11:27:46 +02:00
Fabian Grünbichler
8c1189b640 formatting cleanup
reformat most existing 'text' as either `text` or ``text''
reformat most existing "text" as either ``text'' or `text`
reformat 'x' as `x`
harmonize bullet list syntax to use '*' instead of '-'
2016-09-27 11:27:46 +02:00
Emmanuel Kasper
4b048bf2db Fix PVE API URL 2016-09-13 10:32:00 +02:00
Emmanuel Kasper
3b26ef9ed4 Escape curly brackets inside single quotes (')
text in backquotes (`) is not subject to asciidoc expansion but
text inside single quotes (') is

this behaviour led that '{vmid}' was somehow interpreted by asciidoc,
and the whole line was not not rendered

pveum.adoc was the only file with that problem as curly brackets
are inside backticks in the rest of the documentation
2016-09-08 12:36:53 +02:00
Fabian Grünbichler
0abc65b04f NOTE: cleanup 2016-04-15 16:53:53 +02:00
Dietmar Maurer
38fd095871 move include after document header
to conform to asciidoc specs.
2016-01-06 17:15:22 +01:00