Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
Thomas Lamprecht 31df4fee04 fix wiki-special link to "USB installation" před 3 dny
api-viewer run make update for static/schema information před 1 týdnem
asciidoc html: avoid horizontal overflows, break-word and limit image width před 3 týdny
debian bump version to 6.1-6 před 5 dny
examples move guest-example-hookscript into new examples directory před 1 rokem
images Add cluster join screenshot před 5 měsíci
.gitignore Add to gitignore před 8 měsíci
GFDL.adoc try to correctly include the GFDL license před 4 roky
LICENSE add README and LICENSE (FDL) před 4 roky
Makefile follouwp: test for instant view may not fail, else Make thins something real failed před 4 měsíci
README.adoc fix some typos před 1 týdnem
asciidoc-pve.in html: use new table-of-contents (toc2) also for individual chapters před 3 týdny
certificate-management.adoc certs: followup: move hint a bit higher and small improvement před 1 měsícem
datacenter.cfg.5-opts.adoc run make update for static/schema information před 1 týdnem
datacenter.cfg.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
docinfo.xml add docinfo with single corpauthor před 4 roky
extractapi.pl use new helper PVE::RESTHandler::api_dump_remove_refs() před 1 rokem
gen-datacenter.cfg.5-opts.pl use PVE::DataCenterConfig to get schema před 3 měsíci
gen-ha-groups-opts.pl ha-manager.adoc: improve group configuration section před 3 roky
gen-ha-resources-opts.pl ha-manager.adoc: improve configuration section před 3 roky
gen-output-format-opts.pl gen-output-format-opts.pl: use correct argument syntax před 1 rokem
gen-pct-mountpoint-opts.pl gen-pct-mountpoint-opts.pl: improve layout před 3 roky
gen-pct-network-opts.pl gen-pct-network-opts.pl: improve layout před 3 roky
gen-pct.conf.5-opts.pl export pct.1 pct.conf.5 vm.conf.5 and datacenter.conf.5 před 3 roky
gen-pve-firewall-cluster-opts.pl create debian package with all sources to generate pve manual pages před 3 roky
gen-pve-firewall-host-opts.pl create debian package with all sources to generate pve manual pages před 3 roky
gen-pve-firewall-macros-adoc.pl create debian package with all sources to generate pve manual pages před 3 roky
gen-pve-firewall-rules-opts.pl create debian package with all sources to generate pve manual pages před 3 roky
gen-pve-firewall-vm-opts.pl create debian package with all sources to generate pve manual pages před 3 roky
gen-qm-cloud-init-opts.pl start cloud-init documentation před 1 rokem
gen-qm.conf.5-opts.pl cdrom is just an alias, so we do not want to print details před 3 roky
gen-vzdump.conf.5-opts.pl gen vzdump: json_config_properties() moved from VZDump to VZDump::Common před 4 měsíci
getting-help.adoc Fix whitespace and line length před 1 týdnem
ha-groups-opts.adoc update generated docs před 3 roky
ha-manager.1-synopsis.adoc update static schema/synopsis definitions před 3 měsíci
ha-manager.adoc HA: refine docs for migrate shutdown policy před 2 měsíci
ha-resources-opts.adoc update generated docs před 2 roky
howto-improve-pve-docs.adoc installation/usb stick: improve and hyperlink před 1 týdnem
hyper-converged-infrastructure.adoc hci: add Storage section refering to ceph/ZFS před 3 týdny
index.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
local-lvm.adoc add lvm/zfs anchors před 1 rokem
local-zfs.adoc zfs: fix trailing whitespace in command před 1 měsícem
output-format-opts.adoc run make update-static před 1 rokem
output-format.adoc fix some typos před 1 týdnem
pct-mountpoint-opts.adoc run make update před 7 měsíci
pct-network-opts.adoc run make update před 10 měsíci
pct.1-synopsis.adoc update static schema/synopsis definitions před 2 měsíci
pct.adoc pct: readd missing whitespace před 1 týdnem
pct.conf.5-opts.adoc update static schema/synopsis definitions před 2 měsíci
pct.conf.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pmxcfs.8-synopsis.adoc renamed pmxcfs.8-cli.adoc to pmxcfs.8-synopsis.adoc před 3 roky
pmxcfs.adoc create and use chapter ref chapter_pmxcfs před 2 roky
png-cleanup.pl png-verify.pl: use Unit PixelsPerCentimeter před 3 roky
png-verify.pl png-verify.pl: allow 72dpcm for pve installer images před 2 roky
pve-admin-guide-docinfo.xml.in pve-admin-guide-docinfo.xml.in: automatically update year in copyright notice před 1 rokem
pve-admin-guide.adoc ceph: move ceph docs to own top level chapter před 3 týdny
pve-bibliography.adoc pve-bibliography.adoc - update version of 'Mastering Proxmox' před 1 rokem
pve-copyright.adoc update copyright year to current před 1 rokem
pve-disk-health-monitoring.adoc some small spelling/grammar fixes před 3 roky
pve-doc-generator.mk.in follouwp: test for instant view may not fail, else Make thins something real failed před 4 měsíci
pve-docs-mediawiki-import.in use https and full hostname to access mw api před 2 roky
pve-external-metric-server.adoc followup: metric-server: formating, line length, and other small improvements před 9 měsíci
pve-faq.adoc FAQ: add link to 5.x -> 6.0 upgrade před 7 měsíci
pve-firewall-cluster-opts.adoc run make update před 10 měsíci
pve-firewall-host-opts.adoc update static schema/synopsis definitions před 2 měsíci
pve-firewall-macros.adoc run make update for static/schema information před 1 týdnem
pve-firewall-rules-opts.adoc run make update před 10 měsíci
pve-firewall-vm-opts.adoc update static schema/synopsis definitions před 2 měsíci
pve-firewall.8-synopsis.adoc update generated docs před 2 roky
pve-firewall.adoc firewall: update and expand used ports před 1 týdnem
pve-gui.adoc Fix typos in pve-gui.adoc před 5 měsíci
pve-ha-crm.8-synopsis.adoc update generated docs před 2 roky
pve-ha-crm.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pve-ha-lrm.8-synopsis.adoc update generated docs před 2 roky
pve-ha-lrm.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pve-installation-media.adoc prepare usb iso: add fdatasync to dd command and document if= před 1 týdnem
pve-installation.adoc fix wiki-special link to "USB installation" před 3 dny
pve-intro.adoc ceph: move ceph docs to own top level chapter před 3 týdny
pve-network.adoc network: add note for possible fix/workaround in NAT setup před 1 týdnem
pve-package-repos.adoc Fix whitespace and line length před 1 týdnem
pve-storage-cephfs.adoc typo managment -> management před 1 rokem
pve-storage-cifs.adoc add documentation about snippet content-type and hookscripts před 1 rokem
pve-storage-dir.adoc add documentation about snippet content-type and hookscripts před 1 rokem
pve-storage-glusterfs.adoc add documentation about snippet content-type and hookscripts před 1 rokem
pve-storage-iscsi.adoc Change iscsiscan invocation in pve-storage-iscsi před 1 rokem
pve-storage-iscsidirect.adoc add references to storage docs před 1 rokem
pve-storage-lvm.adoc add references to storage docs před 1 rokem
pve-storage-lvmthin.adoc add references to storage docs před 1 rokem
pve-storage-nfs.adoc add documentation about snippet content-type and hookscripts před 1 rokem
pve-storage-rbd.adoc fixup: s/devies/devices/ před 11 měsíci
pve-storage-zfspool.adoc Add description for mountpoint property před 2 měsíci
pve-system-requirements.adoc fix casing před 1 týdnem
pveam.1-synopsis.adoc run make update před 7 měsíci
pveam.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pveceph.1-synopsis.adoc run make update před 8 měsíci
pveceph.adoc pveceph: reword memory precondition před 5 dny
pvecm.1-synopsis.adoc run make update před 7 měsíci
pvecm.adoc fix some typos před 1 týdnem
pvedaemon.8-synopsis.adoc update generated docs před 2 roky
pvedaemon.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pvenode.1-synopsis.adoc run make update for static/schema information před 1 týdnem
pvenode.adoc fixup typo: s/sendig/sending/ před 1 rokem
pveperf.1-synopsis.adoc add pveperf section and man page před 3 roky
pveperf.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pveproxy.8-synopsis.adoc update generated docs před 2 roky
pveproxy.adoc pveproxy: add docs for /etc/default/pveproxy před 1 rokem
pvesh.1-synopsis.adoc pvesh.1-synopsis.adoc: update před 1 rokem
pvesh.adoc pve-admin-guide: include pvenode and pvesh docs před 1 rokem
pvesm.1-synopsis.adoc update static schema/synopsis definitions před 2 měsíci
pvesm.adoc followup: storage config description před 5 měsíci
pvesr.1-synopsis.adoc update API před 1 rokem
pvesr.adoc pvesr: be more specific about HA and priority redistribution před 2 měsíci
pvestatd.8-synopsis.adoc update generated docs před 2 roky
pvestatd.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pvesubscription.1-synopsis.adoc run make update-static před 1 rokem
pvesubscription.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
pveum.1-synopsis.adoc run make update for static/schema information před 1 týdnem
pveum.adoc pveum: move group and apitoken headings one level up před 1 týdnem
qm-cloud-init-opts.adoc run make update před 10 měsíci
qm-cloud-init.adoc fix some typos před 1 týdnem
qm-pci-passthrough.adoc Fix typo in passthrough docs and improve 'Host Configuration' section před 2 měsíci
qm.1-synopsis.adoc run make update for static/schema information před 1 týdnem
qm.adoc fix some typos před 1 týdnem
qm.conf.5-opts.adoc run make update for static/schema information před 1 týdnem
qm.conf.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
qmeventd.8-synopsis.adoc add qmeventd manpage před 1 rokem
qmeventd.adoc add qmeventd manpage před 1 rokem
qmrestore.1-synopsis.adoc update generated docs před 1 rokem
qmrestore.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
scan-adoc-refs remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
spiceproxy.8-synopsis.adoc update generated docs před 2 roky
spiceproxy.adoc remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) před 3 roky
sysadmin.adoc Fix whitespace and line length před 1 týdnem
system-booting.adoc Replace erroneous interpunct with space před 4 měsíci
system-software-updates.adoc Overhaul System Software Updates před 1 týdnem
system-timesync.adoc fix #1818: use NTP instead of Servers in timesyncd.conf před 1 rokem
translation.adoc Overhaul Translation před 1 týdnem
vxlan-and-evpn.adoc vxlan: remove "no bgp default ipv6-unicast" před 5 měsíci
vzdump.1-synopsis.adoc run make update před 7 měsíci
vzdump.adoc backup restore: Fix syntax for bwlimit example před 2 měsíci
vzdump.conf.5-opts.adoc run make update před 7 měsíci

