The GitHub Deployments extension allows you to deploy rules, rules configs, connections, database connection scripts, clients, client grants, resource servers, hosted pages and email templates from GitHub to Auth0. You can configure a GitHub repository, keep all your rules and database connection scripts there, and have them automatically deployed to Auth0 each time you push to your repository.
Configure the extension
To install and configure this extension, click on the GitHub Deployments box in the list of provided extensions on the Extensions page of the dashboard. The Install Extension window will open.
Set the following configuration variables:
- REPOSITORY: The repository from which you want to deploy rules and database scripts. This can be either a public or private repository.
- BRANCH: The branch that the extension will monitor for commits.
- HOST: The public accessible GitHub Enterprise (version 2.11.3 and later) hostname, no value is required when using github.com (optional).
- API_PATH: GitHub Enterprise API path prefix, no value is required when using github.com (optional).
- TOKEN: Your GitHub Personal Access Token. Follow the instructions at [Creating an Access Token]
(https://help.github.com/articles/creating-an-access-token-for-command-line-use/#creating-a-token) to create a token with
- BASE_DIR: The base directory, where all your tenant settings are stored
- ENABLE_CIPHER: Enables secrets encryption/decryption support
- CIPHER_PASSWORD: The password for encryption/decryption of secrets
- SLACK_INCOMING_WEBHOOK_URL: The Webhook URL for Slack, used to receive Slack notifications for successful and failed deployments (optional).
Once you have provided this information, click Install.
Navigate to the Extensions page and click on the Installed Extensions tab.
Click on the row for the GitHub Deployments extension. The first time you click on your installed extension, you will be asked to grant it to access your GitHub account.
Once you agree, you will be directed to the GitHub Integration configuration page.
The Configuration page will display the settings you will need to create a webhook in your GitHub repository pointing to the extension.
Copy these values into the Add Webhook page for your GitHub repository:
Once you have set up the webhook in GitHub using the provided information, you are ready to start committing to your repository.
With each commit you push to your configured GitHub repository, the webhook will call the extension to initiate a deployment if changes were made to one of these folders:
The Deploy button on the Deployments tab of the extension allows you to manually deploy the rules and database connection scripts you already have in your GitHub repository. This is useful if you already have a repository filled with scripts that you want to deploy once you have set up the extension, or if you have accidentally deleted some scripts in Auth0 and need to redeploy the latest version of your repository.
Deleting Rules and Scripts from GitHub
To maintain a consistent state, the extension will always do a full redeployment of the contents of these folders. Any rules or database connection scripts that exist in Auth0 but not in your GitHub repository will be deleted.
Deploy Database Connection scripts
To deploy database connection scripts, you must first create a directory under
database-connections. The name of the directory must exactly match the name of your database connection in Auth0. Of course, you can create as many directories as you have database connections.
Under the created directory, create one file for every script you want to use. The allowed scripts are:
login.js script is required in a custom database connection.
If you enabled the migration feature, you will also need to provide the
You can find an example in this GitHub repository.
Deploy Database Connection settings
To deploy Database Connection settings, you must create
This will work only for Auth0 connections (
strategy === auth0); for non-Auth0 connections use
See Management API v2 Docs for more info on allowed attributes for Connections.
To deploy a connection, you must create a JSON file under the
connections directory of your GitHub repository. Example:
This will work only for non-Auth0 connections (
strategy !== auth0); for Auth0 connections, use
See Management API v2 Docs for more info on allowed attributes for Connections.
Deploy Universal Login Pages
The supported pages are:
To deploy a page, you must create an HTML file under the
pages directory of your GitHub repository. For each HTML page, you need to create a JSON file (with the same name) that will be used to mark the page as enabled or disabled. For example, to deploy a
password_reset, you would create two files:
To enable the page, the
password_reset.json would contain the following:
For example, if you create the file
rules/set-country.js, then the extension will create a rule in Auth0 with the name
You can mark rules as manual. In that case, the source control extension will not delete or update them. To mark a rule, navigate to the Rules Configuration tab of the GitHub Integration page. Toggle the Manual Rule switch for the rules you want to mark as manual. Click Update Manual Rules to save your changes.
You can control the rule order and status (
You can find examples in this GitHub repository.
Set the order
Multiple rules of the same order are not allowed. To avoid conflicts, you can create a JSON file for each rule and assign a value for
order. If you leave enough space between these values, re-ordering them without conflicts will be easier. For example, if you have three rules, instead of setting their order to
3, you can set them to
30. This way, to move the
30 rule before the
20, you can simply change its
order to any value between
Deploy Rules Configs
To deploy a rule config, you must create a JSON file under the
rules-configs directory of your GitHub repository. Example:
To deploy a client, you must create a JSON file under the
clients directory of your GitHub repository. Example:
See Management API v2 Docs for more info on allowed attributes for Clients and Client Grants.
Deploy Clients Grants
You can specify the client grants for each client by creating a JSON file in the
Deploy Resource Servers
To deploy a resource server, you must create a JSON file under the
resource-servers directory of your GitHub repository. Example:
See Management API v2 Docs for more info on allowed attributes for Resource Servers.
Deploy Email Provider
To deploy an email provider, you must create
provider.json file under the
emails directory of your GitHub repository. Example:
See Management API v2 Docs for more info on allowed attributes for Email Provider.
Deploy Email Templates
The supported email templates are:
To deploy an email template, you must create an HTML file under the
emails directory of your GitHub repository. For each HTML file, you need to create a JSON file (with the same name) with additional options for that template. For example, to deploy a
blocked_account template, you would create two files:
Beginning with version 2.7.0, you can encrypt sensitive data (e.g., Rules configurations) so that you can store your files in public repositories.
To encrypt your data, log in to your extension and go to the Secrets Encryption Tool (you should have enabled the cipher in the extension's configuration settings).
Encrypted Secret to any string field that should remain private as shown:
The extension will decrypt all encrypted secrets automatically.
To track your deployments, navigate to the extensions page, click on the row for the GitHub Deployments extension, and select the Deployments tab. You will see a list of all deployments, both successful and failed.
If a deployment fails, you can examine the details of the deployment to determine why. Details are also available for successful deployments.
Also, if you configured a Slack Incoming Webhook, you will be notified on Slack if a deployment has succeeded or failed.