Skip to content

Commit cbdab93

Browse files
authored
Merge pull request #555 from linear-b/overview-add-github-server
added github server
2 parents 7cbd854 + 92be1dd commit cbdab93

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,20 @@ gitStream is a workflow automation tool that enables you to use YAML configurati
4646

4747
gitStream can be installed for one repo, specific repos, or all repos in your organization. We recommend installing for **all** because it will ensure all new repos are able to use gitStream. You can change this setting at any time in the future.
4848

49+
=== ":fontawesome-brands-github: GitHub Server"
50+
51+
1. Create and install a [Custom GitHub App for Self-Hosted GitHub Server](/custom-github-app)
52+
2. <a href="https://app.linearb.io/login" target="_blank">Login</a> to the LinearB app. Navigate to **Company Settings** -> **Git**
53+
1. Make sure the GHES is integrated with LinearB
54+
2. Connect gitStream to the GHES integration by pressing the "Connect gitStream" button
55+
3. Connect the repositories to gitStream by selecting the checkbox under the "gitStream" column (for org level installation, `cm` repo must be selected)
56+
3. Configure your repository using the [instructions for GitHub](/github-installation#setup). This will guide you through setting up your first automations.
57+
58+
That's it! Now sit back and watch gitStream run automation rules on your next PR.
59+
60+
!!! tip "Tip: Install gitStream for your entire organization"
61+
62+
gitStream can be installed for one repo, specific repos, or all repos in your organization. We recommend installing for **all** because it will ensure all new repos are able to use gitStream. You can change this setting at any time in the future.
4963

5064
=== ":fontawesome-brands-gitlab: GitLab"
5165

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
site_name: gitStream Documentation
22
site_description: Automate the code review process with gitStream.
33
site_author: LinearB
4-
copyright: Copyright &copy; 2023 LinearB, Inc.
4+
copyright: Copyright &copy; 2024 LinearB, Inc.
55
repo_url: https://github.com/linear-b/gitstream
66
repo_name: linear-b/gitstream
77
edit_uri: "edit/main/docs/"

0 commit comments

Comments
 (0)