From d854d4525bf1a25033594876f71214432aa9639c Mon Sep 17 00:00:00 2001 From: Justin Clareburt <122523970+justo-mend@users.noreply.github.com> Date: Tue, 24 Oct 2023 14:29:37 +0200 Subject: [PATCH] docs: Updated GettingStarted docs for Renovate CE and EE (#25284) Co-authored-by: Rhys Arkins <rhys@arkins.net> Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> --- docs/usage/getting-started/running.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/usage/getting-started/running.md b/docs/usage/getting-started/running.md index d44fc37f20..e710ed7f5f 100644 --- a/docs/usage/getting-started/running.md +++ b/docs/usage/getting-started/running.md @@ -2,8 +2,8 @@ As end user, you can choose from these ways to run Renovate: -- You use the Mend Renovate App, or -- You self-host Renovate, for example by running the pre-built Docker image, or +- You use the Mend Renovate App +- You self-administer/host your own Renovate instance - Someone else is hosting Renovate, and you install/configure it for the repositories you choose If you're using the Mend Renovate App, or if someone else is hosting Renovate for you, skip ahead to the [installing & onboarding](./installing-onboarding.md) page. @@ -19,6 +19,8 @@ When self-hosting Renovate you're the "administrator" of the bot, this means you If you're self-hosting Renovate on Windows, read [Self-hosting on Windows](./installing-onboarding.md#self-hosting-on-windows) to prevent line endings from confusing Renovate bot. +If you're running Renovate Community Edition or Renovate Enterprise Edition, refer to the documentation on the [`mend/renovate-ce-ee` GitHub repository](https://github.com/mend/renovate-ce-ee). + ### Available distributions #### npm package (CLI) @@ -81,9 +83,10 @@ The Renovate team provide a ["Renovate Runner"](https://gitlab.com/renovate-bot/ This supports both `gitlab.com` and self-hosted GitLab. Details for how it works can be found in the project. -#### Mend Renovate On-Premises +#### Mend Renovate Community Edition / Enterprise Edition -Mend Renovate On-Premises (WSOP) started out as a commercial product "Renovate Pro", but was renamed and made free to use when Renovate became a part of Mend (formerly WhiteSource) in 2019. +Mend Renovate Community Edition (Renovate CE) and Enterprise Edition (Renovate EE) are closed-source offerings of Renovate for self-hosted users. +Renovate CE and Renovate EE have support for GitHub (both `github.com` and GitHub Enterprise Server) as well as GitLab self-hosted. It is built similarly to the default "full" Renovate image described above, but with these differences: - It is a stateful app and does not exit after processing all repositories @@ -92,8 +95,15 @@ It is built similarly to the default "full" Renovate image described above, but - It is released every 1-2 months in a slower, more stable cadence than Renovate OSS, which releases on every commit - It's licensed using an end-user license agreement (EULA) and not the Affero General Public License (AGPL) -WSOP supports GitHub (both `github.com` and GitHub Enterprise Server) as well as GitLab self-hosted. -Documentation can be found in its public GitHub repository [`whitesource/renovate-on-prem`](https://github.com/whitesource/renovate-on-prem). +Plus, the Enterprise Edition has: + +- Horizontal scaling to run multiple 'worker' containers +- Dedicated support from Mend.io +- Premium features, including Smart Merge Control + +Go to the Mend.io website to learn more about [Renovate Enterprise Edition](https://www.mend.io/renovate-enterprise/). + +To learn how to configure Renovate CE or Renovate EE, read the documentation on the public GitHub repository [`mend/renovate-ce-ee`](https://github.com/mend/renovate-ce-ee). #### Mend Remediate -- GitLab