citifuel-auth-guard
v0.0.21
Published
<p align="center"> <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a> </p>
Downloads
77
Readme
Description
Nest framework TypeScript starter repository.
Installation
$ yarn installRunning the app
# development
$ yarn run start
# watch mode
$ yarn run start:dev
# production mode
$ yarn run start:prodTest
# unit tests
$ yarn run test
# e2e tests
$ yarn run test:e2e
# test coverage
$ yarn run test:covSupport
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
Stay in touch
- Author - Kamil Myśliwiec
- Website - https://nestjs.com
- Twitter - @nestframework
License
Nest is MIT licensed.
CitiFuel Auth Guard
A NestJS module for gRPC-based authentication.
Installation
npm install citifuel-auth-guardUsage
Import and configure the AuthModule in your application:
import { AuthModule } from 'citifuel-auth-guard';
@Module({
imports: [
AuthModule.register({
host: 'localhost',
port: 5000,
realm: 'my-realm'
})
// OR
AuthModule.register({
url: 'localhost:5000',
realm: 'my-realm'
})
]
})
export class AppModule {}Configuration Options
The module accepts the following options:
url: Complete URL string (e.g., 'localhost:5000')host: Host address (alternative to url)port: Port number (alternative to url)realm: Authentication realm
