A microservice that makes adding authentication with Google and Github to your application easy.
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, Lapis and Docker. This enables the service to be very performant and requires only minimal system resources.
docker-compose -f docker-compose-dev.yml up
docker-compose up
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 loginhttp://localhost:8080/auth/google
: For Google loginSetup
Visit Google Developers Console and create a new application on Google. Then go to 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.
Setup
Visit GitHub 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.
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.
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.
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_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 successfulGITHUB_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 successfulSee LICENSE