Skip to content

Update quickstart to use cloud builds #4010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markbackman merged 1 commit into from
Mar 12, 2026
Merged

Update quickstart to use cloud builds #4010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 5 additions & 23 deletions examples/quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,23 +81,12 @@ Transform your local bot into a production-ready service. Pipecat Cloud handles

> 💡 Tip: You can run the `pipecat` CLI using the `pc` alias.

3. Set up Docker for building your bot image:

- **Install [Docker](https://www.docker.com/)** on your system
- **Create a [Docker Hub](https://hub.docker.com/) account**
- **Login to Docker Hub:**

```bash
docker login
```

### Configure your deployment

The `pcc-deploy.toml` file tells Pipecat Cloud how to run your bot. **Update the image field** with your Docker Hub username by editing `pcc-deploy.toml`.
The `pcc-deploy.toml` file tells Pipecat Cloud how to run your bot.

```ini
agent_name = "quickstart"
image = "YOUR_DOCKERHUB_USERNAME/quickstart:0.1" # 👈 Update this line
secret_set = "quickstart-secrets"

[scaling]
Expand All @@ -107,12 +96,9 @@ secret_set = "quickstart-secrets"
**Understanding the TOML file settings:**

- `agent_name`: Your bot's name in Pipecat Cloud
- `image`: The Docker image to deploy (format: `username/image:version`)
- `secret_set`: Where your API keys are stored securely
- `min_agents`: Number of bot instances to keep ready (1 = instant start)

> 💡 Tip: [Set up `image_credentials`](https://docs.pipecat.ai/deployment/pipecat-cloud/fundamentals/secrets#image-pull-secrets) in your TOML file for authenticated image pulls

### Log in to Pipecat Cloud

To start using the CLI, authenticate to Pipecat Cloud:
Expand All @@ -121,7 +107,7 @@ To start using the CLI, authenticate to Pipecat Cloud:
pipecat cloud auth login
```

You'll be presented with a link that you can click to authenticate your client.
You'll be presented with a link and six-digit code that you can click to authenticate your client.

### Configure secrets

Expand All @@ -133,20 +119,16 @@ pipecat cloud secrets set quickstart-secrets --file .env

This creates a secret set called `quickstart-secrets` (matching your TOML file) and uploads all your API keys from `.env`.

### Build and deploy

Build your Docker image and push to Docker Hub:

```bash
pipecat cloud docker build-push
```
### Deploy

Deploy to Pipecat Cloud:

```bash
pipecat cloud deploy
```

This pushes your project files to Pipecat Cloud where a docker image is built and deployed into production.

### Connect to your agent

1. Open your [Pipecat Cloud dashboard](https://pipecat.daily.co/)
Expand Down
9 changes: 2 additions & 7 deletions examples/quickstart/pcc-deploy.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
agent_name = "quickstart-test"
image = "your_username/quickstart-test:latest"
secret_set = "quickstart-test-secrets"
agent_name = "quickstart"
secret_set = "quickstart-secrets"
agent_profile = "agent-1x"

# RECOMMENDED: Set an image pull secret:
# https://docs.pipecat.ai/deployment/pipecat-cloud/fundamentals/secrets#image-pull-secrets
image_credentials = "dockerhub-access"

[scaling]
min_agents = 1
Loading