https://github.com/dl-nft-books/doorman
Service for creating and validating authentication tokens
https://github.com/dl-nft-books/doorman
backend golang jwt
Last synced: 9 months ago
JSON representation
Service for creating and validating authentication tokens
- Host: GitHub
- URL: https://github.com/dl-nft-books/doorman
- Owner: dl-nft-books
- License: apache-2.0
- Created: 2023-03-02T10:00:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-18T08:37:39.000Z (about 3 years ago)
- Last Synced: 2025-03-14T07:25:38.830Z (over 1 year ago)
- Topics: backend, golang, jwt
- Language: Go
- Homepage:
- Size: 4.82 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# doorman
## Description
Service for generating access and refresh JWTs
## Install
```bash
git clone doorman
cd
go build main.go
export KV_VIPER_FILE=./config.yaml
./main migrate up
./main run service
```
## Documentation
We do use openapi:json standard for API. We use swagger for documenting our API.
To open online documentation, go to [swagger editor](http://localhost:8080/swagger-editor/) here is how you can start it
```bash
cd docs
npm install
npm start
```
To build documentation use `npm run build` command,
that will create open-api documentation in `web_deploy` folder.
To generate resources for Go models run `./generate.sh` script in root folder.
use `./generate.sh --help` to see all available options.
## Running from docker
Make sure that the docker is installed.
Use `docker run ` with `-p 8080:80` to expose port 80 to 8080
```bash
docker build -t doorman .
docker run -e KV_VIPER_FILE=/config.yaml doorman
```
## Running from Source
* Set up environment value with config file path `KV_VIPER_FILE=./config.yaml`
* Provide valid config file
* Launch the service with `migrate up` command to create database schema
* Launch the service with `run service` command
### Database
For services, we do use ***PostgresSQL*** database.
You can [install it locally](https://www.postgresql.org/download/) or use [docker image](https://hub.docker.com/_/postgres/).
## Contacts
Dmytro Zakharov is responsible for this service. Can be contacted via the _Telegram_ (`@ZamDimon`)