Deploying your own Sweep instance via Docker

🎉 We recently changed our license to the Elastic License V2 (opens in a new tab) to allow Sweep for commercial usage.

This is the guide for self-deploying Sweep. If you would like to use our hosted version, please visit https://sweep.dev (opens in a new tab). If you would like to develop on Sweep, check out development (opens in a new tab).

Video Guide (~5 minutes)

(opens in a new tab)

After finishing the steps in the video, please complete these two steps:

• Add your GitHub App name to the secrets as GITHUB_BOT_USERNAME
• Complete the Set Webhook URL in GitHub step once your Digital Ocean instance has finished deploying.

Alternatively, we have written instructions below.

1. Create GitHub App

We created an app using npm to make it easier to set up the GitHub App. If you do not have it installed, install it here (opens in a new tab). If you would like ot set it up yourself, scroll down to the Manual GitHub App Setup section.

Run this GitHub App locally! This tool is only used for creating the GitHub App, not hosting Sweep.

First, open a terminal and run the following commands (RUN LOCALLY):

git clone https://github.com/sweepai/sweep
cd sweep/self_deploy
npm install
npm start

Second, open http://localhost:3000 (opens in a new tab) in your browser, and:

1. Click the "Register GitHub App" button.
2. Click the green "Create GitHub App for USERNAME" button.
3. Pick where to install the app and then click the green "Install" button. This will take you to the app settings page.
4. Click the small "App settings" button.

Now, stop the server by pressing Ctrl+C in the terminal. Once it has stopped, open the .env file with a text editor in the sweep/self_deploy directory. You should see something like this:

APP_ID=123456
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----\n"
WEBHOOK_SECRET=213921898f9as8f92139128989f
GITHUB_CLIENT_ID=Iv1.123218f182131
GITHUB_CLIENT_SECRET=6g626312b212142132121321412

Add two variables to the end of the file:

1. GITHUB_BOT_USERNAME=sweep-example-name
2. WHITELISTED_USERS=your-username,other-username,another-username

...
GITHUB_BOT_USERNAME=sweep-example-name
WHITELISTED_USERS=your-username,other-username,another-username

You should have the following environment variables:

APP_ID=123456
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----\n"
WEBHOOK_SECRET=213921898f9as8f92139128989f
GITHUB_CLIENT_ID=Iv1.123218f182131
GITHUB_CLIENT_SECRET=6g626312b212142132121321412
GITHUB_BOT_USERNAME=sweep-example-name
WHITELISTED_USERS=your-username,other-username,another-username

2. OpenAI API Token

Please create an OpenAI API token at https://platform.openai.com/account/api-keys (opens in a new tab). You will need this later. Also, if you have access to the 32k model, please set OPENAI_DO_HAVE_32K_MODEL_ACCESS=true. If you have a beefier machine and want higher quality search, change the sentence transformers model to sentence-transformers/all-mpnet-base-v2.

OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_DO_HAVE_32K_MODEL_ACCESS=false

After following one of the above sections, you should have the following environment variables:

APP_ID=123456
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----\n"
WEBHOOK_SECRET=213921898f9as8f92139128989f
GITHUB_CLIENT_ID=Iv1.123218f182131
GITHUB_CLIENT_SECRET=6g626312b212142132121321412
GITHUB_BOT_USERNAME=sweep-example-name
WHITELISTED_USERS=your-username,other-username,another-username
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_DO_HAVE_32K_MODEL_ACCESS=false

3. Hosting Sweep

Starting here it gets more involved so if you run into issues, please reach out to us on Discord (opens in a new tab) or open a GitHub issue (opens in a new tab) (ironic, we know!). We are online, please ping us @kevin, @william, and @luke.

1. Create Instance

Recommended specs:

• OS: Ubuntu
• RAM: 16 GB
• CPU: 2 vCPUs
• Storage: 50 GB

2. Install Docker and docker compose

sudo apt install -y apt-transport-https ca-certificates curl software-properties-common -y
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository -y "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt update -y
sudo apt install docker-ce -y
sudo systemctl enable docker
sudo systemctl start docker
sudo usermod -aG docker ${USER}

3. Configure .env and pull Image

Run the docker client if you are on Mac/Windows.

git clone https://github.com/sweepai/sweep
cd sweep
vim .env
docker compose pull

And copy the following into the file:

# Step 1
APP_ID=123456
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----\n"
WEBHOOK_SECRET=213921898f9as8f92139128989f
GITHUB_CLIENT_ID=Iv1.123218f182131
GITHUB_CLIENT_SECRET=6g626312b212142132121321412
GITHUB_BOT_USERNAME=sweep-example-name
WHITELISTED_USERS=your-username,other-username,another-username
# Step 2
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_DO_HAVE_32K_MODEL_ACCESS=false

4. Launch Docker Image

docker compose up # Add -d to run in background

5. Update GitHub Webhook URL

First, get the IP address of your instance, and add the port Sweep is deployed to (in this case, 8080):

http://ip:8080

Navigating to this link should look like this:

1. Copy this link to your clipboard.
2. Go to your GitHub App and paste this link into the General tab Webhook URL field. Ensure SSL verification remains active.

4. Using Sweep

Finally, you can use Sweep by creating a new issue with a title prefixed with Sweep:, like Sweep: add comments to BaseIndex.tsx and watch the magic happen!

For more details on using Sweep, see our tutorial (opens in a new tab) and advanced usage (opens in a new tab) guides. For extra deployment configurations like Azure, and Redis (coming soon!) check out our extra self-hosting configs (opens in a new tab).

You have successfully deployed Sweep!

*There's additional configurable settings like Redis caching and GPU-accelerated embeddings that we use for our hosted product that we can document further for self-hosting. If this interests you please contact us at https://discord.gg/sweep (opens in a new tab). *

Alternative steps:

If you successfully deployed Sweep, you can skip this section.

git clone https://github.com/sweepai/sweep
cd sweep
docker compose pull

docker compose up # Add -d to run in background

Forwarding  https://4d8d8bf053be.ngrok.app -> http://localhost:8080

echo -e "paste key here" | tr '\n' ' ' | sed 's/ /\\n/g'

PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----\n"

APP_ID=123456
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----\n"
GITHUB_BOT_USERNAME=sweep-example-name

Alternative to 3: Deploy DigitalOcean App

As Sweep is Dockerized, you can deploy this anywhere but for this guide, we will deploy it on Digital Ocean for simplicity. If you would like to run it locally, you can follow the section in the dropdown at the bottom of this guide.

First, click the following:

1. Skip Resources Page

2. Set Environment Variables

In the Environment Variable Editor, copy and paste the environment variables from above like so:

Click Save to close the Bulk Editor, then click Save again to save the varaibles.

It is important that you click save twice, otherwise the variables will not be saved.

APP_ID=1234
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----\n"
GITHUB_BOT_USERNAME=sweep-example-name
 
# These three are from step 2.
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_DO_HAVE_32K_MODEL_ACCESS=false

3. Info

Modify any information as needed, then click Next.

4. Review: Update Instance Resource Size

First, click Edit Plan in the Billing section.

Then, set the Instance Size.

Please select an instance with at least 2 GB RAM. The default 1 GB RAM instance will not work.

5. Create Resources!

Simply click the button to create the instance.

6. Set Webhook URL in GitHub (Important)

Once the resource is created, you should get a link like this:

Navigating to this link should look like this:

1. Copy this link to your clipboard.
2. Go to your GitHub App and paste this link into the General tab Webhook URL field. Ensure SSL verification remains active.