Skip to content

Commit 30db0ff

Browse files
authored
docs: add EE to the docs (#361)
## 📝 Description This PR: - Adds EE v1.3.0 to the list of available editions on the docs - Adds the installation and licensing instructions for the EE, this includes using the license parameters in the Helm installation - Updates the feature comparison page to include EE **Pending changes:** - [x] note that installing without a license prompts for an invalid license message in the application - [x] add instructions to install with and without license file (license url is not needed) - [x] add instructions to install/upgrade the license on existing installations - [x] check if any git integration is enabled on this version - [x] added the production URL for the license server ## ✅ Checklist - [X] I have tested this change - [ ] This change requires documentation update
1 parent 5935771 commit 30db0ff

File tree

496 files changed

+26215
-203
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

496 files changed

+26215
-203
lines changed

docs/docs/getting-started/features.md

Lines changed: 58 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -15,74 +15,78 @@ This page compares the features available across all [Semaphore editions](./abou
1515

1616
## CI/CD Workflows
1717

18-
| Feature | Semaphore Cloud | Semaphore CE |
19-
|--|--|--|
20-
| Visual editor | Yes | Yes |
21-
| Artifacts | Yes | Yes |
22-
| Tasks | Yes | Yes |
23-
| SSH Debug | Yes | Yes |
24-
| Cache | Yes | Yes |
25-
| Monorepo support | Yes | Yes |
26-
| Initialization jobs | Yes | Yes |
27-
| Self-hosted agents | Yes | Yes |
28-
| GitHub support | Yes | Yes |
29-
| GitLab support | No | Yes |
30-
| Any Git Server support | No | Yes |
31-
| BitBucket support | Yes | Yes |
32-
| Promotions | Yes | No |
33-
| Parameterized promotions | Yes | No |
34-
| Deployment targets | Yes | No |
35-
| Pre-flight checks | Yes | No |
36-
| sem-service & sem-version | Yes | No |
18+
| Feature | Semaphore Cloud | Semaphore CE | Semaphore EE |
19+
|--|--|--|--|
20+
| Visual editor | Yes | Yes | Yes |
21+
| Artifacts | Yes | Yes | Yes |
22+
| Tasks | Yes | Yes | Yes |
23+
| SSH Debug | Yes | No | No |
24+
| Cache | Yes | Yes | Yes |
25+
| Monorepo support | Yes | Yes | Yes |
26+
| Initialization jobs | Yes | Yes | Yes |
27+
| Self-hosted agents | Yes | Yes | Yes |
28+
| GitHub support | Yes | Yes | Yes |
29+
| GitLab support | Yes | Yes | Yes |
30+
| BitBucket support | Yes | Yes | Yes |
31+
| Any Git Server support | No | Yes | Yes |
32+
| Promotions | Yes | No | Yes |
33+
| Parameterized promotions | Yes | No | Yes |
34+
| Deployment targets | Yes | No | Yes |
35+
| Pre-flight checks | Yes | No | Yes |
36+
| sem-service & sem-version | Yes | No | No |
37+
3738

3839
## Dashboards
3940

40-
| Feature | Semaphore Cloud | Semaphore CE |
41-
|--|--|--|
42-
| Test reports | Yes | Yes |
43-
| Markdown reports | Yes | Yes |
44-
| Activity monitor | Yes | Yes |
45-
| Custom Dashboards | Yes | No |
46-
| Flaky tests | Yes | No |
47-
| Project insights | Yes | No |
48-
| Organization health | Yes | No |
41+
| Feature | Semaphore Cloud | Semaphore CE | Semaphore EE |
42+
|--|--|--|--|
43+
| Test reports | Yes | Yes | Yes |
44+
| Markdown reports | Yes | Yes | Yes |
45+
| Activity monitor | Yes | Yes | Yes |
46+
| Custom Dashboards | Yes | No | Yes |
47+
| Flaky tests | Yes | No | Yes |
48+
| Project insights | Yes | No | Yes |
49+
| Organization health | Yes | No | Yes |
50+
4951

5052
## Security and compliance
5153

52-
| Feature | Semaphore Cloud | Semaphore CE |
53-
|--|--|--|
54-
| Project-level secrets | Yes | Yes |
55-
| Organization secrets | Yes | Yes |
56-
| Policies for accessing secrets | Yes | No |
57-
| Audit logs | Yes | No |
54+
| Feature | Semaphore Cloud | Semaphore CE | Semaphore EE |
55+
|--|--|--|--|
56+
| Project-level secrets | Yes | Yes | Yes |
57+
| Organization secrets | Yes | Yes | Yes |
58+
| Policies for accessing secrets | Yes | No | Yes |
59+
| Audit logs | Yes | No | Yes |
5860

59-
## User and permissions management
6061

61-
| Feature | Semaphore Cloud | Semaphore CE |
62-
|--|--|--|
63-
| Multiple organizations | Yes | No |
64-
| Invite users to your organization | Yes | Yes |
65-
| Organization roles | Yes | Yes |
66-
| Project roles | Yes | Yes (*) |
67-
| User groups | Yes | No |
68-
| Custom Roles | Yes | No |
62+
## User and permissions management
63+
64+
| Feature | Semaphore Cloud | Semaphore CE | Semaphore EE |
65+
|--|--|--|--|
66+
| Multiple organizations | Yes | No | No |
67+
| Invite users to your organization | Yes | Yes | Yes |
68+
| Organization roles | Yes | Yes | Yes |
69+
| Project roles | Yes | Yes (*) | Yes |
70+
| User groups | Yes | No | Yes |
71+
| Custom Roles | Yes | No | Yes |
6972

7073
(*) Project roles exist but cannot be manually assigned to individual users. The role is assigned based on project membership and server roles.
7174

72-
## Integrations
75+
## Integrations
7376

74-
| Feature | Semaphore Cloud | Semaphore CE |
75-
|--|--|--|
76-
| Repository status checks | Yes | Yes |
77-
| Repository badges | Yes | Yes |
78-
| Slack notifications | Yes | Yes |
79-
| Webhook notifications | Yes | Yes |
80-
| SAML/SCIM integrations | Yes | No |
81-
| Okta integration | Yes | No |
82-
| OpenID Connect | Yes | No |
83-
| GitHub SSO | Yes | No |
77+
| Feature | Semaphore Cloud | Semaphore CE | Semaphore EE |
78+
|--|--|--|--|
79+
| Repository status checks | Yes | Yes | Yes |
80+
| Repository badges | Yes | Yes | Yes |
81+
| Slack notifications | Yes | Yes | Yes |
82+
| Webhook notifications | Yes | Yes | Yes |
83+
| SAML/SCIM integrations | Yes | No | Yes |
84+
| Okta integration | Yes | No | Yes |
85+
| OpenID Connect | Yes | No | Yes |
86+
| GitHub SSO | Yes | No | Yes |
8487

8588
## See also
8689

8790
- [Guided tour](./guided-tour)
8891
- [Migration guides](./migration/overview)
92+

docs/docs/reference/pipeline-yaml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1201,7 +1201,7 @@ Global job config is not applied to `after_pipeline` jobs. This includes secrets
12011201

12021202
:::
12031203

1204-
## promotions {#promotions}
1204+
## Promotions {#promotions}
12051205

12061206
The `promotions` property is used for *promoting* (manually or automatically triggering) one or more pipelines using one or more pipeline YAML files. A pipeline YAML file can have a single `promotions` block or no `promotions` block.
12071207

docs/docs/using-semaphore/organizations.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,6 @@ You must install and connect the [Semaphore command line](../reference/semaphore
6767

6868
Semaphore users a [Role Based Access Control](./rbac) model to manage permissions at the organization and project level.
6969

70-
Free plans are limited to 5 users per organization. Paid plans have no user limit.
71-
72-
You can only invite people with GitHub or BitBucket accounts to your organization.
73-
7470
To manage users in your organization, open the organization menu and select **People**. This tab shows users and groups in your organization along with their roles and groups.
7571

7672
![The people tab](./img/people-tab.jpg)

docs/docs/using-semaphore/pipelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1056,7 +1056,7 @@ To change the global time limit for all jobs in a pipeline, follow these steps:
10561056

10571057
</Steps>
10581058

1059-
```shell title="Changing max duration for a single job"
1059+
```yaml title="Changing max duration for a single job"
10601060
version: v1.0
10611061
name: Pipeline using execution_time_limit
10621062
agent:

docs/docs/using-semaphore/projects.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Connect Git repos to Semaphore
2+
description: Connect Git repos to Semaphore (Cloud)
33
---
44

55
# Projects
@@ -21,21 +21,21 @@ This page explains how to set up projects and what settings are available.
2121
To create a Semaphore project you need:
2222

2323
- A [Semaphore](https://semaphoreci.com) account with an [organization](./organizations.md)
24+
- A repository with at least one commit
2425
- A GitHub or Bitbucket account. For more information, see the connection guides
2526
- [How to connect to GitHub](./connect-github)
2627
- [How to connect to Bitbucket](./connect-bitbucket)
27-
- A repository with at least one commit
2828

2929
<Tabs groupId="ui-cli">
3030
<TabItem value="ui" label="UI">
3131

32-
Go to Semaphore, press **+Create New** 1 and then press **Choose repository**
32+
Go to Semaphore, press **+Create New** and then press **Choose repository**
3333

3434
![Creating a new project](./img/create-project-1.jpg)
3535

3636
<Steps>
3737

38-
1. Select the GitHub or Bitbucket tab. You may need to press the **Connect account** button if this is the first time
38+
1. Select the GitHub or BitBucket tab. You may need to press the **Connect account** button if this is the first time
3939
2. Select the repository from the list and press on **Choose**
4040

4141
<details>

docs/docusaurus.config.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,12 @@ const config = {
7272
"CE-1.1": {
7373
label: 'Community Edition v1.1',
7474
path: 'CE-1.1',
75-
}
75+
},
76+
"EE": {
77+
label: 'Enterprise Edition v1.3',
78+
path: 'EE',
79+
banner: "none"
80+
},
7681
},
7782

7883
},
@@ -188,7 +193,7 @@ const config = {
188193
// This is an optional announcement bar. It goes on the top of the page
189194
announcementBar: {
190195
id: `announcementBar-1`,
191-
content: `Semaphore CE <strong>v1.2.0 is out</strong> — ⭐️ If you like Semaphore, <em>give it a star</em> on <a target="_blank" rel="noopener noreferrer" href="https://github.com/semaphoreio/semaphore">GitHub</a>`,
196+
content: `Semaphore <strong>Enterprise Edition</strong> v1.3.0 is available! — ⭐️ If you like Semaphore, <em>give it a star</em> on <a target="_blank" rel="noopener noreferrer" href="https://github.com/semaphoreio/semaphore">GitHub</a>`,
192197
backgroundColor: '#49a26e',
193198
textColor: '#f5f6f7'
194199
},

docs/src/pages/index.js

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,34 @@ function HomepageHeader() {
2424

2525
<p className={`hero__subtitle ${colorMode}`}>{siteConfig.tagline}</p>
2626

27-
{/* Container for all buttons + legends */}
2827
<div className={styles.buttonsWrapper}>
29-
{/* 1) Install Semaphore */}
3028
<div className={styles.buttonContainer}>
3129
<Link
3230
className="button button--primary button--lg"
3331
to="/CE/getting-started/install"
3432
>
35-
Install Semaphore
33+
Community Edition
3634
</Link>
37-
<p className={styles.legend}>Open-source Community Edition</p>
3835
</div>
3936

40-
{/* 2) Guided Tour */}
4137
<div className={styles.buttonContainer}>
4238
<Link
4339
className="button button--secondary button--lg"
40+
to="/EE/getting-started/install"
41+
>
42+
Enterprise Edition
43+
</Link>
44+
</div>
45+
46+
<div className={styles.buttonContainer}>
47+
<Link
48+
className="button button--outline button--secondary button--lg"
4449
to="/getting-started/guided-tour"
4550
>
4651
Guided Tour
4752
</Link>
48-
<p className={styles.legend}>Try Cloud Edition free</p>
4953
</div>
5054

51-
{/* 3) GitHub Star Button */}
5255
<div className={styles.buttonContainer}>
5356
<iframe
5457
className={styles.indexCtasGitHubButton}

docs/versioned_docs/version-CE/getting-started/faq.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ This page contains Frequently Asked Questions.
2323

2424
You can run Semaphore CE on any Linux machine or Kubernetes cluster. We provide detailed [installation instructions](./install.md) for popular cloud vendors and generic systems.
2525

26+
### Help! My Semaphore installation is too slow
27+
28+
First, check that your hardware meets the minimum requisites. See the [installation page](./install) to view what are the minimum hardware requisites.
29+
30+
If your machines meet the minimum requisites and your Semaphore Enterprise Edition runs slowly or has timeout problems, ensure you have activated all hardware-virtualization features in your VM. Failure to activate the proper virtualization mode can result in a slow or unresponding service.
31+
2632
### Help! Docker fails with "toomanyrequests"
2733

2834
This is commonly due to a rate-limit of third-party providers such as Docker Hub. These services limit how many unauthenticated pulls you can do in an hour, often based on IP. The machine or cluster running the jobs might have already tripped the IP rate limit.
@@ -48,7 +54,7 @@ Yes. To use a private Docker registry with a self-signed SSL certificate you mus
4854

4955
This will allow a connection to a private remote registry using the provided certificate.
5056

51-
## Git, GitHub and BitBucket
57+
## Git, GitHub, GitLab, and BitBucket
5258

5359
### Can I build a project with git submodules?
5460

0 commit comments

Comments
 (0)