Authenticator/README.md

81 lines
1.8 KiB
Markdown
Raw Normal View History

2018-09-23 10:36:52 +00:00
<a href="https://flathub.org/apps/details/com.github.bilelmoussaoui.Authenticator">
<img src="https://flathub.org/assets/badges/flathub-badge-i-en.png" width="190px" />
</a>
2017-04-01 14:05:10 +03:00
2018-03-16 04:12:49 +01:00
# Authenticator
2019-01-10 10:45:00 -06:00
<img src="https://gitlab.gnome.org/World/Authenticator/raw/master/data/icons/hicolor/scalable/apps/com.github.bilelmoussaoui.Authenticator.svg" width="128" height="128" />
2018-09-02 15:31:58 +02:00
<p>Two-factor authentication code generator for GNOME. Created with love using Python and GTK+.</p>
2017-04-01 14:02:11 +03:00
2018-03-19 23:17:41 +01:00
## Screenshots
2018-09-09 19:47:03 +02:00
<p align="center">
2018-09-10 17:56:43 +02:00
<img align="center" src="data/screenshots/screenshot1.png" />
2018-09-09 19:47:03 +02:00
</p>
2018-03-19 23:17:41 +01:00
## Features
- QR code scanner
- Beautiful UI
- Huge database of (290+) websites/applications
## Installation
### Flatpak
2018-09-02 15:31:58 +02:00
You can install the `flatpak` package of the application from Flathub using
2018-03-19 23:17:41 +01:00
```
flatpak install flathub com.github.bilelmoussaoui.Authenticator
```
### Distribution packaging
- Pop!\_OS (18.10+): `gnome-authenticator`
2018-09-10 00:32:46 +02:00
2018-03-19 23:17:41 +01:00
### Building from source code
#### Dependecies
2017-04-01 14:02:11 +03:00
2016-05-27 14:56:58 +02:00
- `Python 3.3+`
2016-05-31 02:15:30 +02:00
- `Gtk 3.16+`
2018-09-09 19:47:03 +02:00
- `meson 0.42+`
- `ninja`
- `pyotp`
2018-09-02 15:05:51 +02:00
- `libsecret`
2018-09-02 15:31:58 +02:00
Those dependencies are only used if you build the application with QR code scanner support
- `Pillow`
2018-03-16 20:28:49 +01:00
- `pyzbar` depends on `zbar`
2017-09-16 14:15:40 +02:00
- `libzbar-dev` on Ubuntu
- `zbar` on Arch
2016-05-27 14:56:58 +02:00
2016-05-27 14:31:04 +02:00
1 - Clone the repository
2017-09-16 14:15:40 +02:00
2016-05-27 14:31:04 +02:00
```bash
2018-09-23 10:36:52 +00:00
git clone https://gitlab.gnome.org/World/Authenticator && cd ./Authenticator
2016-05-27 14:31:04 +02:00
```
2017-09-16 14:15:40 +02:00
2018-09-11 16:45:47 +00:00
2 - Install the dependencies
2018-08-08 11:05:47 +02:00
2018-09-11 16:45:47 +00:00
3 - Afterwards
2017-09-16 14:15:40 +02:00
2016-05-27 14:31:04 +02:00
```bash
2017-09-16 14:15:40 +02:00
meson builddir
sudo ninja -C builddir install
2016-05-27 14:31:04 +02:00
```
2017-09-16 14:15:40 +02:00
2018-09-11 16:45:47 +00:00
4 - You can run the application from the desktop file or from the terminal using
2016-05-27 14:56:58 +02:00
```bash
2018-03-16 04:12:49 +01:00
authenticator
2016-05-31 22:08:35 +02:00
```
2017-09-16 14:15:40 +02:00
2018-03-19 23:17:41 +01:00
## Flags
2017-09-16 14:15:40 +02:00
- `--version`
Shows the version number of the application
2018-09-09 01:20:51 +02:00
- `--debug`
Enable the debug logs
2017-09-16 14:15:40 +02:00
2018-03-19 23:17:41 +01:00
## Credits
2018-09-02 15:31:58 +02:00
- Database for applications/websites from [twofactorauth](https://github.com/2factorauth/twofactorauth), by the 2factorauth team