Skip to content

doc: clarify that tgz takeout archives must be extracted before import - #1389

Open
luke3butler wants to merge 2 commits into
simulot:mainfrom
luke3butler:docs/tgz-clarification
Open

luke3butler wants to merge 2 commits into
simulot:mainfrom
luke3butler:docs/tgz-clarification

Conversation

@luke3butler

Copy link
Copy Markdown

The docs imply tgz takeouts import directly — best-practices.md warns "Don't mix ZIP and TGZ formats in the same import" — but internal/fshelper/parseArgs.go rejects .tgz/.tar.gz with immich-go can't use tgz archives.

This updates the docs to match the code:

  • docs/best-practices.md: replace the mixed-formats bullet with guidance to prefer ZIP, and to extract TGZ takeouts (all parts into one folder tree) before importing
  • docs/commands/upload.md: add the same note under from-google-photos usage

Related: #36 (original tgz request), #1387 (error accumulation in the same code path).

best-practices.md implied tgz archives were importable; parseArgs.go
rejects .tgz/.tar.gz. Recommend zip, and tell tgz users to extract all
parts into one folder tree first.
@luke3butler
luke3butler requested a review from simulot as a code owner July 9, 2026 18:20
Passing each extracted part folder works: the takeout adapter merges
all path arguments into one catalog keyed by relative path. What breaks
matching is passing the parts' parent directory, or importing parts in
separate runs.
@arturict

Copy link
Copy Markdown

Great docs improvement. It may help to include an explicit warning snippet for users when tgz archives are not extracted.

BeLazy167 added a commit to BeLazy167/immich-go that referenced this pull request Sep 13, 2026
immich-go rejects .tgz/.tar.gz Google Takeout parts by design (gzip
streams cannot be seeked, see simulot#36, simulot#96, simulot#1038), but the error only said
the archive can't be used. Users hit this after downloading hundreds of
GB and are left guessing. Say what to do: extract all parts into one
folder and pass the folder, or re-export as ZIP.

Complements simulot#1389 (docs).

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants