Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Img border rework #503

Merged
merged 2 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/advanced/code-references/bitbucket-pipe.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can find more information about Bitbucket Pipelines <a target="_blank" href=
## Setup

1. Create a new <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API credential</a> and store its values in secure pipeline variables with the following names: `CONFIGCAT_API_USER`, `CONFIGCAT_API_PASS`.
<img src="/docs/assets/cli/scan/pipe_secrets.png" alt="Bitbucket Pipe secrets" />
<img src="/docs/assets/cli/scan/pipe_secrets.png" className="bordered-img" alt="Bitbucket Pipe secrets" />

2. Get your selected [Config's ID](overview.mdx#config-id).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced/code-references/bitrise-step.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ to automatically scan your source code for feature flag and setting usages and u
## Setup

1. Create a new <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API credential</a> and store its values in secure pipeline variables with the following names: `CONFIGCAT_API_USER`, `CONFIGCAT_API_PASS`.
<img src="/docs/assets/cli/scan/bitrise_secrets.png" alt="Bitrise secrets" />
<img src="/docs/assets/cli/scan/bitrise_secrets.png" className="bordered-img" alt="Bitrise secrets" />

2. Get your selected [Config's ID](overview.mdx#config-id).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced/code-references/circleci-orb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can find more information about CircleCI Orbs <a target="_blank" href="https
## Setup

1. Create a new <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">ConfigCat Management API credential</a> and store its values in <a target="_blank" href="https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-project">CircleCI Environment Variables</a> with the following names: `CONFIGCAT_API_USER`, `CONFIGCAT_API_PASS`.
<img src="/docs/assets/cli/scan/cco_secrets.png" alt="CircleCI Orb secrets" />
<img src="/docs/assets/cli/scan/cco_secrets.png" className="bordered-img" alt="CircleCI Orb secrets" />

2. Get your selected [Config's ID](overview.mdx#config-id).

Expand Down
6 changes: 3 additions & 3 deletions website/docs/advanced/team-management/auto-assign-users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Furthermore, you can also set which Organization roles / Product permissions the

- Open your organization's authentication settings on the <a href="https://app.configcat.com/organization/authentication" target="_blank">ConfigCat Dashboard</a>.

<img className="saml-tutorial-img zoomable zoomable" src="/docs/assets/saml/dashboard/authentication.png" alt="Authentication settings" />
<img className="bordered-img zoomable zoomable" src="/docs/assets/saml/dashboard/authentication.png" alt="Authentication settings" />

- Select the domain you want to configure, and click `RE-CONFIGURE` (or just `CONFIGURE` if you haven’t configured it yet) under the `Auto-assign status`.

<img className="saml-tutorial-img zoomable zoomable" src="/docs/assets/saml/dashboard/auto_assign_config_new.png" alt="Auto-assign configuration" />
<img className="bordered-img zoomable zoomable" src="/docs/assets/saml/dashboard/auto_assign_config_new.png" alt="Auto-assign configuration" />

- In the dialog that appears, you can select which `Organization roles` and `Product permissions` should be assigned to the newly registered users.

<img className="saml-tutorial-img zoomable zoomable" src="/docs/assets/saml/dashboard/auto_assign_set_new.png" alt="Auto-assign setup" />
<img className="bordered-img zoomable zoomable" src="/docs/assets/saml/dashboard/auto_assign_set_new.png" alt="Auto-assign setup" />

- When you are ready, just hit `Save`.
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ In order to use the [SAML Single Sign-On](../../advanced/team-management/saml/ov

- Open your organization's authentication settings on the <a href="https://app.configcat.com/organization/authentication" target="_blank">ConfigCat Dashboard</a>.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/authentication.png" alt="ConfigCat authentication settings" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/authentication.png" alt="ConfigCat authentication settings" />

- Click `ADD & VERIFY DOMAIN`.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/add_domain_new.png" alt="ConfigCat add & verify domain" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/add_domain_new.png" alt="ConfigCat add & verify domain" />

- Type your domain name, then click `ADD`

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/domain_name_new.png" alt="ConfigCat add domain" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/domain_name_new.png" alt="ConfigCat add domain" />

- Follow the instructions on the appearing dialog to verify your domain.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/verify_domain_new.png" alt="ConfigCat verify domain" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/verify_domain_new.png" alt="ConfigCat verify domain" />
Original file line number Diff line number Diff line change
Expand Up @@ -17,77 +17,77 @@ Each SSO Identity Provider requires specific information to configure a SAML int

- Open your organization's authentication settings on the <a href="https://app.configcat.com/organization/authentication" target="_blank">ConfigCat Dashboard</a>.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/authentication.png" alt="ConfigCat authentication settings" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/authentication.png" alt="ConfigCat authentication settings" />

- Click `ADD SAML IDENTITY PROVIDER`.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/add_idp.png" alt="ConfigCat Add Identity Provider" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/add_idp.png" alt="ConfigCat Add Identity Provider" />

- Give a name for your Identity Provider, and click `Create`.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/adfs_name.png" alt="ConfigCat Name Identity Provider" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/adfs_name.png" alt="ConfigCat Name Identity Provider" />

- From the next section of the dialog, copy the following values and save them for further use.

- `Entity ID`
- `Assertion Consumer Service`

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/acs_entity_id_1.png" alt="ConfigCat SAML configuration" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/acs_entity_id_1.png" alt="ConfigCat SAML configuration" />

## 2. Configure a Relying Party Trust

- Open the ADFS Management console, and click `Add Relying Party Trust`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/2_add_relying_party.png" alt="ADFS add relying party trust" />
<img className="bordered-img" src="/docs/assets/saml/adfs/2_add_relying_party.png" alt="ADFS add relying party trust" />

- Make sure the `Claims aware` option is selected, and click `Start`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/3_claims_aware.png" alt="ADFS claims aware" />
<img className="bordered-img" src="/docs/assets/saml/adfs/3_claims_aware.png" alt="ADFS claims aware" />

- Select the `Enter data about this relying party manually` option, and click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/4_manual_metadata.png" alt="ADFS manual relying party setup" />
<img className="bordered-img" src="/docs/assets/saml/adfs/4_manual_metadata.png" alt="ADFS manual relying party setup" />

- Type a descriptive `Display name`, and click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/5_name.png" alt="ADFS display name" />
<img className="bordered-img" src="/docs/assets/saml/adfs/5_name.png" alt="ADFS display name" />

- No action required on the `Configure Certificate` pane, click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/6_configure_cert.png" alt="ADFS certificate configuration" />
<img className="bordered-img" src="/docs/assets/saml/adfs/6_configure_cert.png" alt="ADFS certificate configuration" />

- Select the `Enable support for the SAML 2.0 WebSSO protocol` option, and paste the value of `Assertion Consumer Service` from [Step 1](#1-collect-saml-metadata-from-configcat) into the `Relying party SAML 2.0 SSO service URL` field.
Then, Click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/7_acs_url.png" alt="ADFS acs URL" />
<img className="bordered-img" src="/docs/assets/saml/adfs/7_acs_url.png" alt="ADFS acs URL" />

- Paste the value of `Entity ID` from [Step 1](#1-collect-saml-metadata-from-configcat) into the `Relying party trust identifier` field, and click `Add`.
Then, click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/8_add_entity_id.png" alt="ADFS entity ID" />
<img className="bordered-img" src="/docs/assets/saml/adfs/8_add_entity_id.png" alt="ADFS entity ID" />

- No action required on the `Choose Access Control Policy` pane, click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/9_access_control_policy.png" alt="ADFS Access Control Policy" />
<img className="bordered-img" src="/docs/assets/saml/adfs/9_access_control_policy.png" alt="ADFS Access Control Policy" />

- Review the changes, then click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/10_ready_to_add_trust.png" alt="ADFS add trust" />
<img className="bordered-img" src="/docs/assets/saml/adfs/10_ready_to_add_trust.png" alt="ADFS add trust" />

- The Relying Party Trust is now successfully added, make sure the `Configure claims issuance policy for this application` option is checked, and click `Close`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/11_finish_party.png" alt="ADFS finish configuration" />
<img className="bordered-img" src="/docs/assets/saml/adfs/11_finish_party.png" alt="ADFS finish configuration" />

## 3. Configure Claims Issuance Policy

- After adding the Relying Party Trust, the following dialog should appear.
Click `Add rule`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/12_edit_claims.png" alt="ADFS edit claims" />
<img className="bordered-img" src="/docs/assets/saml/adfs/12_edit_claims.png" alt="ADFS edit claims" />

- Select `Send LDAP Attributes as Claims` as the `Claim rule template`, and click `Next`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/13_ldap_claims.png" alt="ADFS LDAP claims" />
<img className="bordered-img" src="/docs/assets/saml/adfs/13_ldap_claims.png" alt="ADFS LDAP claims" />

- Apply the following, and click `Finish`.

Expand All @@ -96,11 +96,11 @@ Click `Add rule`.
- Select `User-Principal-Name` as `LDAP Attribute`.
- Select `Name ID` as `Outgoing Claim Type`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/14_unc_to_nameid.png" alt="ADFS unc to nameid" />
<img className="bordered-img" src="/docs/assets/saml/adfs/14_unc_to_nameid.png" alt="ADFS unc to nameid" />

- Click `OK`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/15_finish_claims.png" alt="ADFS finish claims" />
<img className="bordered-img" src="/docs/assets/saml/adfs/15_finish_claims.png" alt="ADFS finish claims" />

## 4. Configure ConfigCat with SAML Details from ADFS

Expand All @@ -111,15 +111,15 @@ You can choose one of the following options to configure ConfigCat with SAML Ide
<ul>
<li>
<p>Select <code>Endpoints</code>, and copy the URL Path of the <code>Federation Metadata</code> endpoint.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/metadata_url.png" alt="ADFS metadata url path" />
<img className="bordered-img" src="/docs/assets/saml/adfs/metadata_url.png" alt="ADFS metadata url path" />
</li>
<li>
<p>Type the URL into the <code>Metadata URL</code> field at ConfigCat in the following format: <code>https://[ADFS-DOMAIN]/[FEDERATION-METADATA-URL-PATH]</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/cc_metadata_new.png" alt="ADFS metadata url" />
<img className="bordered-img" src="/docs/assets/saml/adfs/cc_metadata_new.png" alt="ADFS metadata url" />
</li>
<li>
<p>Select the <strong>trusted domains</strong>. Only user accounts from trusted domains can login with SAML SSO. You can bind multiple verified domains to a SAML Identity Provider.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/select_trusted_domains.png" alt="Select trusted domains" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/select_trusted_domains.png" alt="Select trusted domains" />
</li>
<li>
Click on <code>Save</code>.
Expand All @@ -130,44 +130,44 @@ You can choose one of the following options to configure ConfigCat with SAML Ide
<ul>
<li>
<p>Select <code>Endpoints</code>, and save the URL Path of the <code>SAML 2.0/WS-Federation</code> endpoint.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/login_url.png" alt="ADFS SAML verification" />
<img className="bordered-img" src="/docs/assets/saml/adfs/login_url.png" alt="ADFS SAML verification" />
</li>
<li>
<p>Select <code>Certificates</code>, then select the <code>Token Signing</code> certificate, and click <code>View Certificate</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/view_cert.png" alt="ADFS certificates" />
<img className="bordered-img" src="/docs/assets/saml/adfs/view_cert.png" alt="ADFS certificates" />
</li>
<li>
<p>On the <code>Details</code> tab click <code>Copy to File</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/copy_cert_to_file.png" alt="ADFS cert details" />
<img className="bordered-img" src="/docs/assets/saml/adfs/copy_cert_to_file.png" alt="ADFS cert details" />
</li>
<li>
<p>Click <code>Next</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/cert_wizard.png" alt="ADFS cert wizard" />
<img className="bordered-img" src="/docs/assets/saml/adfs/cert_wizard.png" alt="ADFS cert wizard" />
</li>
<li>
<p>Select the <code>Base-64 encoded X.509 (.CER)</code> option, and click <code>Next</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/cert_export_base64.png" alt="ADFS export base64" />
<img className="bordered-img" src="/docs/assets/saml/adfs/cert_export_base64.png" alt="ADFS export base64" />
</li>
<li>
<p>Browse the location where the certificate should be exported, and click <code>Next</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/cert_name.png" alt="ADFS cert name" />
<img className="bordered-img" src="/docs/assets/saml/adfs/cert_name.png" alt="ADFS cert name" />
</li>
<li>
<p>Click <code>Finish</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/cert_finish.png" alt="ADFS finish cert" />
<img className="bordered-img" src="/docs/assets/saml/adfs/cert_finish.png" alt="ADFS finish cert" />
</li>
<li>
<p>Click <code>OK</code>.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/cert_export_ok.png" alt="ADFS cert OK" />
<img className="bordered-img" src="/docs/assets/saml/adfs/cert_export_ok.png" alt="ADFS cert OK" />
</li>
<li>
<p>Type the <code>SAML 2.0/WS-Federation</code> endpoint into the <code>Sign-on URL</code> field in the following format: <code>https://[ADFS-DOMAIN]/[WS-FEDERATION-URL-PATH]</code>.
Then, paste the exported <code>Token Signing</code> certificate into the <code>X.509 Certificate</code> field.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/cc_manual_new.png" alt="ConfigCat manual configuration" />
<img className="bordered-img" src="/docs/assets/saml/adfs/cc_manual_new.png" alt="ConfigCat manual configuration" />
</li>
<li>
<p>Select the <strong>trusted domains</strong>. Only user accounts from trusted domains can login with SAML SSO. You can bind multiple verified domains to a SAML Identity Provider.</p>
<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/select_trusted_domains.png" alt="Select trusted domains" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/select_trusted_domains.png" alt="Select trusted domains" />
</li>
<li>
Click on <code>Save</code>.
Expand All @@ -180,15 +180,15 @@ You can choose one of the following options to configure ConfigCat with SAML Ide

- Go to the <a href="https://app.configcat.com/auth/login" target="_blank">ConfigCat Log In</a> page, and click `COMPANY ACCOUNT - SAML`.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/saml_login.png" alt="ConfigCat SAML login" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/saml_login.png" alt="ConfigCat SAML login" />

- Sign in with your company email address.

<img className="saml-tutorial-img" src="/docs/assets/saml/dashboard/company_email.png" alt="ConfigCat SAML company login" />
<img className="bordered-img" src="/docs/assets/saml/dashboard/company_email.png" alt="ConfigCat SAML company login" />

- ConfigCat will redirect you to the ADFS sign in page. Type your credentials, and click `Sign in`.

<img className="saml-tutorial-img" src="/docs/assets/saml/adfs/login.png" alt="ADFS log in" />
<img className="bordered-img" src="/docs/assets/saml/adfs/login.png" alt="ADFS log in" />

- You should be redirected to ConfigCat signed in with your company account.

Expand Down
Loading
Loading