borgbackup/borgbackup.github.io

BorgBackup project web site

borgbackup.github.io's Issues

misc site issues since support move

1. https://www.borgbackup.org/support/free.html

• "issue tracker" -> link is broken (2x, once in issue tracker, once in bounties section)

• there should be a main heading, like "Free Support"

2. https://www.borgbackup.org/support/commercial.html

• there should be a main heading, like "Commercial Support and Services"

• the http(s) URLs should be links

3. https://www.borgbackup.org/

• "Fund development" link will be broken soon. Currently it still works as it links to "stable" docs (which are not "latest" docs), but if latest becomes stable, there is no bounty stuff there any more, because it is on the website now.

website logo / title misaligned

Bold green "Borg" letters are hanging out to the left of the bigger black box.

Suggestion to add pip dependencies

On https://borgbackup.readthedocs.io/en/stable/installation.html#using-pip I suggest to add:

• pip install setuptools
• pip install cython

as these are essential for performing

• pip install borgbackup

then.

Automate build, put generated HTML on different branch than source files

Data integrity error shown by extract dry run, after create and prune exit 0

Environment

• Borgbackup 1.1.16, recently upgraded from 1.1.14 (that was a fresh-install, and suffered the same issue)
• OS RedHat EL8 virtual machines under KVM/OpenStack
• Filesystem is XFS, on top of CEPH provided by the same OpenStack (no CEPH issues observed across the other systems)

Borg Backup architecture

• Each virtual machine (data-vm) runs Borgbackup where there are the data files, and do a remote backup over ssh to some another virtual machine (repo-vm) running the same Borgbackup version 1.1.16
• As soon as the backup is done, and exits 0 in the data-vm, the prune is started in the repo-vm, and exits 0 too.
• Finally the repo-vm starts the execution of borg extract --dry-run because we want to ensure repo consistency after each run (and before the repo is further rsynced)

The issue

Sometimes (3 times in a couple of month) the borg extract --dry-run fails with the error below.

Data integrity error: Invalid segment entry size 0 - too small [segment 142, offset 37070417]

Traceback (most recent call last):
  File "borg/archiver.py", line 4690, in main
  File "borg/archiver.py", line 4622, in run
  File "borg/archiver.py", line 177, in wrapper
  File "borg/archiver.py", line 192, in wrapper
  File "borg/archiver.py", line 805, in do_extract
  File "borg/archive.py", line 605, in extract_item
  File "borg/archive.py", line 251, in fetch_many
  File "borg/repository.py", line 1131, in get_many
  File "borg/repository.py", line 1125, in get
  File "borg/repository.py", line 1497, in read
  File "borg/repository.py", line 1524, in _read
borg.helpers.IntegrityError: Data integrity error: Invalid segment entry size 0 - too small [segment 142, offset 37070417]

Platform: Linux hostname.openstack.internal 4.18.0-240.10.1.el8_3.x86_64 #1 SMP Wed Dec 16 03:30:52 EST 2020 x86_64
Linux: Red Hat Enterprise Linux 8.3 Ootpa
Borg: 1.1.16  Python: CPython 3.7.9 msgpack: 0.5.6.+borg1
PID: 700096  CWD: /home/bckadmin
sys.argv: ['borg', 'extract', '-v', '--dry-run', '/data/bck/bit::bit_20210715']
SSH_ORIGINAL_COMMAND: None

I've read that in most of the posts complaining about this issue the designated culprit is the block device, but i would like to resist that the CEPH is consistent..

make version selector better discoverable

Suggestion from a user who overlooked the version selector:
"""
I just now saw the drop-down in the bottom right corner to select the different versions on that docs page. I wonder if that feature would be more intuitive/obvious if it were in the upper left corner of the page (like next to the logo/version).
"""

Increase tap target size

Specifically the menu buttons. Should apparently be minimum 48pxX48px https://developer.chrome.com/docs/lighthouse/seo/tap-targets/

Issue flagged via google lighthouse

dns and https setup for (www.)borgbackup.org

DNS zone borgbackup.org:

@ IN A <IP from dig borgbackup.github.io>
www IN CNAME borgbackup.github.io.

Notes:

• first entry: CNAME does not work for @ thus one needs to lookup the IP(s) used by github and configure same IP(s) as A record(s) in DNS.
• second entry: github complains "incorrectly configured" if not like shown.

Github repo settings for borgbackup/borgbackup.github.io:

Custom domain: www.borgbackup.org

Notes:

• it is not possible to fill in multiple values in the form field, like:
  www.borgbackup.org borgbackup.org
• we used www.borgbackup.org - that redirects b.o --> www.b.o, which is wanted.
• if one used borgbackup.org, it would redirect like: www.b.o --> b.o

X Enforce https

Notes:

• this will fetch a letsencrypt cert
• sadly, it is only for www.borgbackup.org and not also for borgbackup.org, so the latter will have a mismatching cert.

