Skip to content

About

Self-hosted viewer for a full Google Takeout (mail, chat, calendar, Drive, contacts, Keep…). Extract your export, mount it read-only, docker compose up, browse it like the original apps. Full-text search, no telemetry, no outbound calls, localhost-only with a first-run password.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

102 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TakeoutLens

A self-hosted viewer for a Google Takeout export. Read your mail, browse chats, walk your Drive like a file manager, see your calendar, photos, contacts, Keep notes, tasks, groups and YouTube history, all locally.

  • Read-only. Your export is never modified. Everything derived (a SQLite index, the password hash, sessions) lives in a separate data folder.
  • Local only. No runtime network calls, no telemetry. The server accepts requests only for localhost hosts.
  • Password-protected. On first run you choose a password; it is stored as a salted scrypt hash.
  • Desktop only. Below 1024px wide a block screen is shown instead of the app.

1. Extract your export

Download the export from Google Takeout and extract every archive into one folder, so you have either <folder>/Takeout/{Mail,Drive,...} or <folder>/{Mail,Drive,...}. Either works. Folder names are expected in English.

2. Run it

Docker (default)

TAKEOUT_DIR=/path/to/extracted/export docker compose up --build

Open http://localhost:3000. The export is mounted read-only at /takeout, the port is published on 127.0.0.1 only, and the index and password live in the viewer-data volume.

If indexing is slow with Docker Desktop bind mounts on your machine, run natively instead.

Native

Requires Node 24 and pnpm 12.

pnpm install
TAKEOUT_DIR=/path/to/extracted/export DATA_DIR=./.data pnpm build
TAKEOUT_DIR=/path/to/extracted/export DATA_DIR=./.data pnpm start

3. Index

On first visit you set a password, then press Reindex in the sidebar (or run pnpm index). The indexer is a separate process with its own memory limit; it is incremental, so later runs only read what changed. Reference timing on a 45GB export (about 12k files): a full index takes about 2 minutes in Docker.

Configuration

Copy .env.example to .env.local (native) or .env (Docker compose) and edit it.

Variable Default Purpose
TAKEOUT_DIR ./takeout Extracted export (read-only)
DATA_DIR ./.data (/data in Docker) Index, auth.json, sessions
ALLOWED_HOSTS none Extra hostnames accepted in the Host header (for a reverse proxy)

Privacy and reset

Everything in the data folder is derived from your export, including message text in the search index, so treat it as private as the export itself.

  • Forgot the password: delete auth.json in the data folder and reload.
  • Full reset: docker compose down -v (Docker) or delete the data folder (native).

Publishing the image (maintainers)

.github/workflows/docker-publish.yml builds linux/amd64 and linux/arm64 on native runners and pushes one multi-arch image to Docker Hub as <user>/takeout-viewer when a v* tag is pushed (or manually). Set the repository variable DOCKERHUB_USERNAME and the secret DOCKERHUB_TOKEN first.

Development

pnpm dev                 # dev server
pnpm typecheck && pnpm lint && pnpm check:conventions && pnpm test
pnpm test:e2e            # Playwright smoke test (needs a running server, see e2e/)

Tests use a synthetic export generated by tests/fixture/generate.ts; real export data never belongs in the repo.

Notes

Product icons in public/google/ are Google trademarks, included for recognisability and not covered by the MIT license.

MIT licensed, see LICENSE.

About

Self-hosted viewer for a full Google Takeout (mail, chat, calendar, Drive, contacts, Keep…). Extract your export, mount it read-only, docker compose up, browse it like the original apps. Full-text search, no telemetry, no outbound calls, localhost-only with a first-run password.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages