commit
9c445f41d9
10
README.md
10
README.md
|
@ -1,5 +1,7 @@
|
|||
# two-factor-auth-server
|
||||
|
||||
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)][MIT License]
|
||||
[![Build](https://travis-ci.org/clems4ever/two-factor-auth-server.svg?branch=master)](https://travis-ci.org/clems4ever/two-factor-auth-server)
|
||||
|
||||
**two-factor-auth-server** is the simplest to set up HTTP 2-factor authentication server. It is compatible with NGINX auth_request module and is used in production to secure internal services in a swarm cluster.
|
||||
|
||||
|
@ -11,7 +13,9 @@ Before starting, make sure you don't have anything listening on port 8080. Then,
|
|||
docker-compose build
|
||||
docker-compose up -d
|
||||
|
||||
After few seconds the services should be running and you should be able to visit: http://localhost:8080/.
|
||||
After few seconds the services should be running and you should be able to visit [http://localhost:8080/](http://localhost:8080/) and access the login page:
|
||||
|
||||
![login-page](https://raw.githubusercontent.com/clems4ever/two-factor-auth-server/master/images/login.png)
|
||||
|
||||
### LDAP authentication
|
||||
An LDAP server has been deployed with the following credentials: **admin/password**.
|
||||
|
@ -21,7 +25,7 @@ You can use Google Authenticator for the verification of the TOTP token. You can
|
|||
|
||||
Test secret key: GRWGIJS6IRHVEODVNRCXCOBMJ5AGC6ZE
|
||||
|
||||
![secret-key](https://github.com/clems4ever/two-factor-auth-server/raw/master/secret-key.png)
|
||||
![secret-key](https://raw.githubusercontent.com/clems4ever/two-factor-auth-server/master/images/secret-key.png)
|
||||
|
||||
## Documentation
|
||||
two-factor-auth-server provides a way to log in using LDAP credentials and TOTP tokens. When the user is logged in,
|
||||
|
@ -48,7 +52,7 @@ And the parameters:
|
|||
| /_auth (POST) | { password: 'abc', username: 'user', token: '0982'} | @200 with access_token or @401 |
|
||||
|
||||
## Contributing to two-factor-auth-server
|
||||
Follow [contributing](CONTRIBUTING.md) file.
|
||||
Follow [contributing](CONTRIBUTORS.md) file.
|
||||
|
||||
## License
|
||||
two-factor-auth-server is **licensed** under the **[MIT License]**. The terms of the license are as follows:
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 40 KiB |
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "two-factor-auth-server",
|
||||
"version": "1.0.7",
|
||||
"version": "1.0.9",
|
||||
"description": "",
|
||||
"main": "src/index.js",
|
||||
"scripts": {
|
||||
|
|
Loading…
Reference in New Issue