Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hypebeast/micro-auth
A microservice that makes adding authentication with Google and Github to your application easy.
https://github.com/hypebeast/micro-auth
authentication docker docker-compose github google lapis nginx openresty
Last synced: 27 days ago
JSON representation
A microservice that makes adding authentication with Google and Github to your application easy.
- Host: GitHub
- URL: https://github.com/hypebeast/micro-auth
- Owner: hypebeast
- License: mit
- Created: 2017-02-19T20:51:55.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-23T20:47:47.000Z (over 7 years ago)
- Last Synced: 2024-04-14T14:16:13.631Z (8 months ago)
- Topics: authentication, docker, docker-compose, github, google, lapis, nginx, openresty
- Language: Lua
- Size: 10.7 KB
- Stars: 469
- Watchers: 16
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-resty - micro-auth
README
# micro-auth
A microservice that makes adding authentication with Google or GitHub to your application easy.
This service allows you to use Google and GitHub OAuth2 service to add authentication to your applications in a very straightforward way.
It's build with [Nginx/OpenResty](https://openresty.org/en/), [Lapis](http://leafo.net/lapis/) and [Docker](https://www.docker.com/). This enables the service to be very performant and requires only minimal system resources.
## Features
* Use [Google](https://developers.google.com/identity/protocols/OAuth2) or [GitHub](https://developer.github.com/v3/oauth/) OAuth2 authentication to provide a simple login mechanism for your application.
* Quick setup with [Docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/). With support for development and production environments.
* Based on [Lapis](http://leafo.net/lapis) and [Nginx/OpenResty](https://openresty.org/en/).
## Getting started
* Install (if you don't have them):
* [Docker](https://www.docker.com/)
* [docker-compose](https://docs.docker.com/compose/)
* Setup required [environment variables](#environment-variables)
* Run in _development_ mode:
* Run the application with `docker-compose -f docker-compose-dev.yml up`
* Run in _production_ mode:
* Run the application with `docker-compose up`
* Once `micro-auth` is running, you can point your login to one of the following urls (URLs are for development mode):
* `http://localhost:8080/auth/github`: For GitHub login
* `http://localhost:8080/auth/google`: For Google login
## Authentication Services
### Google
**Setup**
Visit [Google Developers Console](https://console.developers.google.com) and create a new application on Google.
Then go to [Credentials](https://console.developers.google.com/apis/credentials) and create a new _OAuth Client ID_.
Now, get the _Client ID_ and _Client secret_.
**Endpoints**
* `http://localhost:8080/auth/google`: Endpoint for Google authentication. Point your application to this endpoint to login with Google.
**Results**
After successful authentication with Google the user is redirect to the URL specified in `GOOGLE_REDIRECT_URL` with the access token saved in the `access_token` query parameter.
### GitHub
**Setup**
Visit [GitHub](https://github.com/settings/applications/new) and create a new application on GitHub to get your client id and secret.
**Endpoints**
* `http://localhost:8080/auth/github`: Endpoint for GitHub authentication. Point your application to this endpoint to login with Github.
**Results**
After successful authentication with GitHub the user is redirect to the URL specified in `GITHUB_REDIRECT_URL` with the access token saved in the `access_token` query parameter.
## Environment variables
To use the service you must set some required environment variables. These variables can be set in the `.env` file. Just copy `.env.example` to `.env`
```
$ cp .env.example .env
```
end set the required variables.
## Secrets in docker swarm
Setting the above environment variables with `_FILE` pointed at the secret mount inside the container. `-e GOOGLE_SECRET_FILE=/run/secrets/google_secret`. This will set the contents on the file as the value of the environment variable.
### General
* `APP_URL`: Specify the URL of `micro-auth` (default: `http://localhost:8080` in development mode). The `APP_URL` must be set in production mode.
### Google
* `GOOGLE_CLIENT_ID`: The Google application client id (required)
* `GOOGLE_CLIENT_SECRET`: The Google application client secret (required)
* `GOOGLE_REDIRECT_URL`: The url to redirect the user once the authentication was successful
### GitHub
* `GITHUB_CLIENT_ID`: The GitHub application client id (required)
* `GITHUB_CLIENT_SECRET`: The GitHub application client secret (required)
* `GITHUB_REDIRECT_URL`: The url to redirect the user once the authentication was successful
## License
See [LICENSE](./LICENSE)
## Credits
* [micro-github](https://github.com/mxstbr/micro-github)