26 Commits
Author SHA1 Message Date
Thomas WaldmannandClaude Opus 5.5 db0c4ac2c1 docs: ssh:// repository URLs, #9765
Describe ssh:// repository URLs for current repositories (served by a
remote "borg serve --rest") and for legacy borg 1.x repositories (with
--from-borg1, served by a remote "borg serve") and add a change log
entry.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-09-24 15:55:01 +02:00
Thomas WaldmannandClaude Fable 5 f36a3ac7ce docs: update deployment docs to borg2 commands and rest protocol
- pull-backup: switch the socat recipe to borg serve --rest with
  rest:// URLs (mechanism verified end-to-end; note added that socat
  pins the server-side --backend repo), fix the ssh-agent section
  (borg repo-create --encryption aes256-ocb --key-location repokey
  instead of borg init --encryption repokey, forced command with
  --rest and --restrict-to-repository), and fix the remote-forwarding
  example (rest:// URL, -r option, mandatory archive name).
- automated-local: borg init -> borg repo-create -r; convert the
  borg1 repo::archive syntax in the create calls.
- hosting-repositories: the authorized_keys forced command needs
  --rest (clients cannot supply it - it is deliberately not in the
  client-arg allowlist), plus repo-create wording.
- image-backup: borg list -> borg repo-list -r for the archive
  listing; add a note about archive series (names without timestamps
  match multiple archives on extract; use aid:<id>).

All replacement commands were run against scratch repositories; the
forced-command semantics were verified via Archiver.get_args().

Co-Authored-By: Claude Fable 5 <[email protected]>
2026-08-28 12:37:06 +02:00
Thomas Waldmann f144bac320 remove --rsh option, use BORG_RSH
Like --remote-path, --rsh was only honoured on the legacy (borg 1.x, ssh://)
code path. For borg2 repositories the remote shell command comes from
borgstore, which reads its own BORGSTORE_RSH environment variable, so --rsh
silently had no effect there.

Remove the option; BORG_RSH is now the only way to set the remote shell
command. For borgstore-based repositories, borg gives the BORG_RSH value to
borgstore as BORGSTORE_RSH, except if that was set explicitly (then the user
wants a different command for borgstore).

borg benchmark crud does not need to inherit --rsh / --remote-path into its
sub-invocations any more (environment variables are inherited anyway), so the
parse_args wrapper is gone.
2026-07-24 23:10:50 +02:00
TWandCopilot Autofix powered by AI 620e2534b8 Apply suggested fix to docs/deployment/pull-backup.rst from Copilot Autofix
Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
2026-05-14 00:18:42 +02:00
TWandCopilot Autofix powered by AI b404c36ae0 Apply suggested fix to docs/deployment/pull-backup.rst from Copilot Autofix
Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
2026-05-14 00:18:41 +02:00
TWandCopilot Autofix powered by AI 4fcc2cc1d2 Apply suggested fix to docs/deployment/pull-backup.rst from Copilot Autofix
Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
2026-05-14 00:18:41 +02:00
Thomas Waldmann f40878e1e7 docs: sshfs + chroot does support different CPU architectures, fixes #6878
(cherry picked from commit 49365617c4)
2026-05-13 20:19:46 +00:00
Thomas Waldmann 3120f9cd1c fixed typos and grammar (AI)
this was done by Junie AI.
2025-09-23 14:56:23 +02:00
Thomas Waldmann 9e6d90754e remove remainders of append-only support
Some features like append-only repositories rely on a server-side component
that enforces them (because that shall only be controllable server-side,
not client-side).

So, that can only work, if such a server-side component exists, which is the
case for borg 1.x ssh: repositories (but not for borg 1.x non-ssh: repositories).

For borg2, we currently have:
- fs repos
- sftp: repos
- rclone: repos (enabling many different cloud providers)
- s3/b3: repos
- ssh: repos using client/server rpc code similar as in borg 1.x

So, only for the last method we have a borg server-side process that could enforce some features, but not for any of the other repo types.

For append-only the current idea is that this should not be done within borg,
but solved by a missing repo object delete permission enforced by the storage.

borg create could then use credentials that miss permission to delete,
while borg compact would use credentials that include permission to delete.
2025-04-28 18:55:15 +02:00
vancheese 8df4bf75d4 docs: borg commands updated with --repo option, fixes #8550 2025-04-01 17:28:57 +02:00
Thomas Waldmann fbf463496b docs: fix some markup / linking issues 2023-06-11 23:03:21 +02:00
Dominik Stadler 753419d506 Suggest to use forced command when using remote-fowarding via ssh 2023-04-02 22:58:37 +02:00
Dominik Stadler d2ff0a3aab Adjust description some more, use back-quotes properly, add some links 2023-04-02 11:15:21 +02:00
Dominik Stadler 6ab281875e Adjust repository path 2023-04-02 11:05:31 +02:00
Dominik Stadler 8fab4e4152 Fix command and add more notes 2023-04-02 11:03:32 +02:00
Dominik Stadler 4216dfd12d Describe performing pull-backups via ssh remote forwarding 2023-04-02 10:52:36 +02:00
Paul D 253d8e8d4e Docs grammar fixes
joined split infinitives, and relocated adverbs appropriately.
2022-12-29 22:26:54 +00:00
Paul D a85b643866 Docs grammar fixes.
One cannot "to not x", but one can "not to x".
Avoiding split infinitives gives the added bonus that machine
translation yields better results.

setup (n/adj) vs set(v) up. We don't "I setup it" but "I set it up".

Likewise for login(n/adj) and log(v) in, backup(n/adj) and back(v) up.
2022-12-29 00:01:48 +00:00
Thalian b4d3859b9e #6407 - Document Borg 1.2 pattern behavior change
Make clear that absolute paths always go into the matcher as if they are relative (without leading slash). Adapt all examples accordingly.

fixes #6407
2022-05-27 14:13:12 +02:00
Michael Bauer 638774761c use --numeric-ids in pull doc
replace flag --numeric-owner with --numeric-ids
2022-03-09 21:43:22 +01:00
TW 1e7c1414b0 Merge pull request #5902 from ThomasWaldmann/pull-chroot-problematic-1.1
docs: pull mode: add some warnings, fixes #5827
2021-07-11 18:07:14 +02:00
Guinness 3278d253c5 Update the documentation on hacked backup client.
Fixes #5480.
2020-11-13 10:31:05 +01:00
aef5e89126 Add ssh-agent pull backup method to doc (#5288)
deployment docs: add ssh-agent pull backup method

Co-authored-by: Король Алексей <[email protected]> (main work)
Co-authored-by: Thomas Waldmann <[email protected]>
2020-09-25 14:20:29 +02:00
Benedikt Seidl 6a1f31bf29 [DOCS] Add socat pull mode (#5150)
docs: describe socat pull mode, fixes #900

also: fix sphinx deprecation warning

borg/docs/conf.py:114: RemovedInSphinx40Warning: The app.add_stylesheet() is deprecated. Please use app.add_css_file() instead.
2020-06-23 02:09:35 +02:00
Thalian 08a7661e67 [FEATURE] #4489 – Deprecate --nobsdflags option
Replaced by --noflags. In internal data structure the key 'bsdflags' is kept for backwards compatibility.
2020-03-25 06:35:15 +01:00
Thalian a89539439e #1552 Deployment Pull Backup (#4804)
docs: add a pull backup / push restore how-to, fixes #1552
2019-11-02 13:48:32 +01:00