Authenticator/README.md

55 lines
1.7 KiB
Markdown
Raw Normal View History

2016-06-19 15:35:36 +02:00
![Status](https://img.shields.io/badge/status-stable-green.svg) [![Version](https://img.shields.io/badge/version-0.1beta2-green.svg)](https://github.com/bil-elmoussaoui/Gnome-TwoFactorAuth/releases) ![Python
2016-06-05 14:53:43 +02:00
version](https://img.shields.io/badge/python-3.3%2B-blue.svg)
2016-05-27 14:31:04 +02:00
2016-06-05 14:53:43 +02:00
# Gnome TwoFactorAuth
Two-factor authentication code generator for Gnome <br>
2016-05-29 04:05:19 +02:00
For translators : https://www.transifex.com/twofactorauth/twofactorauth/
2016-06-19 15:35:36 +02:00
### Dependecies
2016-05-27 14:56:58 +02:00
- `Python 3.3+`
2016-05-31 02:15:30 +02:00
- `Gtk 3.16+`
2016-05-27 14:56:58 +02:00
- `PyOTP`
2016-06-19 15:35:36 +02:00
- `zbarlight`
2016-05-30 18:08:51 +02:00
- `GnomeKeyring`
2016-05-27 14:56:58 +02:00
2016-05-30 22:18:39 +02:00
<sub>PS: The application was only tested on Arch with Gtk 3.20+, but it should work nicely with older versions too. Keyboard shortcuts widget won't be shown for older versions.</sub>
2016-05-27 14:31:04 +02:00
### Screenshots
2016-05-29 22:27:28 +02:00
<img src="screenshots/screenshot7.png" width="280" /> <img src="screenshots/screenshot1.png" width="280" /> <img src="screenshots/screenshot2.png" width="280" />
2016-05-27 14:31:04 +02:00
2016-05-31 20:21:43 +02:00
### Installation
2016-05-31 22:08:35 +02:00
- On Arch :
```bash
yaourt -S gnome-twofactourauth
2016-06-19 15:35:36 +02:00
```
2016-05-31 20:21:43 +02:00
2016-05-27 14:56:58 +02:00
### Credits
- Websites and application icons are from Paper theme, created by [Sam Hewitt](https://github.com/snwh)
2016-05-31 20:21:43 +02:00
### How to build from source
2016-05-27 14:31:04 +02:00
1 - Clone the repository
```bash
git clone https://github.com/bil-elmoussaoui/TwoFactorAuth && cd ./TwoFactorAuth
```
2016-05-27 14:56:58 +02:00
2 - Install `PyOTP`
```bash
sudo pip install pyotp
```
2016-06-19 15:35:36 +02:00
3 - Install `zbarlight`
```bash
sudo pip install zbarlight
```
2016-05-27 20:33:00 +02:00
<sub>PS : In some distributions you will need to use `pip3` instead of `pip` to install the compatible version of the package with Python 3.</sub> <br>
2016-06-19 15:35:36 +02:00
4 - Afterwards
2016-05-27 14:31:04 +02:00
```bash
2016-05-31 22:08:35 +02:00
./autogen.sh
make
sudo make install
2016-05-27 14:31:04 +02:00
```
2016-06-19 15:35:36 +02:00
5 - You can run the application from the desktop file or from terminal using
2016-05-27 14:56:58 +02:00
```bash
2016-06-02 23:12:05 +02:00
gnome-twofactorauth
2016-05-31 22:08:35 +02:00
```
2016-06-19 15:35:36 +02:00
<sub>Arch users can build from source directly using AUR `yaourt -S gnome-twofactorauth-git`</sub>