# Deploy Gmail Cleaner with Easypanel

URL: /templates/gmail-cleaner

Gmail Cleaner is a privacy-focused self-hosted tool to bulk unsubscribe, delete, archive, and mark Gmail messages as read by sender. It runs locally with your own Google OAuth credentials and keeps auth tokens in persistent storage.

## Installation notes

Paste your downloaded Google OAuth client JSON into Credentials JSON before deploying. In Google Cloud Console, add an Authorized redirect URI that uses your OAuth host and external OAuth port (for example, https://your-domain/). After deploy, open the app domain, click Sign In, and complete the OAuth flow.

## Benefits

### Inbox cleanup at scale

Process large amounts of email by sender with bulk actions and filters.

### Privacy-first deployment

Runs on your infrastructure with your own Google credentials.

### Persistent auth and data

Stores OAuth token and app data in a mounted volume.

## Features

### Bulk unsubscribe and delete

Remove unwanted newsletters and sender groups with progress tracking.

### Mark read, archive, and labels

Apply common Gmail mailbox actions in bulk.

### OAuth callback support

Exposes the callback listener port for Google OAuth login flow.

## Configuration

- `appServiceName` (App Service Name, required): gmail-cleaner

- `appServiceImage` (Gmail Cleaner Image, required): ghcr.io/gururagavendra/gmail-cleaner:v1.3.0

- `credentialsJson` (Credentials JSON, required): Set during installation — Paste the full Google OAuth client JSON content

- `oauthInternalPort` (OAuth Callback Internal Port): 8767

- `oauthExternalPort` (OAuth Callback External Port): 8767

- `oauthHost` (OAuth Host): $(PRIMARY_DOMAIN) — Hostname used when building OAuth redirect URI

- `webAuth` (Enable Web Authentication): true

## Services

- gmail-cleaner: app (ghcr.io/gururagavendra/gmail-cleaner:v1.3.0)

## Resources

- [Documentation](https://github.com/Gururagavendra/gmail-cleaner#readme)

- [GitHub](https://github.com/gururagavendra/gmail-cleaner)

- [Setup video](https://youtu.be/CmOWn8Tm5ZE)

- [Container registry](https://github.com/gururagavendra/gmail-cleaner/pkgs/container/gmail-cleaner)

- [Template source](https://github.com/easypanel-io/templates/tree/main/templates/gmail-cleaner)