.welcome-page {
  margin: 0 auto;
}

.welcome-hero {
  text-align: center;
  padding-top: 5rem;
  padding-bottom: 2rem;
  margin-bottom: 6rem;
  background-color: var(--custom-background);
}

/* dark mode */
html[class~="dark"] .welcome-hero {
  background-color: rgb(23, 29, 38);
  color: white;
}

/* light mode */
html:not([class~="dark"]) .welcome-hero {
  background-color: #f5f8ff;
  color: #111827;
}

.welcome-hero h1 {
  font-size: 3rem;
  margin-bottom: 1.5rem;
  font-weight: 700;
}

.welcome-hero p {
  font-size: 1.2rem;
  max-width: 600px;
  margin: 0 auto 2rem;
}

.welcome-hero b {
  display: inline-block;
  margin-top: 1rem;
}

.welcome-hero b a {
  color: var(--primary-color);
  font-size: 1.1rem;
  text-decoration: none;
  transition: color 0.2s;
}

html[class~="dark"] .welcome-hero b a {
  color: #3787ff;
}

html:not([class~="dark"]) .welcome-hero b a {
  color: #1874ff;
}

.welcome-hero b a:hover {
  text-decoration: underline;
}

.welcome-get-started {
  margin: 0 auto;
  max-width: 1000px;
}

.welcome-get-started h1 {
  text-align: center;
  font-size: 1.5rem;
  font-weight: 600;
  margin: 2.0rem;
}

html[class~="dark"] .welcome-get-started {
  color: white;
}

/* light mode */
html:not([class~="dark"]) .welcome-get-started {
  color: #111827;
}

StorageUploadParams

Documentation

Welcome

Introduction

What is Nhost?

React

Get up and running with Nhost and React

Get up and running with Nhost and Next.js

Next.js

Setup Nhost with Next.js

Setup Nhost with Vue

Get up and running with Nhost and SvelteKit

SvelteKit

Setup Nhost with SvelteKit

In this quickstart guide, we'll demonstrate how to build a simple To-Do feature using Nhost and React Native.

React Native

Get up and running with Nhost and React Native

Build a Todo Manager with React

Build a Todo Manager with Next.js

Build a Todo Manager with Vue

Products

Overview

Users

Redirect users to your application after auth events

Client & Redirect URLs

JSON Web Tokens (JWTs)

Learn how to customize transactional emails

Email Templates

Fetch user profiles automatically from gravatar

Gravatar

Learn how to configure your Postgres server instance

Configuring Postgres

Backups

How to access the database directly using the connection string

Accessing the Database

List of available extensions with Nhost Postgres.

List of Available Extensions

Performance

Upgrade Major Version

Server-side code that works as API endpoints

Getting Started

Supported execution runtimes and package managers

Runtimes and Dependencies

Learn how to configure your Hasura GraphQL Engine

Configuring Hasura

Permissions

Better visibility and security for your GraphQL API

Advanced Features

Antivirus

Enabling Service

Local Development

Generate embeddings for your application automatically

Auto-Embeddings

Assistants

Empower your developers to code faster and better

Developer Assistant

Configuration

Networking

Learn how to enable healthchecks for your services

Healthchecks

Resources

Learn how to use a private registry for your images

Registry

Developing with the Nhost stack and Run services locally

Local development

Configuration Overlays

Learn how to deploy your Run services using the CLI

CLI & CI Deployments

Platform

Cloud

Subdomain/Region

Allocate CPU and Memory to your backend infrastructure

Compute Resources

Service Replicas and Autoscaler

Grafana Instance configured and tailored to your project

Metrics

Environment Variables

Configure your Backend with Sensitive Data

Secrets

Set up automatic deployments by connecting your Nhost project to GitHub

Connecting to GitHub

Custom Domains

Rate Limits

TLS Configuration

Useful information regarding billing you should know

Billing

Develop with Nhost using local and cloud development workflows

CLI Overview

