ente/README.md
2023-04-17 19:12:20 +05:30

4 KiB

ente Authenticator

ente's Authenticator app helps you generate and store 2 step verification (2FA) tokens on your mobile devices.

Download now

App Screenshots

Features

Secure Backups

ente provides end-to-end encrypted cloud backups so that you don't have to worry about losing your tokens. We use the same protocols ente Photos uses to encrypt and preserve your data.

Multi Device Synchronization

ente will automatically sync the 2FA tokens you add to your account, across all your devices. Every new device you sign into will have access to these tokens.

Offline Mode

ente generates 2FA tokens offline, so your network connectivity will not get in the way of your workflow.

Import and Export Tokens

You can add tokens to ente by one of the following methods:

  1. Scanning a QR code
  2. Manually entering (copy-pasting) a 2FA secret
  3. Bulk importing from a file that contains a list of codes in the following format:
otpauth://totp/provider.com:you@email.com?secret=YOUR_SECRET

The codes maybe separated by new lines or commas.

You can also export the codes you have added to ente, to an unencrypted text file, that adheres to the above format.

📲 Download

Android

This repository's GitHub releases contains APKs, built straight from source. These builds keep themselves updated, without relying on third party stores.

You can alternatively install the build from PlayStore or F-Droid.

Get it on Google Play

Get it on F-Droid

iPhone / Apple Silicon

Download on AppStore

Web

You can view your 2FA codes at auth.ente.io. For adding or managing your secrets, please use our mobile app.

Desktop

Support for desktop platforms (Linux, Windows and older Macs) is a work in progress.

Please this repo to be notified of updates.

🔩 Architecture

The architecture that powers end-to-end encrypted storage and sync of your tokens has been documented here.

🧑‍💻 Building from source

  1. Install Flutter
  2. Clone this repository with git clone git@github.com:ente-io/auth.git
  3. Pull in all submodules with git submodule update --init --recursive
  4. For Android, run flutter build apk --release --flavor independent
  5. For iOS, run flutter build ios

For maintainers, there is additional documentation on automatically publishing the main branch to App store, Play store and GitHub releases.

🙋‍♂️ Support

If you need help, please reach out to support@ente.io, and a human will get in touch with you.

If you have feature requests, please create a GitHub issue.

If you wish to support us, please star this project.

🙌 Translation

Crowdin

If you're interested in helping out with translation, please visit our Crowdin project to get started. Thank you for your support.

💜 Community