[{"_1":2,"_160":-5,"_161":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_139":140},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_128":-5,"_129":11,"_130":21,"_131":11,"_132":-5,"_133":11,"_134":-5,"_135":136,"_137":91,"_138":-7},"canonicalUrl","https://hub.docker.com/r/zackprod/auth_hasurav1/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","zackprod","reponame","auth_hasurav1","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-12-13T01:01:53.270286Z","description","","is_private","last_updated","2020-12-13T01:09:39.958847Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",243,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n \n $\"HBP\"$ \n \n

\n\n\n

Hasura Backend Plus (HBP)

Auth & Files (S3-compatible Object Storage) for Hasura

\n\n---\n\n# Nhost\n\nThe easiest way to deploy HBP is with our official [Nhost](https://nhost.io) managed service. Get your perfect configured backend with PostgreSQL, Hasura and Hasura Backend Plus and save yourself hours of maintenance per month.\n\nAll [Nhost](https://nhost.io) projects are built on open source software so you can make realtime web and mobile apps fast 🚀.\n\n[https://nhost.io](https://nhost.io)\n\n---\n\n# Setup\n\n## Get your database ready\n\nCreate the tables and initial state for your user management by copying everything from the file `db-init.sql`, and insert into the SQL tab in the Hasura Console.\n\n## Track your tables and relations in Hasura\n\nGo to the Hasura console. Click the \"Data\" menu link and then click \"Track all\" under both \"Untracked tables or views\" and \"Untracked foreign-key relations\"\n\n## Create minimal storage rules\n\nIn the same directory where you have your `docker-compose.yaml` for your Hasura and HBP project. Do the following:\n\n```\nmkdir storage-rules\nvim storage-rules/index.js\n```\n\nAdd this:\n\n```\nmodule.exports = {\n\n // key - file path\n // type - [ read, write ]\n // claims - claims in JWT\n // this is similar to Firebase Storage Security Rules.\n\n storagePermission: function(key, type, claims) {\n // UNSECURE! Allow read/write all files. Good to get started though\n return true;\n },\n};\n\n```\n\n## Deploy\n\nAdd to `docker-compose.yaml`:\n\n```\nhasura-backend-plus:\n image: elitan/hasura-backend-plus:latest\n environment:\n PORT: 3000\n AUTH_ACTIVE: 'true'\n AUTH_LOCAL_ACTIVE: 'true'\n USER_FIELDS: ''\n USER_REGISTRATION_AUTO_ACTIVE: 'true'\n HASURA_GRAPHQL_ENDPOINT: http://graphql-engine:8080/v1/graphql\n HASURA_GRAPHQL_ADMIN_SECRET: \n HASURA_GRAPHQL_JWT_SECRET: '{\"type\": \"HS256\", \"key\": \"a_pretty_long_secret_key\"}'\n S3_ACCESS_KEY_ID: \n S3_SECRET_ACCESS_KEY: \n S3_ENDPOINT: \n S3_BUCKET: \n REFRESH_TOKEN_EXPIRES: 43200\n JWT_TOKEN_EXPIRES: 15\n volumes:\n - ./storage-rules:/app/src/storage/rules\n\ncaddy:\n ....\n depends_on:\n - graphql-engine\n - hasura-backend-plus\n```\n\nAdd this to your caddy file\n\n```\nhasura.myapp.io {\n proxy / graphql-engine:8080 {\n websocket\n transparent\n }\n}\n\nbackend.myapp.io {\n proxy / hasura-backend-plus:3000 {\n transparent\n }\n}\n```\n\nRestart your docker containers\n\n`docker-compose up -d`\n\n## Configuration\n\n### ENV VARIABLES:\n\n| Name | Default | Description |\n| -------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| `PORT` | `4000` | Express server port |\n| `AUTH_ACTIVE` | `true` | Activate authentication |\n| `USER_MANAGEMENT_DATABASE_SCHEMA_NAME` | `` | Database schema name of where the `users` table is located |\n| `USER_FIELDS` | `` | Specify user table fields that should be available as `x-hasura-` JWT claims. |\n| `USER_REGISTRATION_AUTO_ACTIVE` | `false` | Whether new user account should automatically be activated. Accounts that are not active are unable to log in |\n| `JWT_TOKEN_EXPIRES` | `15` | Minutes until JWT token expires |\n| `REFRESH_TOKEN_EXPIRES` | `43200` (30 days) | Minutes until refresh token expires |\n| `AUTH_LOCAL_ACTIVE` | `false` | Activate authentication for local accounts |\n| `PROVIDERS_SUCCESS_REDIRECT` | `` | The URL the user should be redirected to on successful signin/signup with a OAuth provider. |\n| `PROVIDERS_FAILURE_REDIRECT` | `` | The URL the user should be redirected to on failed signin/signup with a OAuth provider. |\n| `AUTH_GITHUB_ACTIVE` | `false` | Activate Github as an OAuth provider |\n| `AUTH_GITHUB_CLIENT_ID` | `` | Github OAuth app Client ID |\n| `AUTH_GITHUB_CLIENT_SECRET` | `` | Github OAuth app Client Secret |\n| `AUTH_GITHUB_CALLBACK_URL` | `` | Github OAuth app authorization callback URL |\n| `AUTH_GITHUB_AUTHORIZATION_URL` | `` | Github (enterprise) OAuth app authorization url |\n| `AUTH_GITHUB_TOKEN_URL` | `` | Github (enterprise) OAuth app token url |\n| `AUTH_GITHUB_USER_PROFILE_URL` | `` | Github (enterprise) OAuth app user profile url |\n| `AUTH_GOOGLE_ACTIVE` | `false` | Activate Google as an OAuth provider |\n| `AUTH_GOOGLE_CLIENT_ID` | `` | Google OAuth app Client ID |\n| `AUTH_GOOGLE_CLIENT_SECRET` | `` | Google OAuth app Client Secret |\n| `AUTH_GOOGLE_CALLBACK_URL` | `` | Google OAuth app authorization callback URL |\n| `AUTH_FACEBOOK_ACTIVE` | `false` | Activate Facebook as an OAuth provider |\n| `AUTH_FACEBOOK_CLIENT_ID` | `` | Facebook OAuth app Client ID |\n| `AUTH_FACEBOOK_CLIENT_SECRET` | `` | Facebook OAuth app Client Secret |\n| `AUTH_FACEBOOK_CALLBACK_URL` | `` | Facebook OAuth app authorization callback URL |\n| `STORAGE_ACTIVE` | `true` | Activate storage |\n| `HASURA_GRAPHQL_ENDPOINT` | `http://graphql-engine:8080/v1/graphql` | Hasura GraphQL endpoint |\n| `HASURA_GRAPHQL_ADMIN_SECRET` | `` | Hasura GraphQL admin secret |\n| `HASURA_GRAPHQL_JWT_SECRET` | `{ 'type': 'HS256', 'key': 'secretkey' }` | Shared JWT secret. Must be same as Hasura's `HASURA_GRAPHQL_JWT_SECRET` |\n| `S3_ACCESS_KEY_ID` | `` | S3 access key id |\n| `S3_SECRET_ACCESS_KEY` | `` | S3 secret access key |\n| `S3_ENDPOINT` | `` | S3 endpoint |\n| `S3_BUCKET` | `` | S3 bucket name |\n\n\n#### USER_FIELDS\n\nIf you have some specific fields on your users that you also want to have as a JWT claim you can specify those user fields in the `USER_FIELDS` env var.\n\nSo let's say you have a user table with the following columns:\n\n* id\n* email\n* password\n* role\n* **company_id**\n\nAnd you want to include the `company_id` as a JWT claim. You can specify `USER_FIELDS=company_id`.\n\nThen you will have a JWT a little something like this:\n\n```\n{\n \"https://hasura.io/jwt/claims\": {\n \"x-hasura-allowed-roles\": [\n \"user\"\n \"company_admin\"\n ],\n \"x-hasura-default-role\": \"company_admin\",\n \"x-hasura-user-id\": \"3\",\n \"x-hasura-company-id\": \"1\" <------ THERE WE GO :)\n },\n \"iat\": 1549526843,\n \"exp\": 1549527743\n}\n```\nThis enables you to make permissions using `x-hasura-company-id` for insert/select/update/delete in on tables in your Hasura console. \nLike this: `{\"seller_company_id\":{\"_eq\":\"X-Hasura-Company-Id\"}}`\n\nIt also enables you to write permission rules for the storage endpoint in this repo. Here is an example:\nhttps://github.com/elitan/hasura-backend-plus/blob/master/src/storage/rules/index.js\n\n# HASURA_GRAPHQL_ENDPOINT\n\n## Auth\n```\n/auth/refresh-token\n/auth/activate-account\n/auth/users\n```\n\n### Refresh Token\n\n`/auth/refresh-token`\n\n`POST`\n\nReturns a JWT token.\n\n### Activate Account\n\n`/auth/local/activate-account`\n\n`POST`\n\n| Variable | Type | Required |\n| -------------- | ------ | -------- |\n| `secret_token` | `uuid` | YES |\n\n### User\n\n`/auth/user`\n\nReturns the full User object\n\n## Auth Local\n\n```\n/auth/local/register\n/auth/local/login\n/auth/local/new-password\n```\n\nUse HTTP POST method.\n\n### Register\n\n`/auth/local/register`\n\n`POST`\n\n| Variable | Type | Required | Comment |\n| --------------- | ------------- | -------- | -------------------- |\n| `email` | `string` | YES | |\n| `username` | `string` | YES | can be same as email |\n| `password` | `string` | YES | |\n| `register_data` | `json object` | NO | |\n\n### Login\n\n`/auth/local/login`\n\n`POST`\n\n| Variable | Type | Required |\n| ---------- | -------- | -------- |\n| `username` | `string` | YES |\n| `password` | `string` | YES |\n\n### New password\n\n`/auth/local/new-password`\n\n`POST`\n\n| Variable | Type | Required |\n| -------------- | ------ | -------- |\n| `secret_token` | `uuid` | YES |\n| `password` | `text` | YES |\n\n## Register your first user\n```sh\ncurl -X POST \\\n http://localhost:3000/auth/local/register \\\n -H 'Content-Type: application/json' \\\n -H 'cache-control: no-cache' \\\n -d '{\n\t\"username\": \"testuser\",\n\t\"password\": \"test\"\n}'\n```\nThe response is: `OK!`\n\n## Login using that user\n```sh\ncurl -X POST \\\n http://localhost:3000/auth/local/login \\\n -H 'Content-Type: application/json' \\\n -H 'cache-control: no-cache' \\\n -d '{\n \"username\": \"testuser\",\n \"password\": \"test\"\n}'\n```\n\nThis will have a valid token in the response:\n\n```json\n{\n \"jwt_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtaGFzdXJhLWFsbG93ZWQtcm9sZXMiOlsidXNlciJdLCJ4LWhhc3VyYS1kZWZhdWx0LXJvbGUiOiJ1c2VyIiwieC1oYXN1cmEtdXNlci1pZCI6IjEifSwiaWF0IjoxNTYxMzY0NTY1LCJleHAiOjE1NjEzNjU0NjV9.j4Jvf_hzxStrs80PQyda9RwM3XClCymHHX_uE-y7Nhc\",\n \"refresh_token\": \"b760234c-f36b-47ff-8044-b32e40ee1ad2\",\n \"user_id\": 1\n}\n```\n\n## OAuth providers\n\n```\n/auth/github\n/auth/google\n```\n\n# Storage\n\nWill act as a proxy between your client and a S3 compatible block storage service (for example: AWS S3, Digital Ocean Spaces, Minio).\nHBP can handle read, write and security permissions.\nDigital Ocean offers S3-compatible object storage for $5/month, with 250 GB of storage and 1TB outbound transfer. https://www.digitalocean.com/products/spaces/.\nYou can also use open source self-hosted private cloud storage solutions like [Minio](https://minio.io/).\n\n### Uploads\n\nUpload a file blob to `/storage/upload`. Will return `key`, `originalname` and `mimetype`. You can upload one file at a time.\n\n### Download (get)\n\n`GET`\n`storage/file/{key}`\n\n### Delete (get)\n\n`DELETE`\n`/storage/file/{key}`\n\n\n### Get download token\n\n`GET`\n`/storage/fn/get-download-url/{key}`.\n\nReturns:\n\n```json\n{\n \"token\": \"cce1193c-a299-400b-9e70-2b33b11fd113\",\n}\n```\n\nUse this token with `/storage/file/{file}?token={token}`.\n\n**This token will give permanent access to the file**.\n\n### Security\n\nSecurity rules are placed in `storage-tools.js` in the function `validateInteraction`.\n\n`key` = Interacted file. Ex: `/companies/2/customer/3/report.pdf`.\n\n`type` = Operation type. Can be one of: `read`, `write`.\n\n`claims` = JWT claims coming `https://hasura.io/jwt/claims` custom claims in the Hasura JWT token. Ex: `claims['X-Hasura-User-Id']`.\n\n\n#### Example:\n\nFile:\n`src/storage/storage-rules.js`\n\nCode:\n\n```\nmodule.exports = {\n\n // key - file path\n // type - [ read, write ]\n // claims - claims in JWT\n // this is similar to Firebase Security Rules for files. but not as good looking\n storagePermission: function(key, type, claims) {\n let res;\n\n // console.log({key});\n // console.log({type});\n // console.log({claims});\n\n res = key.match(/\\/companies\\/(?\\w*)\\/customers\\/(\\d*)\\/.*/);\n if (res) {\n if (claims['x-hasura-company-id'] === res.groups.company_id) {\n return true;\n }\n return false;\n }\n\n // accept read to public directory\n res = key.match(/\\/public\\/.*/);\n if (res) {\n if (type === 'read') {\n return true;\n }\n }\n\n return false;\n },\n};\n```\n\nYou can see other examples [here](examples) in examples folder.\n\n# nhost-js-sdk\n\nUse [nhost-js-sdk](https://www.npmjs.com/package/nhost-js-sdk) for client side interaction with Hasura Backend Plus.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",70410329,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},"content_type","creator",9720378,"full_size",70210676,"id",129827116,"images",[101],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},"architecture","amd64","digest","sha256:e2a2718eb05be1ada4191313a0ad2fc4024dcc60e4ed35ea351b4566b8a2138e","features","last_pulled","2026-09-29T15:05:02.864312723Z","last_pushed","2020-12-13T01:09:40Z","os","linux","os_features","os_version","size","variant","2020-12-13T01:09:39.558156Z","last_updater","last_updater_username","media_type","latest","repository",10423115,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":141,"_148":149,"_135":158,"_159":11},{"_40":142,"_42":143,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":144,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":145,"_79":11,"_80":147,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":146},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_150":64,"_151":-5,"_152":-5,"_153":154},"count","next","previous","results",[155],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":156,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},[157],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},[],"canDeleteTags","actionData","errors"]

zackprod/auth_hasurav1

Tags for zackprod/auth_hasurav1