replace enkore's deploy key

it's always a bit confusing to get notifies that an otherwise inactive contributor was active again.

so guess i better replace enkore's deploy key by an own one, see .travis/script.sh.

Introduce meta descriptions

To improve SEO. Example from https://developer.chrome.com/docs/lighthouse/seo/meta-description/

<head>
  <meta name="description" content="Author: A.N. Author,
      Illustrator: P. Picture, Category: Books, Price: $17.99,
      Length: 784 pages">
</head>

Issue flagged via google lighthouse

Introduce `aria-label` for links

For screenreader accessibility. Example from https://dequeuniversity.com/rules/axe/4.7/link-name

 <a href="taxhike.html" aria-label="Read more about Seminole tax hike">[Read more...]</a>

Issue flagged via google lighthouse

add total runtime for videos

https://www.borgbackup.org/demo.html <- for each of these videos.

The 'Edit me on Github' link gives 404

Steps:

• Go to http://borgbackup.readthedocs.org
• Click on the 'Edit me on Github' link
• view the groovy github 404

Navbar

The navbar is a dominant design for navigation. Opting for one would make it more intuitive for people to navigate. It would also be easy to embed it on every page, eliminating the need for a back button on each sub-page. Here is a mockup of what it could look like (design details would need some working)

What do you think?

Moving a repository results in inaccesiblity of contained archives

Please close

Add license

Currently this repo is unlicensed, implying full copyright. I assume that the license should be the BSD-3 clause license, but it should be clear in the repo. https://github.com/borgbackup/borg-import/blob/master/LICENSE

commercial.html - Hetzner is also supporting borgbackup

Hetzner is supporting borgbackup for their Storage Boxes

https://wiki.hetzner.de/index.php/BorgBackup/en#0._Activate_Borg_and_configure_your_storage_box

For Borg to be enabled on your storage box, you must first enable the service on the Robot webinterface. To do this, go to the settings page of your storage box on the Robot webinterface and click "activate" on "Borg support"

Inform people that demos are highlight-able

I was looking through the CSS to see if things could be minimized, and saw a lot of Asciinema assets. After looking into the project, I understood that the characters can be highlighted! This is very cool, but I was completely unaware, and guess I'm not the only one.

A small info at the top of the page could be enough. A small info at the beginning of each video would be ideal, but not sure if that is possible without re-recording them all.

Policy for entries for (commercial) service providers

Just to write it down and remember it:

• there should be a link to a page with borg-related information at the provider, preferably https
• there should be a generic, neutral, short description about what the provider is offering
• there should not be a "feature list"
  • this is something the provider can present (and keep uptodate) at the linked URL
  • we don't want a feature competition on our page, nor update lists of features when they change

Mobile view hides part of demo

On smaller screens, the demo screencasts are truncate on the right hand side. It seems like it might be worth updating Asciinema first (v2.4.1 used in this page is ~6 years old) before manually changing the CSS to fix this.

use github workflows to replace travis-ci

borgbackup/borg#5467

use real links to the service providers

https://www.borgbackup.org/support/commercial.html

needs some reformatting also for that.

Feed for releases?

Github provides a feed for releases (https://github.com/borgbackup/borg/releases.atom), which could be linked from the releases page.

add "related software"

Add such a section or navigation link list.

E.g.:
https://github.com/silvio/docker-borg

Incorrect version information; 1.2.5→1.2.6

https://www.borgbackup.org/releases/
Borg 1.2 is the current stable series of Borg. The current release is 1.2.5, released on 2023-08-30.
Current stable is 1.2.6 released on 2023-08-31

Off-site navigation

Docs, Community and Contribute all navigate off-site. Wikipedia has a "upper-right-arrow-out-of-box" icon, which is perhaps familiar for many. This is sadly not a UTF8 character.

Additionally, off-site links could be placed to the right hand side.

Also, I wonder if Contribute could be removed entirely, and rather add and icon bar to the bottom of the main page? (Along with matrix, IRC, mail list, mastodon, twitter...)

Automatically forward to `http *s*`

Possible small issues

Looking for feedback on whether these observations are issues or not, and if yes whether the suggested course of action is appropriate:

• demo subpage has the same on-page title as the home page. All other subpages have unique titles. Is this intentional, or should the title be change to "Demo screencasts" or something similar?
• releases has the page title (i.e. in <head>) of "index.rst". I guess this should be changed to "Releases — BorgBackup" for consistency?
• actually, all other page titles of subpages except for demo lack a "— BorgBackup" suffix. Should I add them?
• the on-page title on the home page (i.e. "Deduplicating archiver with compression and encryption") has an html line-break. This makes it look not so great on mobile. Should I try and replicate the effect (i.e. having "Deduplicating archiver" on a line by itself) in another way, or simply remove the <br>?