borg/docs/usage/general
Thomas Waldmann 9ff9eb436f
windows: fix platformdirs directories, fixes #10237
borg called platformdirs with the appname only, so on Windows the
appauthor component defaulted to the appname and all default
directories ended up under a doubled AppData\...\borg\borg path.

Pass appauthor=False everywhere (no vendor directory level; on
Linux/macOS the appauthor is unused, so nothing changes there) and
roaming=True for the config dir, restoring the layout the CHANGES
upgrade notes had documented as intended all along:

- config (incl. keys): C:\Users\<user>\AppData\Roaming\borg
  (follows the user's roaming profile in domain environments)
- data (incl. security state): C:\Users\<user>\AppData\Local\borg
- cache: C:\Users\<user>\AppData\Local\borg\Cache
- runtime: C:\Users\<user>\AppData\Local\Temp\borg

This matches what comparable tools do on Windows (pip, rclone and
kopia keep the configuration in the roaming AppData and machine
state/caches in the local AppData, all without a vendor directory).
The cache keeps platformdirs' opinionated "Cache" subdir so the
CACHEDIR.TAG written into the cache root stays out of the data dir.

Only Windows is affected. The first Windows binary was only released
with 2.0.0b23, so beta users needing to migrate should be rare: move
the keys from the old %LOCALAPPDATA%\borg\borg\keys to the new
location (or set the BORG_* dir env vars to the old paths); cache and
security state are recreated as needed.

Docs: update the environment help topic (and the generated
environment.rst.inc), FAQ, key/transfer usage docs and CHANGES.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-30 19:16:22 +02:00
..
archive-specification.rst.inc docs: archive specification, FAQ, fixes #9248, fixes #9053 2026-03-06 21:36:05 +01:00
config.rst.inc docs: fix borg1-era content in quickstart, general includes and misc 2026-08-28 12:38:31 +02:00
date-time.rst.inc Renames --since to --from 2026-06-20 18:36:59 +02:00
environment.rst.inc windows: fix platformdirs directories, fixes #10237 2026-08-30 19:16:22 +02:00
file-metadata.rst.inc illumos/Solaris: add xattr support, see #1337 2026-08-14 16:47:22 +02:00
file-systems.rst.inc docs: fix borg1-era content in quickstart, general includes and misc 2026-08-28 12:38:31 +02:00
logging.rst.inc fixed typos and grammar (AI) 2025-09-23 14:56:23 +02:00
positional-arguments.rst.inc docs: fix borg1-era content in quickstart, general includes and misc 2026-08-28 12:38:31 +02:00
repository-locations.rst.inc manual corrections/reverts 2025-09-23 14:56:35 +02:00
repository-urls.rst.inc docs: complete and correct the repository URL reference 2026-08-29 14:41:54 +02:00
resources.rst.inc docs: fix borg1-era content in quickstart, general includes and misc 2026-08-28 12:38:31 +02:00
return-codes.rst.inc Fix return code docs 2026-07-24 12:24:20 +02:00
units.rst.inc docs: fix borg1-era content in quickstart, general includes and misc 2026-08-28 12:38:31 +02:00