README.adoc

Proxmox VE Documentation
========================

We try to generate high quality documentation for
{website}[{pve}], and choose to use
http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.

The basic idea is to generate high quality manual pages, and assemble
them into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
Administration Guide]. So we have one source, and generate several
documents from that. It is also possible to generate printable PDF
files, or ebook formats ('.epub').

When possible, we provide scripts to extract API definitions,
configuration or command line options from the source code.

To simplify the documentation task, we keep all Documentation within
this repository. It is possible to generate the docs without installing
any additional Proxmox packages with:

make pve-doc-generator.mk
make index

To update the auto-generate API definitions use:

make update

NOTE: you need a fully installed development environment for that.


Debian Packages
---------------

We generate a development package called 'pve-doc-generator', which is
used by other Proxmox VE package to generate manual pages at package
build time.

Another package called 'pve-docs' is used to publish generated
'.html' and '.pdf' files on our web servers. You can generate
those Debian packages using:

make deb


Common Macro definition in link:asciidoc/asciidoc-pve.conf[]
------------------------------------------------------------

'asciidoc' allows us to define common macros, which can then be
referred to using `{macro}`. We try to use this mechanism to improve
consistency. For example, we defined a macro called `pve`, which
expands to "Proxmox VE".

For URLs which are used more than once, two macros should be defined:

