Skip to content

Commit ffd52ac

Browse files
PMP updates
1 parent ce9b86d commit ffd52ac

1 file changed

Lines changed: 38 additions & 5 deletions

File tree

content/en/docs/private-platform/configuration/pmp-version-control.md

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,22 @@ To select the repository type, perform the following steps:
2121

2222
1. Switch to Admin Mode by clicking the profile picture in the top right corner of the screen and selecting **Switch to Admin Mode**.
2323
2. In the left navigation menu, open the **Settings** section.
24-
3.Click **Version Control**.
24+
3. Click **Version Control**.
2525

2626
## GitLab
2727

28-
This section describes the configuration of a GitLab repository.
28+
This section describes the configuration of a GitLab repository. Private Mendix Platform supports both GitLab SaaS and self‑managed GitLab instances.
29+
30+
### Prerequisites
31+
32+
Before configuring GitLab for Private Mendix Platform, ensure that you fulfill the following prerequisites:
33+
34+
* You have access to a GitLab SaaS account or a self‑managed GitLab server.
35+
* A GitLab group exists to host applications created by the Private Mendix Platform.
36+
* You can generate Personal Access Tokens (PATs) with the required scopes.
37+
* For Automatic Access Provisioning, a GitLab administrator (root) Personal Access Token is available.
38+
39+
### Configuration
2940

3041
* **Host URL** - This is the host URL of your GitLab server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your GitLab server host name is mygitlab.example.com, you should input `https://mygitlab.example.com` here.
3142
* **Group ID** - All the apps on Private Mendix Platform are created under a GitLab group. You need to create a group in GitLab and then input the *Group ID* in this field.
@@ -45,19 +56,41 @@ When the **Automatic Access Provisioning** is disabled, private platform users n
4556
Private Mendix Platform supports only the following predefined GitLab push rules:
4657

4758
* Reject unverified users.
59+
4860
Users can only push commits to this repository if the committer email is one of their own verified emails.
49-
* Reject inconsistent user names.
61+
62+
* Reject inconsistent user names.
63+
5064
Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
65+
5166
* Check whether the commit author is a GitLab user.
67+
5268
Commits are restricted to existing GitLab users.
5369

5470
## GitHub
5571

56-
This section describes the configuration of a GitHub repository.
72+
This section describes the configuration of a GitHub repository. Private Mendix Platform supports GitHub Enterprise Server and GitHub Enterprise Cloud.
73+
74+
### Prerequisites
75+
76+
Before configuring GitHub for Private Mendix Platform, ensure that you fulfill the following prerequisites:
77+
78+
* You have access to GitHub Enterprise Server or GitHub Enterprise Cloud.
79+
* A GitHub organization exists to host applications created by the Private Mendix Platform.
80+
* You can generate Personal Access Tokens (PATs) with sufficient permissions to manage repositories and organization access.
81+
* For GitHub Enterprise Server with Automatic Access Provisioning enabled, a GitHub administrator‑level PAT is available.
82+
* For GitHub Enterprise Cloud with Data Residency enabled, an OAuth App can be created in the GitHub organisation.
83+
84+
### Common Configuration
85+
86+
The following configuration applies to all GitHub server types, unless stated otherwise.
5787

58-
* **Host URL** - This is the host URL of your GitHub server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your GitHub server host name is mygithub.example.com, you should input `https://mygithub.example.com` here.
5988
* **Organization Name** - All the apps on Private Mendix Platform are created under an organization. You need to create an organization to host all the Mendix apps. Type the organization name into this field.
6089
* **Organization Owner PAT** - Input the classic PAT of this organization owner into this field. You need select at least these scopes: `repo admin:org user delete_repo`. The expiration date is set to **No Expiration**.
90+
91+
### GitHub Enterprise Server
92+
93+
* **Host URL** - This is the host URL of your GitHub server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your GitHub server host name is mygithub.example.com, you should input `https://mygithub.example.com` here.
6194
* **Automatic Access Provisioning** - If you are running a self-managed GitHub enterprise server, you can enable this feature to automatically create GitHub user and PAT for private platform users. During logging in to the platform, the user email is used as unique key to search in GitHub server. If this email name is not registered in GitHub, Private Mendix Platform creates a GitHub user with this email. A PAT is then generated for this user.
6295
* **AdminPAT** - This is the PAT of the GitHub enterprise instance administrator. When generating this PAT, all scopes should be selected.
6396

0 commit comments

Comments
 (0)