00_README.txt 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. Binary BorgBackup builds
  2. ========================
  3. General notes
  4. -------------
  5. The binaries are supposed to work on the specified platform without installing anything else.
  6. There are some limitations, though:
  7. - for Linux, your system must have the same or newer glibc version as the one used for building
  8. - for macOS, you need to have the same or newer macOS version as the one used for building
  9. - for other OSes, there are likely similar limitations
  10. If you don't find something working on your system, check the older borg releases.
  11. *.asc are GnuPG signatures - only provided for locally built binaries.
  12. *.exe (or no extension) is the single-file fat binary.
  13. *.tgz is the single-directory fat binary (extract it once with tar -xzf).
  14. Using the single-directory build is faster and does not require as much space
  15. in the temporary directory as the self-extracting single-file build.
  16. macOS: to avoid issues, download the file via the command line OR remove the
  17. "quarantine" attribute after downloading:
  18. $ xattr -dr com.apple.quarantine borg-macos1012.tgz
  19. Download the correct files
  20. --------------------------
  21. Binaries built on GitHub servers
  22. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23. borg-linux-glibc235-x86_64-gh Linux AMD/Intel (built on Ubuntu 22.04 LTS with glibc 2.35)
  24. borg-linux-glibc235-arm64-gh Linux ARM (built on Ubuntu 22.04 LTS with glibc 2.35)
  25. borg-macos-14-arm64-gh macOS Apple Silicon (built on macOS 14 w/o FUSE support)
  26. borg-macos-13-x86_64-gh macOS Intel (built on macOS 13 w/o FUSE support)
  27. Binaries built locally
  28. ~~~~~~~~~~~~~~~~~~~~~~
  29. borg-linux-glibc241-x86_64 Linux (built on Debian 13 "Trixie" with glibc 2.41)
  30. borg-linux-glibc236-x86_64 Linux (built on Debian 12 "Bookworm" with glibc 2.36)
  31. borg-linux-glibc231-x86_64 Linux (built on Debian 11 "Bullseye" with glibc 2.31)
  32. borg-freebsd-14-x86_64 FreeBSD (built on FreeBSD 14)
  33. Note: if you don't find a specific binary here, check release 1.4.1 or 1.2.9.
  34. Verifying your download
  35. -----------------------
  36. I provide GPG signatures for files which I have built locally on my machines.
  37. To check the GPG signature, download both the file and the corresponding
  38. signature (*.asc file) and then (on the shell) type, for example:
  39. gpg --recv-keys 9F88FB52FAF7B393
  40. gpg --verify borgbackup.tar.gz.asc borgbackup.tar.gz
  41. The files are signed by:
  42. Thomas Waldmann <tw@waldmann-edv.de>
  43. GPG key fingerprint: 6D5B EF9A DD20 7580 5747 B70F 9F88 FB52 FAF7 B393
  44. My fingerprint is also in the footer of all my BorgBackup mailing list posts.
  45. Provenance attestations for GitHub-built binaries
  46. -------------------------------------------------
  47. For binaries built on GitHub (files with a "-gh" suffix in the name), we publish
  48. an artifact provenance attestation that proves the binary was built by our
  49. GitHub Actions workflow from a specific commit or tag. You can verify this using
  50. the GitHub CLI (gh). Install it from https://cli.github.com/ and make sure you
  51. use a recent version that supports "gh attestation".
  52. Practical example (Linux, 2.0.0b20 tag):
  53. curl -LO https://github.com/borgbackup/borg/releases/download/2.0.0b20/borg-linux-glibc235-x86_64-gh
  54. gh attestation verify --repo borgbackup/borg --source-ref refs/tags/2.0.0b20 borg-linux-glibc235-x86_64-gh
  55. If verification succeeds, gh prints a summary stating the subject (your file),
  56. that it was attested by GitHub Actions, and the job/workflow reference.
  57. Installing
  58. ----------
  59. It is suggested that you rename or symlink the binary to just "borg".
  60. If you need "borgfs", just also symlink it to the same binary; it will
  61. detect internally under which name it was invoked.
  62. On UNIX-like platforms, /usr/local/bin/ or ~/bin/ is a nice place for it,
  63. but you can invoke it from anywhere by providing the full path to it.
  64. Make sure the file is readable and executable (chmod +rx borg on UNIX-like
  65. platforms).
  66. Reporting issues
  67. ----------------
  68. Please first check the FAQ and whether a GitHub issue already exists.
  69. If you find a NEW issue, please open a ticket on our issue tracker:
  70. https://github.com/borgbackup/borg/issues/
  71. There, please give:
  72. - the version number (it is displayed if you invoke borg -V)
  73. - the sha256sum of the binary
  74. - a good description of what the issue is
  75. - a good description of how to reproduce your issue
  76. - a traceback with system info (if you have one)
  77. - your precise platform (CPU, 32/64-bit?), OS, distribution, release
  78. - your Python and (g)libc versions