mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-24 08:45:13 +00:00
Code Issues Releases Wiki Activity
borg/docs/support.rst

62 lines
2 KiB
ReStructuredText
Raw Normal View History

docs: fix broken links (cherry picked from commit c7994b598b696d7fb585c21e5a8c489af30a37e4)
2017-11-26 22:56:32 +00:00
.. _support:
link to the homepage for support/service otherwise people ONLY reading the docs (and not coming from the homepage) will miss these options. (cherry picked from commit 7438cb2ef48e3cad9c220fc25de0a462a425bed8)
2017-11-26 22:34:10 +00:00
Support
=======
Support and Services
--------------------
Please see https://www.borgbackup.org/ for free and paid support and service options.
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
move security verification to support section the rationale is to simplify the README file to the bare minimum. security researchers will be able to find the contact information if they look minimally and people installing the software will find a link where relevant (in binary releases only, since all the others have other trust paths)
2016-11-03 18:10:38 +00:00
.. _security-contact:
Security
--------
docs: reflow some really long lines I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and reflowed them where reasonable. Line length in the docs isn't too important (it doesn't matter once they're compiled), but it's nice not to have super-long lines in one's editor.
2020-03-11 23:09:12 +00:00
In case you discover a security issue, please use this contact for reporting it
privately and please, if possible, use encrypted E-Mail:
move security verification to support section the rationale is to simplify the README file to the bare minimum. security researchers will be able to find the contact information if they look minimally and people installing the software will find a link where relevant (in binary releases only, since all the others have other trust paths)
2016-11-03 18:10:38 +00:00
Thomas Waldmann <tw@waldmann-edv.de>
GPG Key Fingerprint: 6D5B EF9A DD20 7580 5747 B70F 9F88 FB52 FAF7 B393
The public key can be fetched from any GPG keyserver, but be careful: you must
use the **full fingerprint** to check that you got the correct key.
Add docs on how to verify a signed release Short howto on using gpg to verify a signed binary release. Fixes #3634
2018-03-02 17:23:34 +00:00
Verifying signed releases
-------------------------
docs: reflow some really long lines I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and reflowed them where reasonable. Line length in the docs isn't too important (it doesn't matter once they're compiled), but it's nice not to have super-long lines in one's editor.
2020-03-11 23:09:12 +00:00
`Releases <https://github.com/borgbackup/borg/releases>`_ are signed with the
same GPG key and a .asc file is provided for each binary.
Add docs on how to verify a signed release Short howto on using gpg to verify a signed binary release. Fixes #3634
2018-03-02 17:23:34 +00:00
docs: reflow some really long lines I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and reflowed them where reasonable. Line length in the docs isn't too important (it doesn't matter once they're compiled), but it's nice not to have super-long lines in one's editor.
2020-03-11 23:09:12 +00:00
To verify a signature, the public key needs to be known to GPG. It can be
imported into the local keystore from a keyserver with the fingerprint::
Add docs on how to verify a signed release Short howto on using gpg to verify a signed binary release. Fixes #3634
2018-03-02 17:23:34 +00:00
gpg --recv-keys "6D5B EF9A DD20 7580 5747 B70F 9F88 FB52 FAF7 B393"
docs: reflow some really long lines I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and reflowed them where reasonable. Line length in the docs isn't too important (it doesn't matter once they're compiled), but it's nice not to have super-long lines in one's editor.
2020-03-11 23:09:12 +00:00
If GPG successfully imported the key, the output should include (among other things)::
...
gpg: Total number processed: 1
...
Add docs on how to verify a signed release Short howto on using gpg to verify a signed binary release. Fixes #3634
2018-03-02 17:23:34 +00:00
Improve formatting of GPG output in documentation
2018-03-05 13:21:20 +00:00
To verify for example the signature of the borg-linux64 binary::
Add docs on how to verify a signed release Short howto on using gpg to verify a signed binary release. Fixes #3634
2018-03-02 17:23:34 +00:00
gpg --verify borg-linux64.asc
Improve formatting of GPG output in documentation
2018-03-05 13:21:20 +00:00
GPG outputs if it finds a good signature. The output should look similar to this::
Add docs on how to verify a signed release Short howto on using gpg to verify a signed binary release. Fixes #3634
2018-03-02 17:23:34 +00:00
gpg: Signature made Sat 30 Dec 2017 01:07:36 PM CET using RSA key ID 51F78E01
gpg: Good signature from "Thomas Waldmann <email>"
gpg: aka "Thomas Waldmann <email>"
gpg: aka "Thomas Waldmann <email>"
gpg: aka "Thomas Waldmann <email>"
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.
Primary key fingerprint: 6D5B EF9A DD20 7580 5747 B70F 9F88 FB52 FAF7 B393
Subkey fingerprint: 2F81 AFFB AB04 E11F E8EE 65D4 243A CFA9 51F7 8E01
docs: reflow some really long lines I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and reflowed them where reasonable. Line length in the docs isn't too important (it doesn't matter once they're compiled), but it's nice not to have super-long lines in one's editor.
2020-03-11 23:09:12 +00:00
If you want to make absolutely sure that you have the right key, you need to
verify it via another channel and assign a trust-level to it.
Reference in a new issue Copy permalink