https://github.com/ivandotv/grant-server
This module is a packaged Grant OAuth proxy server. That means that you can just install this package and run grant-serve to have a proxy OAuth server running. Docker image is also available.
https://github.com/ivandotv/grant-server
docker-image oauth oauth2 oauth2-server proxy proxy-oauth-server
Last synced: about 1 year ago
JSON representation
This module is a packaged Grant OAuth proxy server. That means that you can just install this package and run grant-serve to have a proxy OAuth server running. Docker image is also available.
- Host: GitHub
- URL: https://github.com/ivandotv/grant-server
- Owner: ivandotv
- License: mit
- Created: 2020-06-26T20:05:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T19:29:53.000Z (over 1 year ago)
- Last Synced: 2025-04-10T23:16:35.039Z (about 1 year ago)
- Topics: docker-image, oauth, oauth2, oauth2-server, proxy, proxy-oauth-server
- Language: TypeScript
- Homepage:
- Size: 675 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Grant Server
[](https://github.com/semantic-release/semantic-release)
This module is a packaged [Grant OAuth proxy server](https://github.com/simov/grant). That means that you can just install this package and run `grant-serve` to have a proxy OAuth server running.
## Install
```js
npm install grant-server
```
run it:
```js
grant-serve
```
## Table of Contents
- [How it works](#how-it-works)
- [Command line options](#command-line-options)
- [Docker image](#docker-image)
- [Docker usage](#docker-usage)
## How it works
After installing, you will need a [grant configuration file](https://github.com/simov/grant#configuration) to set up different OAuth providers. By default, the module looks for `grant.config.json` file in the currently executing directory. The server will automatically watch for changes in the configuration file and it will automatically reload.
example configuration file with Google auth:
```json
{
"defaults": {
"origin": "http://localhost:3000",
"prefix": "/oauth"
},
"google": {
"key": "CLIENT_ID",
"secret": "CLIENT_SECRET",
"callback": "https://redirect-user-to-your-app.com",
"scope": ["openid"]
}
}
```
By using the file above we are enabling google OAuth point on `http://localhost:3000/oauth/google`, and we are asking for `OpenID` scope. After the tokens have been acquired, the caller will be redirected to `https://redirect-user-to-your-app.com` with the tokens available via query parameters.
## Command line options
- `-c` or `--config` Grant configuration file. If not provided, by default server will look for `grant.config.json` in the currently executing directory.
- `-d` or `--debug` Enable writing tokens to `stdout`. It uses [request-logs module](https://github.com/simov/request-logs). If only the flag is passed it will default to `res,json` otherwise you can customize what the output will be e.g. `-d res,req,json,body`
- `p` or `--proxy` By default internal `express` app will have `trust proxy` flag set to `true`. You can pass in `false` to disable the proxy. Or use any of the options supported by the [express app](http://expressjs.com/en/api.html#trust.proxy.options.table)
## Docker image
Docker image is available on [docker hub](https://hub.docker.com/repository/docker/ivandotv/grant-server). Image is based on github releases, so it's always up to date.
### Docker usage
Pull the image:
```bash
docker image pull ivandotv/grant-server
```
Run the container:
```bash
docker run -it -v /config-dir:/opt/grant-server/config-dir ivandotv/grant-server -d -c config/config.json
```
Few things to keep in mind when using the docker image.
- Server is started in `/opt/grant-server` directory inside the container.
- Make sure that the exposed port is the same as in the configuration file.
- If you mount only the external config file: `-v config.json:/opt/grant-server/config.json` Automatic reloading of the server will not work, because the server will not **see** the changes in the file.
Better option is to mount the **directory** where configuration file is located: `-v /config-dir:/opt/grant-server/config-dir` and then pass the `-c` flag to the container like so: `-c config/config.json`.