Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
53845714nF authored Feb 10, 2024
1 parent 9cb2d5f commit 6a7c40b
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hasura JWT 🔑
# 🔑 Hasura JWT

## Description
## 🗒️ Description
This app allows you to create JWTs for hasura.
And have a minimal signup process via email.
It is small (Image size ~10MB) tool written in golang and minimal dependencies.
Expand All @@ -15,6 +15,23 @@ It is small (Image size ~10MB) tool written in golang and minimal dependencies.

## Usage

### ⚙️ Deployment
There are several ways to deploy this project.
There is a ready-made container image on GitHub Packages. 📦

You can use it in your environment.

#### 🐳 Docker Compose
There is a Docker Compose File for developers, here the Hasura must be adapted.

#### ☸ Kubernetes
There is also a template for Kubernetes.
Here you can see how to roll out this app there.

#### 🐹 Build with golang
And last but not least, since it is written in golang, you can export the project to almost all platforms.
(If a platform is explicitly desired, I can create a Github action for it, let me know in an issue)

### Environment Variables for Hasura JWT
- `HASURA_URL` - Must be set to the URL of your Hasura instance (e.g. `http://localhost:8080/v1/graphql` is also the default value for development).
- `HASURA_SECRET` - Must be set to the admin secret of your Hasura instance.
Expand All @@ -30,12 +47,14 @@ It is small (Image size ~10MB) tool written in golang and minimal dependencies.
- `JWT_URL` - Must be set to the URL of your Hasura JWT instance (e.g. `http://localhost:3000`).
- `HASURA_GRAPHQL_UNAUTHORIZED_ROLE` - Set to `anonymous` to get access to the public schema without a token. and also for login and signup mutations.

### Volume
### 📂 Volume
- `/etc/ssl/certs/` - You can map a volume with the certificates to `/etc/ssl/certs/` in the container.
This helps by problems with the SMTP Authentication. In default are only lets-encrypt certificates supported.

## 📃 Docs
Please take a look at the GitHub Wiki tab there are sequence diagrams for the process (sign up, login) and a database model.

## Similar Projects
## 🤖 Similar Projects
There is are similar project like this:
- [Hasura Auth](https://github.com/nhost/hasura-auth/tree/main) - It offers more features but is written in Typescript.
- [Backend-Quickstart](https://github.com/ryaino/Backend-Quickstart) - It's written in Java, but the last commit was 2 years ago.
Expand Down

0 comments on commit 6a7c40b

Please sign in to comment.