netlify/gotrue is a Security project on GitHub, written primarily in Go. It has 4.5k stars. An JWT based API for managing users and issuing JWT tokens.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
GoTrue is a small open-source API written in Golang, that can act as a self-standing
API service for handling user registration and authentication for Jamstack projects.
It's based on OAuth2 and JWT and will handle user signup, authentication and custom
user data.
Configuration
You may configure GoTrue using either a configuration file named .env,
environment variables, or a combination of both. Environment variables are prefixed with GOTRUE_, and will always have precedence over values provided via file.
Top-Level
GOTRUE_SITE_URL=https://example.netlify.com/
SITE_URL - stringrequired
The base URL your site is located at. Currently used in combination with other settings to construct URLs used in emails.
OPERATOR_TOKEN - stringMulti-instance mode only
The shared secret with an operator (usually Netlify) for this microservice. Used to verify requests have been proxied through the operator and
the payload values can be trusted.
DISABLE_SIGNUP - bool
When signup is disabled the only way to create new users is through invites. Defaults to false, all signups enabled.
GOTRUE_RATE_LIMIT_HEADER - string
Header on which to rate limit the /token endpoint.
API
GOTRUE_API_HOST=localhost
PORT=9999
GOTRUE_API_HOST - string
Hostname to listen on.
PORT (no prefix) / API_PORT - number
Port number to listen on. Defaults to 8081.
GOTRUE_API_ENDPOINT - stringMulti-instance mode only
Controls what endpoint Netlify can access this API on.
REQUEST_ID_HEADER - string
If you wish to inherit a request ID from the incoming request, specify the name in this value.
GOTRUE_API_EXPORT_SECRET - string
A secret that, if set, will allow exporting users for a migration to a different service.
How long tokens are valid for, in seconds. Defaults to 3600 (1 hour).
JWT_AUD - string
The default JWT audience. Use audiences to group users.
JWT_ADMIN_GROUP_NAME - string
The name of the admin group (if enabled). Defaults to admin.
JWT_DEFAULT_GROUP_NAME - string
The default group to assign all new users to.
External Authentication Providers
We support bitbucket, github, gitlab, and google for external authentication.
Use the names as the keys underneath external to configure each separately.
If the mail server requires authentication, the username to use.
SMTP_PASS - string
If the mail server requires authentication, the password to use.
SMTP_MAX_FREQUENCY - number
Controls the minimum amount of time that must pass before sending another signup confirmation or password reset email. The value is the number of seconds. Defaults to 900 (15 minutes).
SMTP_RESERVED_DOMAINS - string
A comma-separated list of domains that cannot be used as the admin_email sender address (e.g. example.com,example.app). Use this to prevent spoofing of domains your service owns. If not set, no domain restrictions are enforced.
MAILER_AUTOCONFIRM - bool
If you do not require email confirmation, you may set this to true. Defaults to false.
MAILER_URLPATHS_INVITE - string
URL path to use in the user invite email. Defaults to /.
MAILER_URLPATHS_CONFIRMATION - string
URL path to use in the signup confirmation email. Defaults to /.
MAILER_URLPATHS_RECOVERY - string
URL path to use in the password reset email. Defaults to /.
MAILER_URLPATHS_EMAIL_CHANGE - string
URL path to use in the email change confirmation email. Defaults to /.
MAILER_SUBJECTS_INVITE - string
Email subject to use for user invite. Defaults to You have been invited.
MAILER_SUBJECTS_CONFIRMATION - string
Email subject to use for signup confirmation. Defaults to Confirm Your Signup.
MAILER_SUBJECTS_RECOVERY - string
Email subject to use for password reset. Defaults to Reset Your Password.
MAILER_SUBJECTS_EMAIL_CHANGE - string
Email subject to use for email change confirmation. Defaults to Confirm Email Change.
MAILER_TEMPLATES_INVITE - string
URL path to an email template to use when inviting a user.
SiteURL, Email, and ConfirmationURL variables are available.
Default Content (if template is unavailable):
<h2>You have been invited</h2>
<p>You have been invited to create a user on {{ .SiteURL }}. Follow this link to accept the invite:</p>
<p><a href="{{ .ConfirmationURL }}">Accept the invite</a></p>
MAILER_TEMPLATES_CONFIRMATION - string
URL path to an email template to use when confirming a signup.
SiteURL, Email, and ConfirmationURL variables are available.
Default Content (if template is unavailable):
<h2>Confirm your signup</h2>
<p>Follow this link to confirm your user:</p>
<p><a href="{{ .ConfirmationURL }}">Confirm your mail</a></p>
MAILER_TEMPLATES_RECOVERY - string
URL path to an email template to use when resetting a password.
SiteURL, Email, and ConfirmationURL variables are available.
Default Content (if template is unavailable):
<h2>Reset Password</h2>
<p>Follow this link to reset the password for your user:</p>
<p><a href="{{ .ConfirmationURL }}">Reset Password</a></p>
MAILER_TEMPLATES_EMAIL_CHANGE - string
URL path to an email template to use when confirming the change of an email address.
SiteURL, Email, NewEmail, and ConfirmationURL variables are available.
Default Content (if template is unavailable):
<h2>Confirm Change of Email</h2>
<p>Follow this link to confirm the update of your email from {{ .Email }} to {{ .NewEmail }}:</p>
<p><a href="{{ .ConfirmationURL }}">Change Email</a></p>
WEBHOOK_URL - string
Url of the webhook receiver endpoint. This will be called when events like validate, signup, login, userdeleted or usermodified occur.
WEBHOOK_SECRET - string
Shared secret to authorize webhook requests. This secret signs the JSON Web Signature of the request. You should use this to verify the integrity of the request. Otherwise others can feed your webhook receiver with fake data.
WEBHOOK_RETRIES - number
How often GoTrue should try a failed hook.
WEBHOOK_TIMEOUT_SEC - number
Time between retries (in seconds).
WEBHOOK_EVENTS - list
Which events should trigger a webhook. You can provide a comma separated list.
For example to listen to all events, provide the values validate,signup,login,userdeleted,usermodified.
Endpoints
GoTrue exposes the following endpoints:
GET /settings
Returns the publicly available settings for this gotrue instance.
Once you have an access token, you can access the methods requiring authentication
by settings the Authorization: Bearer YOUR_ACCESS_TOKEN_HERE header.
The most recent commit recorded on netlify/gotrue was 21 days ago, based on the GitHub push timestamp. The repository has 325 forks — one of the better signals of community interest.
How does netlify/gotrue compare to other Security projects?
netlify/gotrue is tracked by TopGit in the Security category, with 4.5k GitHub stars and written in Go. Browse the Security topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does netlify/gotrue have?
netlify/gotrue has 4.5k GitHub stars — refresh the page for the live number, or check github.com/netlify/gotrue. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is netlify/gotrue open source?
Yes — netlify/gotrue ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/netlify/gotrue.
What is netlify/gotrue?
netlify/gotrue (netlify/gotrue) is a Go project on GitHub. From the project's own README: An JWT based API for managing users and issuing JWT tokens.
Where do I read more about netlify/gotrue?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/netlify/gotrue is the definitive source.
Read full README in the tab above.
Is gotrue worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of gotrue.