ente/auth/README.md

3.5 KiB
Raw Permalink Blame History

Ente Auth

Ente's 2FA app. An end-to-end encrypted, cross platform and free app for storing your 2FA codes with cloud backups. Works offline. You can even use it without signing up for an account if you don't want the cloud backups or multi-device sync.

App Screenshots

📲 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.

iOS / Apple Silicon macOS

Desktop

You can download a native desktop app from this repository's GitHub releases. The desktop app works on Windows, Linux and macOS.

Web

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

🧑‍💻 Build from source

  1. Install Flutter

  2. Pull in all submodules with git submodule update --init --recursive

  3. For Android, setup your keystore and run flutter build apk --release --flavor independent

  4. For iOS, run flutter build ios

⚙️ Develop

For Android, use

flutter run -t lib/main.dart --flavor independent

For iOS, use flutter run

VSCode users might find it useful to copy docs/vscode into a top level .vscode.

If the code you're working needs to modify user facing strings, see docs/localization.

🔩 Architecture

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

🌍 Translate

Crowdin

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

If your language is not listed for translation, please create a GitHub issue to have it added.

🧑‍🎨 Icons

Ente Auth supports the icon pack provided by simple-icons. If you wish to add more, see docs/adding-icons.

💚 Contribute

For more ways to contribute, see ../CONTRIBUTING.md.

You can also support us by giving this project a star on GitHub or by leaving a review on PlayStore, AppStore or AlternativeTo.

About

To know more about Ente and the ways to get in touch or seek help, see our main README or visit ente.io.