* `{name-url}`, which just contains the http(s) URL
* `{name}`, which contains the complete link including the canonical
description

For example, the macro `{forum-url}` expands to {forum-url}, and the macro
`{forum}` expands to {forum}.

The plan is to add more such definitions for terms which are used more
than once.

WARNING: When asciidoc encounters a misspelled macro name, it will
silently drop the containing line!


Autogenerated CLI Command Synopsis
----------------------------------

We generate the command line synopsis for all manual pages
automatically. We can do that, because we have a full declarative
definition of the {pve} API. I added those generated files
('*-synopsis.adoc') to the git repository, so that it is possible to
build the documentation without having a fully installed {pve}
development environment.

Style Guide
-----------

'asciidoc' uses a fairly simple markup syntax for formatting content.
The following basic principles should be followed throughout our
documentation.


Sections
~~~~~~~~

Sections are formatted using `two-line titles', by adding a line of
the appropriate characters and of the same length as the section title
below the title text:

Level 0 (top level): ======================
Level 1: ----------------------
Level 2: ~~~~~~~~~~~~~~~~~~~~~~
Level 3: ^^^^^^^^^^^^^^^^^^^^^^
Level 4 (bottom level): ++++++++++++++++++++++

NOTE: Level 4 headings are currently not working for `manpage` outputs, you may
want to use `.SECTION' instead, which results in the same rendering, and this
level of Heading isn't displayed in any Index/TOC anyway.

