Deploying your own Sweep instance on modal

Note that Sweep uses the CC-NC license, meaning you may only self-host Sweep for non-commercial purposes. Contact us at team@sweep.dev or use the Intercom bubble in the bottom right if you're interested in self-hosting Sweep.

Prerequisites

Ensure you have the following:

OpenAI API-key, preferably with access to a 32k context GPT-4 model
Network exposed MongoDB and Redis instances
Poetry package manager installed on your machine
Account on https://modal.com (opens in a new tab) (free-tier)

This guide is set for a minimal working setup. Feel free to take a look at sweepai/config/server.py and adjust your steps as per requirements.

Steps

Clone the sweep repository and install dependencies:

git clone git@github.com:sweepai/sweep.git
cd sweep
./bin/install.sh

Install the modal client, link it to your account:
```
pip install modal-client
modal token new
```

Register a new GitHub App:

Use this guide (opens in a new tab) to register a new GitHub App.

Permissions:

actions: read
check: read
contents: read & write
commit statuses: read & write
issues: read & write
metadata: read
pull requests: read & write
workflows: read & write

Webhook events:

 issues
 pull request
 workflow run
 check run
 issue comment
 label
 pull request review
 pull request review comment
 pull request thread
 status
 workflow job
 create
 commit comment
 check suite
 push

Disable the webhook for now. You can use any URL for the homepage (e.g. repository URL). Install the app (opens in a new tab) on your account or organization and generate a private key as per this guide (opens in a new tab).

Setup modal environment:

Navigate to the 'Secrets' tab in Modal.
Create a 'github' secret with the following values:

GITHUB_APP_ID: Your App ID from general tab in Application settings
GITHUB_BOT_USERNAME: Your App name
GITHUB_APP_PEM: Your App's private key, make sure to include whitespaces as in original file with pk

Create 'openai-secret' modal secret with following variables:

OPENAI_API_KEY: Your OpenAI API key
OPENAI_DO_HAVE_32K_MODEL_ACCESS: true/false depending on if you have access to 32k model

Create 'mongodb', and 'redis_url' modal secrets with following variables:

MONGODB_URI: MongoDB connection URL
REDIS_URL: Redis connection URL

Go to the root of previously cloned project and run the following command:

./bin/create_optional_secrets.sh

Deploy Sweep to modal:
```
poetry shell
./bin/deploy.sh
```
Setup Github webhook:

Head over to https://modal.com (opens in a new tab) and login.
Proceed to "Apps", locate your deployed API instance (by default, it is api).
Search for the webhook function and duplicate the webhook URL.
In the GitHub app settings, populate the webhook URL field with this copied URL. Ensure SSL verification remains active.

Config Examples