Thomas Lamprecht [Wed, 20 Nov 2019 07:58:30 +0000 (08:58 +0100)]
add big attribute to thumbnails
allows one to easily define bigger thumbnails, i.e., those where we
have to big images to show the full on a page, but still want to give
the user a good sized preview.
As PDF renders this already pretty nice by default we only have to
adapt the html asciidoc config. We do that by using asciidocs
"Conditional Attribute References"[0] and add a "big" attribute.
It can be used as:
> [thumbnail="pmg-gui-network-config.png", big=1]
NOTE: the value of big is ignored, it just matters if it's defined.
While it could be possible to add logic to handle big=0, it it's just
extra work without real use, just omit it if not wanted.
Stoiko Ivanov [Mon, 18 Nov 2019 21:16:49 +0000 (22:16 +0100)]
explain handling of sa configuration
The configuration files of spamassassin (/etc/mail/spamassassin) are provided
and changed by 2 things:
* some files are rendered through the templating engine
* the rest is shipped with proxmox-spamassassin on package upgrades
This patch explicitly lists the first category of files, clarifying the
situation for our users.
Stoiko Ivanov [Mon, 18 Nov 2019 21:16:48 +0000 (22:16 +0100)]
Add documentation for before queue filtering
This patch adds the configuration options for before/after queue filtering
and generation of NDRs to the feature list and explains the concepts in
'pmgconfig.adoc' below the 'Options' panel of the MailProxy configuration
(where the features can be enabled in the GUI)
Stoiko Ivanov [Wed, 6 Nov 2019 11:18:37 +0000 (12:18 +0100)]
Expand the docs for custom SA configuration
Users regularly ask how to classify mails containing some keywords as spam.
Given that this usually indicates a misconfiguration in their DNS-Setup, and
the changes lead to more false positives than actually catching more spam
we should address this more explictly in the documentation.
repos: change security repo link for future proofing and add note for bullseye
Actual this is a no-change change, as they URLs both resolve to the
exact same folders (are symlinked), i.e., see:
http://security-cdn.debian.org/dists/
vs.
http://security-cdn.debian.org/debian-security/dists/
but just change it nonetheless to match Debian's recommendation.
Also, add a FIXME not for the future 7.0 as there we need to change
the security suite name too[0].
Stoiko Ivanov [Thu, 29 Aug 2019 17:21:56 +0000 (19:21 +0200)]
mail-filter: include 'Rule-Based' in heading
One of the core features of PMG is the rule-system, which is documented in
'pmg-mail-filter.adoc' under the (correct) heading of 'Mail Filter'
In quite a few other places [0,1] where the features of PMG are highlighted we
refer to the (Object Oriented) Rule System.
When skimming through the documentation and quickly glancing at links the
connection 'Rule System' <-> 'Mail Filter' is not directly apparent and could
cause confusion.
This is addressed by adding 'Rule-Based' as prefix to the chapter title.
Thomas Lamprecht [Sat, 17 Aug 2019 10:48:21 +0000 (12:48 +0200)]
api-viewer: use our extjs package instead of the cloudflare cdn
The loading of an external hosted ExtJS is from a time where we did
not have a extra ExtJS package as it still was in the pve-manager
one, which was not desired to be installed on a non-pmg machine.
Add a dependency on libjs-extjs and a link from api-viewer/extjs to
the installation directory of the ExtJS package, this allows to reuse
ExtJS on PMG node hosted docs and on the hosted docs from proxmox.com
at the same time.
Adapted from the Proxmox VE version[0] of this change.
Stoiko Ivanov [Wed, 29 May 2019 14:18:20 +0000 (16:18 +0200)]
add new pmg-docs-apache package
containing a short apache-config snippet for delivering the pmg-docs via apache.
Mostly added for consistency between pve-docs (containing pve-docs-mediawiki)
and pmg-docs (containing pmg-docs-apache, because it does not have a wiki)
Thomas Lamprecht [Fri, 31 May 2019 11:15:33 +0000 (13:15 +0200)]
Revert " set email to office@proxmox.com"
This reverts commit 99cdf3a878cd53bf1e3942c63ba6e0f040b470f5.
Reqeuested, again, by Martin as it's out there for such purposes for
>15 years, so we just keep it.
Thomas Lamprecht [Tue, 16 Apr 2019 10:52:08 +0000 (12:52 +0200)]
d/control: build-depend on source-highlight
This ensures that code blocks with [source,<lang>] blocks get
rendered correctly in HTML output.
While we only have one such block, and we could remove the
source highlighting tag completely here we use this in pve-docs and
also have the dependency there correctly, so it makes sense to make
share this here, else a copied text from pve-docs may be incompatible
here
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Stoiko Ivanov [Wed, 27 Feb 2019 19:37:32 +0000 (20:37 +0100)]
export and respect SOURCE_DATE_EPOCH
to improve reproducibility of pve-docs, pve-doc-generator and
pve-doc-mediawiki builds, as well as man pages generated by
pve-doc-generator when called via dpkg-buildpackage.
timestamps embedded in the documentation now always reflect the last changelog
entry of the package to which the documentation belongs (pve-docs for html,
epub and pdf, individual packages for man pages).
Stoiko Ivanov [Wed, 27 Feb 2019 16:30:01 +0000 (17:30 +0100)]
fix #2098 and a typo
The phrasing regarding copying the templates from '/var/lib/pmg/templates'
to '/etc/pmg/templates' caused some confusion [0] and some users thought they
need to copy all templates to '/etc/pmg/templates', even if they only modified
one template. Rephrasing the sentence to speak of a singular template, should
explain the workings better.
Additionally a singular/plural typo was fixed
[0] https://bugzilla.proxmox.com/show_bug.cgi?id=2098 and a few forum-threads
This is an analogous change to what was done in pve-docs last year.
The Build-Depends has been adjusted to list all required ones, there
were some missing. Also, the compat level is set to 9 so bump
debhelper Build-Depends to >= 9~.