Skip to content

Update Bitbucket installation docs with IP allowlisting details #777

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
merged 1 commit into from
Aug 21, 2025
Merged

Update Bitbucket installation docs with IP allowlisting details #777

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
3 changes: 2 additions & 1 deletion docs/bitbucket-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ description: Install gitStream to your Bitbucket workspace.
- 13.56.203.235
- 54.151.81.98

??? Info "Understanding IP Allowlisting for gitStream"
??? Info "Advanced: IP Allowlisting for gitStream"
When setting up IP allowlists in Bitbucket, you're specifying which source IP addresses are permitted to interact with your repositories and APIs. This affects both gitStream and your CI/CD runners.

There are two primary cases where this matters for gitStream:
Expand All @@ -36,6 +36,7 @@ description: Install gitStream to your Bitbucket workspace.

- Add LinearB/gitStream service IPs to your Bitbucket allowlist (listed above).
- Use self-hosted runners or runners with static IPs so you can manage and allowlist their addresses explicitly.
- Add must add to your `bitbucket-pipeline.yml` `step.runtime.cloud.atlassian-ip-ranges: true`.
Copy link
Contributor

@gitstream-cm gitstream-cm bot Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧾 Readability - Grammar Error: Remove the redundant "Add" at the beginning of the sentence. Change "Add must add to your" to "Must add to your" or "Add to your".

Suggested change
- Add must add to your `bitbucket-pipeline.yml` `step.runtime.cloud.atlassian-ip-ranges: true`.
- Add to your `bitbucket-pipeline.yml` `step.runtime.cloud.atlassian-ip-ranges: true`.


This combination ensures that both gitStream's internal operations and your CI runners' interactions with Bitbucket function without network restrictions.

Expand Down
10 changes: 9 additions & 1 deletion docs/downloads/bitbucket-pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,18 @@ pipelines:
description: workspace/repo
- step:
name: /:\ gitstream workflow automation
# For self-hosted runners, uncomment the runs-on section below
##### For cloud runners with IP whitelist, uncomment the section below
# size: 4x # Required as atlassian-ip-ranges supported only on 4x or more
# runtime:
# cloud:
# atlassian-ip-ranges: true
##### End of section
#
##### For self-hosted runners, uncomment the section below
# runs-on:
# - self.hosted # Required to indicate a self-hosted runner
# - cmgitstreamrunner # Custom label that must be added to your self-hosted runner
##### End of section
max-time: 15
clone:
enabled: false
Expand Down