Commit Graph

49 Commits

Author SHA1 Message Date
Fabian Grünbichler
3325e6c325 partially-fix #5958: doc: add additional example for debug packages
our repositories don't override their section to debug, and they can get quite
big..

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-12-09 19:51:47 +01:00
Daniel Kral
d4a4d278b3 docs: fix command arguments for syncing a medium
Fixes a minor error in the documentation about syncing a medium, where
the id for a medium is falsely provided with a `--id <id>` argument.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
2024-09-06 17:37:02 +02:00
Fabian Grünbichler
2cd3578c0d build: use cargo wrapper
for package builds to ensure all common flags are actually set.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-07-22 19:03:07 +02:00
Thomas Lamprecht
94ce586afa docs: update copyright years
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-01-09 11:18:00 +01:00
Maximiliano Sandoval
971ec747dc docs: offline-media: Use correct config subcommand
There is no `config medium` subcommand.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-01-09 09:12:19 +01:00
Stefan Sterz
077c6bfcc2 docs: add an auto dark mode to the docs
this adds the dark mode from the proxmox backup server to the offline
mirror for a more consistent appearance of the documentation across
all products.

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
Tested-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2023-12-20 17:18:25 +01:00
Fabian Grünbichler
934e3bd4b7 docs: fix copied env variable documentation
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-11-15 11:32:50 +01:00
Fabian Grünbichler
6bd9717ce0 docs: fix bullseye references
the current version of POM is released for Debian 12 "Bookworm", update the
docs accordingly.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-08-04 11:07:16 +02:00
Thomas Lamprecht
44c5a93709 fixup! makefile: convert to use simple parenthesis 2023-05-30 13:51:07 +02:00
Thomas Lamprecht
d5c4f90d88 makefile: convert to use simple parenthesis
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-05-30 12:24:45 +02:00
Fabian Grünbichler
bc4acb26a2 fix #4614: add note about key requirements to mirror docs
and reference the key part of the documentation.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-04-24 11:38:17 +02:00
Fabian Grünbichler
28945c9a71 setup wizard: add subscription keys
to make it a bit easier to configure access to the enterprise repositories.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 [ T: added missing use statement for format_err ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-04-24 11:38:07 +02:00
Lukas Wagner
9212c1fde5 docs: document ALL_PROXY environment variable
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-01-27 10:02:23 +01:00
Fabian Grünbichler
cd1d70bdf2 docs: add section/package filters
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-10-21 12:36:41 +02:00
Thomas Lamprecht
5b230fb998 docs: expand/structure using medium section
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-15 14:11:54 +02:00
Thomas Lamprecht
cde5983fa3 docs: offline keys: add info about minimum product version that got activation support
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-15 11:05:35 +02:00
Thomas Lamprecht
46d31930c0 docs: offline media: fix source text width to 100cc
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-12 10:33:48 +02:00
Stoiko Ivanov
f5d631e307 docs: add minimal sample nginx config
if users want to use their offline medium via http in their internal
network.

nginx config is based off the one we use for download.proxmox.com.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2022-09-12 09:39:59 +02:00
Fabian Grünbichler
d83e5ea719 docs: fix too-short title underline
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-09 14:14:17 +02:00
Fabian Grünbichler
308dbe109d docs: correct CLI titles
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-09 14:10:16 +02:00
Fabian Grünbichler
466d72aa6d rename proxmox-apt-repo to proxmox-offline-mirror-helper
and move it into its own package

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-09 14:04:29 +02:00
Fabian Grünbichler
01ab3f0474 docs: add snapshot term
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-09 14:02:05 +02:00
Fabian Grünbichler
6f59b35dca docs: adapt to pool/mirror changes
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-09 14:02:05 +02:00
Thomas Lamprecht
240307a92b docs: intro: avoid office@ mail address for sales related questions
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-09 13:32:04 +02:00
Aaron Lauterer
e5fe7f7cea docs: offline-media: improve read- and understandability
by rephrasing parts to be easier to read or adding more context.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
07fae362b6 docs: offline-keys: improve read- and understandabilty
By rephasing certain parts and splitting long sentences into smaller
ones.

Also changing "licensing server" to "subscription server".

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
a1bae05459 docs: installation: improve read- and understandabilty
This patch contains the larger changes, such as splitting longer
sentences and rewording some parts.

The headline for "Reuse a Proxmox Repository for Offline Mirror Tool"
has been changed to "Set up the Repository on non Proxmox bases
systems". Sounds a bit nicer and we are in the Proxmox Offline Mirror
docs anyway.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
32f3eca628 docs: installation: fix typos, and other small changes
switch from `Proxmox projects` to `Proxmox solutions`.
Add missing words, such as `the` and drop `also`s.

And other small changes that don't affect the actual content or meaning.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
49c845cde5 docs: introduction: rewrite for better readability
splitting long sentences, rephrasing and extending some parts

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
41cb625b6e docs: introduction: fix typos and missing words
adding `the` in a few places, dropping `also`s as they are almost always
just filler words.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Stoiko Ivanov
5d9224ed34 fix typos in command invocation
noted while blindly pasting the output after setting up my first
mirror.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2022-09-08 15:50:52 +02:00
Thomas Lamprecht
624b33a59f docs: drop non-existing APT ref
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 14:12:33 +02:00
Thomas Lamprecht
859c6ebcfa docs: mirror: mention auto-debian-base selection as tip
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:56:09 +02:00
Thomas Lamprecht
ef6ebe79fd docs: intro: reference config file switch/env variable directly
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:39:48 +02:00
Thomas Lamprecht
3d44b696bd docs: ship config manpage as proxmox-offline-mirror.cfg.5
as `mirror.cfg.5` is rather overly generic

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:36:51 +02:00
Thomas Lamprecht
c0c2562e42 docs: intro: add terminology heading
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
114497cc4c docs: add installation chapter
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
ffbf5b8904 docs: add intro to offline mirrors and media chapters
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
dba885fbba docs: restructur/expand offline key chapter
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
47fd70f0cb docs: mirror: fix --dir in command example
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 11:46:00 +02:00
Thomas Lamprecht
67581096c8 docs: split out chapters into different files
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 11:03:57 +02:00
Thomas Lamprecht
26023cc671 docs: extend, reformat and various small fixes
Fix some left overs from copying this over from PBS, note how to
acquire such a key by contacting sales@proxmox.com, add a paragraph
with some description about what this tool(ing) actually does to the
introduction section, ...

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 08:30:15 +02:00
Thomas Lamprecht
118ab592d3 docs: fix title case and heading markers
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 08:29:39 +02:00
Thomas Lamprecht
e9227093ba docs pdf: avoid extra blank page on section/chapter boundary
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 08:27:52 +02:00
Fabian Grünbichler
1c6fcd3740 docs: make help top-level header
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
e8cc6bb28b docs: expand, improve formatting
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
abaee27150 docs: document key handling
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
e34d988080 remove accidentally committed pycache
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
fabdaf9100 add docs
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00