Skip to content

Commit c50ce54

Browse files
committed
docs: document multi-credential support for Pro licenses
Update Pro docs to reflect the new ability to create up to 5 additional credential pairs per license for different environments (dev, CI, etc.).
1 parent fb29945 commit c50ce54

3 files changed

Lines changed: 17 additions & 3 deletions

File tree

Pro/FAQ.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,9 @@ Licenses are **not** transferrable to another company. It is strongly recommende
187187

188188
## Do I have to share the credentials with all of my developers?
189189

190-
In general, **yes**. The credentials are required to download the gems and your developers will need the gems to use the commercial features.
190+
Not necessarily. You can create up to 5 additional credential pairs from your license page, each with its own label (e.g. "development", "ci"). This allows you to issue separate credentials for different teams or environments without sharing a single set. Each additional credential can be independently rotated or removed.
191+
192+
If you prefer not to use multiple credentials, sharing the primary credentials with your developers also remains a valid approach.
191193

192194
## Can I get a refund?
193195

Pro/Getting-Started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ To activate Karafka Pro, you need to do three things:
2929

3030
An Enterprise license is required if you are looking into hosting the license key offline within the app or via a private registry. This mode of operation allows you to use Karafka Pro without relying on our gem server. An Enterprise Agreement will grant you access to the license gem sources and installation instructions, ensuring you can proceed smoothly with your preferred setup.
3131

32+
## Additional Credentials
33+
34+
You can create up to 5 additional credential pairs from your license page for different environments or teams (e.g. development, CI). Each additional credential provides its own username and password that can be used in place of the primary credential in your `Gemfile`. Additional credentials can be individually rotated or removed without affecting other credentials.
35+
36+
To manage additional credentials, visit your license credentials page and use the "Add credential" form.
37+
3238
## License Gem Integrity Verification
3339

3440
!!! info "Checksum Verification in Enterprise Mode Not Needed"

Pro/Rotating-Credentials.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
If your credentials leak due to internal or external incidents, you should rotate them.
22

3-
To do so:
3+
## Rotating the Primary Credential
4+
5+
To rotate your primary (main) credential:
46

57
1. Go to your license credentials page.
68

79
<p align="center">
810
<img src="https://karafka.io/assets/misc/printscreens/gems_license_page.png" />
911
</p>
1012

11-
1. Press the "Rotate credentials" button.
13+
1. Press the "Rotate" button next to the main credential.
1214

1315
1. Read the disclaimers.
1416

@@ -22,6 +24,10 @@ To do so:
2224

2325
1. View your new credentials and replace them in your Gemfile and any other place where you use them.
2426

27+
## Rotating Additional Credentials
28+
29+
If you use [additional credentials](Pro-Getting-Started#additional-credentials) (e.g. for CI or development environments), each one can be rotated independently from the license page. Press the "Rotate" button next to the specific credential you want to rotate and follow the same email confirmation flow. Only the rotated credential is affected; all other credentials remain unchanged.
30+
2531
---
2632

2733
## See Also

0 commit comments

Comments
 (0)