karczevski/burst-ms-gatekeeper repository overview

⁠Gatekeeper

Used to auth users. You can authenticate in POST /auth and validate this in GET /user/me

If you are a admin, you can get all users in GET /user

You can validate a user with a message with format { role: 'user', cmd: 'get' } in TCP_PORT

⁠Requirements

In this moment only a postgres database is supported and required.

⁠Configuration

You must configure the following environment variables:

• POST: The port where the server will listen

• TCP_PORT: The port where the tcp server will listen (used to microsservices communication)

• DB_HOST: The host of your database.

• DB_PORT: The port of your database.

• DB_USER: The user to connect with in your database.

• DB_PASSWORD: The password for the user above.

• DB_DATABASE: The name of the database you want to use.

• JWT_SECRET: A secret key used to encrypt jwt tokens.

• JWT_EXPIRES: expressed in seconds or a string describing a time span zeit/ms. Eg: 60, "2 days", "10h", "7d". Default is 2h.

• SMTP_HOST: The host of your smtp server.

• SMTP_PORT: The port of your smtp server.

• SMTP_IGNORE_SSL: If true, a secure connection is not required for SMTPS. Default is false.

• SMTP_SECURE: If true, the connection uses the STARTTLS command after connecting to the server. Default is true.

• SMTP_USER: The user to connect with in your smtp server.

• SMTP_PASSWORD: The password for the user above.

⁠Installation

yarn install

⁠Running the server

yarn start

⁠Testing

In this moment we dont have tests, but we are working on and will soon.

⁠Roadmap

• Password reset
• Unit tests
• OpenApi documentation with swagger