ente/README.md

96 lines
3 KiB
Markdown
Raw Normal View History

2022-11-14 14:32:32 +00:00
# ente Authenticator
2022-11-01 06:13:06 +00:00
2022-11-14 17:16:08 +00:00
ente's Authenticator app helps you generate and store 2 step verification (2FA)
2022-11-14 16:41:14 +00:00
tokens on your mobile devices.
2022-11-14 14:32:32 +00:00
2022-12-05 05:20:38 +00:00
![App Screenshots](./screenshots/screenshots.png)
2022-11-14 14:32:32 +00:00
## ✨ Features
2022-11-14 16:41:14 +00:00
### Secure Backups
2022-11-14 14:32:32 +00:00
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
2022-11-16 10:45:13 +00:00
Photos](https://ente.io) uses to encrypt and preserve your data.
2022-11-14 14:32:32 +00:00
2022-11-14 16:41:14 +00:00
### Multi Device Synchronization
2022-11-14 14:32:32 +00:00
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.
2022-11-14 16:41:14 +00:00
### Offline Mode
2022-11-14 14:32:32 +00:00
ente generates 2FA tokens offline, so your network connectivity will not get in
the way of your workflow.
2022-11-14 16:41:14 +00:00
### Import and Export Tokens
2022-11-14 14:32:32 +00:00
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/ACCOUNT?secret=SUPERSECRET&issuer=SERVICE
```
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.
2022-11-24 07:51:40 +00:00
## 📲 Download
2022-11-24 07:53:07 +00:00
### Android
2022-11-24 07:51:40 +00:00
2022-12-05 05:07:31 +00:00
This repository's [GitHub releases](https://github.com/ente-io/auth/releases/latest/download/ente-auth.apks) contains APKs, built straight from source. These builds keep themselves updated, without relying on third party stores.
2022-11-24 07:51:40 +00:00
2022-12-05 05:07:31 +00:00
You can alternatively install the build from PlayStore.
<a href="https://play.google.com/store/apps/details?id=io.ente.auth">
<img width="197" alt="Get it on Google Play" src="https://ente.io/static/ed265c3abdcd3efa5e29f64b927bcb44/e230a/play-store-badge.webp">
</a>
2022-11-24 07:51:40 +00:00
2022-11-24 07:53:07 +00:00
### iOS
2022-11-24 07:51:40 +00:00
2022-12-05 05:07:31 +00:00
<a href="https://apps.apple.com/us/app/ente-authenticator/id6444121398">
<img width="197" alt="Download on AppStore" src="https://user-images.githubusercontent.com/1161789/154795157-c4468ff9-97fd-46f3-87fe-dca789d8733a.png">
</a>
2022-11-24 07:51:40 +00:00
2022-12-09 09:17:19 +00:00
### Desktop
Support for desktop platforms (Linux, Mac and Windows) is a [work in progress](https://github.com/ente-io/auth/tree/desktop).
Please ⭐ this repo to be notified of updates.
2022-11-24 07:51:40 +00:00
2022-11-14 17:16:08 +00:00
## 🔩 Architecture
2022-11-14 14:32:32 +00:00
2022-11-14 17:16:08 +00:00
The architecture that powers end-to-end encrypted storage and sync of your
tokens has been documented [here](architecture/index.md).
2022-11-14 14:32:32 +00:00
## 🧑‍💻 Building from source
1. [Install Flutter](https://flutter.dev/docs/get-started/install)
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`
2022-11-14 17:16:08 +00:00
## 🙋‍♂️ Support
If you need help, please reach out to support@ente.io, and a human will get in
touch with you.
On the other hand, if you wish to support us, please
[star](https://github.com/ente-io/auth/stargazers) this project.
2022-11-14 14:32:32 +00:00
## 💜 Community
- Follow us on [Twitter](https://twitter.com/enteio)
- Join us on [Discord](https://ente.io/discord)