Skip to content

Git Integration ​

Connect Mist with GitHub to enable automatic deployments.

GitHub App Setup ​

1. Create GitHub App ​

Follow the GitHub App Setup Guide to create and install the Mist GitHub App.

2. Install on Repositories ​

Install the GitHub App on repositories you want to deploy:

  1. Visit GitHub App settings
  2. Click "Install App"
  3. Select repositories
  4. Grant required permissions

3. Connect in Mist ​

Once installed, repositories appear in the application creation form.

Public Git Repository ​

Deploy directly from any public Git repository without setting up a GitHub App.

Supported Providers ​

Public Git works with any Git hosting service:

  • GitHub (public repos)
  • GitLab
  • Bitbucket
  • Gitea
  • Self-hosted Git servers
  • Any URL accessible via git clone

Configuration ​

  1. Go to your application's Sources tab
  2. Select Public Git tab
  3. Enter the Git URL (e.g., https://github.com/user/repo.git)
  4. Enter the Branch name (default: main)
  5. Click Save Configuration

Example URLs ​

https://github.com/username/repository.git
https://gitlab.com/username/project.git
https://bitbucket.org/username/repo.git
https://git.example.com/user/repo.git

No Authentication Required

Public Git deployments clone the repository directly without authentication. This is ideal for open-source projects or public repositories where you don't need webhook-based auto-deploy.

Manual Deployments Only

Public Git repositories don't receive webhook events. You must manually trigger deployments from the dashboard when you want to deploy new changes.

Auto-Deploy on Push ​

Enable automatic deployments:

  1. Create application with GitHub repository
  2. Select branch to deploy
  3. Push code to that branch
  4. Mist receives webhook and deploys automatically

Webhook Events ​

Mist listens for these GitHub events:

  • Push - Code pushed to branch
  • Pull Request (coming soon) - PR opened/updated

Commit Tracking ​

Each deployment tracks:

  • Commit hash (SHA)
  • Commit message
  • Author information
  • Timestamp

View commit details in the deployments list.

Branch Management ​

Selecting Branch ​

Choose which branch to deploy:

  • main - Production deployments
  • develop - Staging environment
  • feature/* - Feature testing

Changing Branch ​

Update the deployment branch:

  1. Go to application settings
  2. Change Branch field
  3. Save changes
  4. Next deployment uses new branch

Coming Soon ​

🚧 Git Features in Development

  • GitLab Integration - Connect GitLab repositories
  • Bitbucket Support - Bitbucket repositories
  • Pull Request Previews - Deploy PRs to preview URLs
  • Commit Status Updates - Update GitHub with deployment status
  • Multiple Git Providers - Use multiple providers per app
  • Self-hosted Git - Gitea, Gogs support

Troubleshooting ​

Webhook Not Triggering ​

Check:

  • GitHub App is installed on repository
  • Webhook URL is correct
  • Repository permissions are granted
  • Firewall allows GitHub webhook IPs

Wrong Branch Deploying ​

Verify:

  • Branch name matches exactly (case-sensitive)
  • Application settings have correct branch
  • Webhook is configured for correct events

Released under the MIT License.