Learn how to start a development instance of Nhost

Learn how to develop against a cloud project using the Nhost CLI

Cloud Development

Learn how to migrate old projects to use the new configuration file

Migrate to Nhost Config

Learn how to run multiple Nhost projects locally

Running Multiple Projects

Learn about using seeds to populate your local database

Seeds

Self-Hosting

Self-hosting Nhost with community support

Community

Enterprise support for organizations managing their own infrastructure

Enterprise Support

Dedicated infrastructure for your specific needs or security requirements

Dedicated Cluster

Commands

Learn Nhost through guides and tutorials.

Database

GraphQL API

Realtime GraphQL API

Auth

Storage

Functions

As simple as pushing your code to source control

Deployments

Tools to develop and test Nhost projects locally

Nhost CLI

Available commands to run and manage local Nhost projects

Follow this guide to sign in users with Apple.

Sign In with Apple

Follow this guide to sign in users with Azure.

Sign In with Azure

Follow this guide to sign in users with Discord.

Sign In with Discord

Follow this guide to sign in users with Facebook.

Sign In with Facebook

Follow this guide to sign in users with GitHub.

Sign In with GitHub

Follow this guide to sign in users with Google.

Sign In with Google

Follow this guide to sign in users with LinkedIn.

Sign In with LinkedIn

Follow this guide to sign in users with Spotify.

Sign In with Spotify

Follow this guide to sign in users with Twitch.

Sign In with Twitch

Follow this guide to sign in users with WorkOS.

Sign In with WorkOS

Add social sign in mechanism to existing users

Social Provider Connect

Email and Password

Sign In with Email and Password

One-Time Passwords

Sign In with One-Time Passwords

Magic Links

Sign In with a Magic Link

SMS OTP

Sign In via SMS OTP

WebAuthn and Security Keys

Sign In with WebAuthn

IDTokens

Sign In with ID tokens

Require extra permissions to perform critical operations

Elevated Permissions

Bot Protection

Custom JWTs

Get public keys for JWT verification in JWK Set format

/.well-known/jwks.json

Elevate access for an already signed in user using FIDO2 Webauthn

/elevate/webauthn

Verify FIDO2 Webauthn authentication using public-key cryptography

/elevate/webauthn/verify

/healthz

Link a user account with the provider's account using an id token

/link/idtoken

Generate Secret to request the activation of Time-Based One-Time password (TOTP)

/mfa/totp/generate

/pat

/signin/anonymous

/signin/email-password

/signin/idtoken

Sign In with a Time-based One-Time Password (TOTP)

/signin/mfa/totp

Sign in with a one time password sent to user's email. If the user doesn't exist, it will be created. The options object is optional and can be used to configure the user's when signing up a new user. It is ignored if the user already exists.

/signin/otp/email

Verify OTP and return a session if validation is successful

/signin/otp/email/verify

Sign in with magic link sent to user's email. If the user doesn't exist, it will be created. The options object is optional and can be used to configure the user's when signing up a new user. It is ignored if the user already exists.

/signin/passwordless/email

Send a one-time password (OTP) to a user through SMS 

/signin/passwordless/sms

Verify and authenticate the one-time password (OTP) received by SMS

/signin/passwordless/sms/otp

/signin/pat

/signin/provider/{provider}

OAuth Callback used by the provider when redirecting the user back to your application

/signin/provider/{provider}/callback

/signin/webauthn

Verify WebAuthn Sign In to complete authentication

/signin/webauthn/verify

/signout

/signup/email-password

/signup/webauthn

/signup/webauthn/verify

/token

If request body is not passed the autorization header will be used to be verified

/token/verify

/user

Deanonymize an anonymous user in adding missing email or email+password, depending on the chosen authentication method. Will send a confirmation email if the server is configured to do so

Backend Services

Client Libraries

CLI

StorageUploadParams

`StorageUploadParams`

Backend Services

Client Libraries

CLI

​StorageUploadParams

`StorageUploadParams`