Section titles should always be preceded by two empty lines. Each word
in a title should be capitalized except for ``articles, coordinating
conjunctions, prepositions, and the word to in infinitives unless they
appear as the first or last word of a title'' (see
http://web.mit.edu/course/21/21.guide/capitals.htm[Mayfield Electronic Handbook of Technical & Scientific Writing]).


Lists
~~~~~

Numbered Lists
^^^^^^^^^^^^^^

Numbered lists should be created using the implicit numbering format:

-----
. First level
.. Second level
. First level again
-----

. First level
.. Second level
. First level again


Bulleted Lists
^^^^^^^^^^^^^^

Bulleted lists should be created using the '*' symbol:

-----
* First level
** Second level
* First level again
-----

* First level
** Second level
* First level again


If you need to have other elements on the same level than a list element you
can do this with the '+' symbol:

----
. First level
.. Second level
+
Another Sentence (or Block) on the continued second level.
. First level again
----

. First level
.. Second level
+
Another Sentence (or Block) on the continued second level.

. First level again

Labeled Lists
^^^^^^^^^^^^^

Labeled lists should be used to make lists of key-value style text
more readable, such as command line parameters or configuration options:

.Regular labeled lists
-----
First Label Text::

Element text paragraph

Second Label Text::

Another element text paragraph.
-----

First Label Text::

Element text paragraph

Second Label Text::

Another element text paragraph.

.Horizontal labeled lists
-----
[horizontal]
First Label Text:: Element text paragraph

Second Label Text:: Another element text paragraph.
-----

creates

[horizontal]
First Label Text:: Element text paragraph

Second Label Text:: Another element text paragraph.

The FAQ section uses a special questions and answers style for
labeled lists.


Text and Block Styles
~~~~~~~~~~~~~~~~~~~~~

'asciidoc' offers a wide range of default text styles:

* 'Emphasized text': created using \'text', used for emphasizing words
and phrases
* `Monospaced text`: created using \`text`, used for command / program
names, file paths, in-line commands, option names and values
* *Strong text*: created using \*text*, used for emphasizing concepts
or names when first introduced in a section.

There are also different built-in block styles that are used in
our documentation:

Complete paragraphs can be included literally by prepending each
of their lines with whitespace. Use this for formatting complete
commands on their own line, such as:

pct set ID -option value

----
By surrounding a paragraph with lines containing at least four '-'
characters, its content is formatted as listing.

Use this for formatting file contents or command output.
----

Specially highlighted 'notes', 'warnings' and 'important' information
can be created by starting a paragraph with `NOTE:`, `WARNING:` or
`IMPORTANT:`:

NOTE: this is a note

WARNING: this is warning

IMPORTANT: this is important information

For each of these blocks (including lists and paragraphs), a block header
can be defined by prepending the block with a `.' character and the header
text:

-----
.Title of List
* First element
* Second element
* Third element
-----

.Title of List
* First element
* Second element
* Third element

For example, block headers can be used to add file names/paths to file
content listings.


Online Help
-----------
Each {pve} installation contains the full documentation in HTML format,
which is then used as the target of various help buttons in the GUI.

If after adding a specific entry in the documentation you want to
create a help button pointing to that, you need to do the
following:

* add a string id in double square brackets before your
documentation entry, like `[[qm_general_settings]]`
* rebuild the `asciidoc-pve` script and the HTML chapter file containing
your entry
* add a property `onlineHelp` in the ExtJS panel you want to document,
using the above string, like `onlineHelp: qm_general_settings`
This panel has to be a child class of PVE.panel.InputPanel

On calling `make install` the asciidoc-pve script will populate
a JS object associating the string id and a link to the
local HTML documentation, and the help button of your input panel
will point to this link.


Screenshots
-----------

[thumbnail="screenshot/gui-datacenter-search.png"]

First, it should be noted that we can display screenshots on 'html'
and 'wiki' pages, and we can include them in printed documentation. But
it is not possible to render them inside manual pages. So screenshot
inside manual pages should be optional, i.e. the text should not
depend on the visibility of the screenshot. You can include a
screenshot by setting the 'thumbnail' attribute on a paragraph:

----
[thumbnail="screenshot/gui-datacenter-search.png"]
First, it should be noted ...
----

The corresponding file need to reside inside folder
`images/screenshot`, and should be in `.png` image format. We include
the screenshots in printed documentation, and 'pdftex' uses the
density (DPI) specified inside the file. So all screenshots should use
the same density. We currently require the density set to 146 DPI, so
that we can display a 1024 pixels wide image. You should not include
larger screenshots (although it is possible).

You can use the `./png-cleanup.pl` script to set the correct
density. Simply use the following command to import a screenshot
image:

----
# ./png-cleanup.pl screenshot.png images/screenshot/screenshot.png
----

TIP: You can use `identify -verbose screenshot.png` command to show
all image attributes (from debian package 'imagemagick')

.Default Screenshot Layout

[thumbnail="screenshot/gui-datacenter-search.png"]

We normally display screenshots as small thumbnail on the right side
of a paragraph. On printed documentation, we render the full sized
graphic just before the paragraph, or between the title and the text
if the paragraph has a title. It is usually a good idea to add a title
to paragraph with screenshots.

[thumbnail="screenshot/gui-datacenter-search.png", float="left"]

If you need to render many screenshots, it is possible to place them
on the left side, so you can alternate the thumbnail position using the
`float` attribute:

----
[thumbnail="screenshot/gui-datacenter-search.png", float="left"]
If you need to render many screenshots ...
----

Please avoid to many consecutive screenshots to avoid rendering
problems. Also verify the printed documentation to see if large
screenshots create layout problems.


Copyright
---------

Copyright (C) 2016-2019 Proxmox Server Solutions Gmbh

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the link:LICENSE[LICENSE] file.