Skip to content

[docs] Clarify using GITPOD_BASE_URL env var for custom domains #83

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

Closed
wants to merge 1 commit into from
Closed

[docs] Clarify using GITPOD_BASE_URL env var for custom domains #83

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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,26 @@ we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
to add `GITPOD_API_KEY="My Bearer Token"` to your `.env` file
so that your Bearer Token is not stored in source control.

## Custom Domains

By default, the SDK connects to `https://app.gitpod.io/api`. To connect to a custom Gitpod domain, set the `GITPOD_BASE_URL` environment variable:

```sh
export GITPOD_BASE_URL="https://custom.domain.com/api"
```

Or provide it directly when creating the client:

```python
from gitpod import Gitpod

client = Gitpod(
base_url="https://custom.domain.com/api",
)
```

The SDK will automatically use the custom domain for all API requests.

## Async usage

Simply import `AsyncGitpod` instead of `Gitpod` and use `await` with each API call:
Expand Down