Skip to content

Commit 3ff989f

Browse files
z4kn4feinadams85
andauthored
Proxy Profile / OFREP documentation (#586)
* Add proxy profile docs * Progress * Rework usage scenarios * Add screenshots * Apply suggestions from code review Co-authored-by: adams85 <[email protected]> * PR comments / fix broken link * Fix broken link * Update endpoints.mdx * PR comments * Add beta notice * Add proxy profile limitation * Update subscription-plan-limits.mdx * Add version availability notice * Update overview.mdx * OFREP version notice * Add proxy profile news * Add v1 news * Fixup img and build --------- Co-authored-by: adams85 <[email protected]>
1 parent ac606cd commit 3ff989f

25 files changed

+1076
-206
lines changed

website/docs/advanced/proxy/endpoints.mdx

Lines changed: 431 additions & 124 deletions
Large diffs are not rendered by default.

website/docs/advanced/proxy/grpc.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
137137
defer cancel()
138138

139139
resp, err := client.EvalFlag(ctx, &proto.EvalRequest{
140-
SdkId: "my_sdk",
140+
SdkId: "<sdk-identifier>",
141141
Key: "<flag-key>",
142142
User: map[string]*proto.UserValue{"Identifier": {Value: &proto.UserValue_StringValue{StringValue: "<user-id>"}}}
143143
})

website/docs/advanced/proxy/overview.mdx

Lines changed: 580 additions & 78 deletions
Large diffs are not rendered by default.

website/docs/news.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,23 @@ Here, you'll find all the latest updates, enhancements, and new features we've a
88

99
{/* This page must be in sync with the news page on the Dashboard: https://github.com/configcat/app/blob/master/src/app/home-module/news/news.component.html */}
1010

11+
## Automatic ConfigCat Proxy configuration with Proxy profiles / OpenFeature Remote Evaluation Protocol
12+
13+
#### Aug 19, 2025
14+
15+
We have two exciting [ConfigCat Proxy](/docs/advanced/proxy/overview.mdx) related news:
16+
17+
1. From the [v2.0.0](https://github.com/configcat/configcat-proxy/releases/tag/v2.0.0) version,
18+
the Proxy has the ability to use [Proxy profiles](https://app.configcat.com/organization/proxy-profiles) to determine which SDK keys to download and distribute.
19+
:::info
20+
You need to be an Organization Admin to access the Proxy profiles page on the Dashboard.
21+
:::
22+
<img src="/docs/assets/news/proxy-profiles.png" alt="Proxy profiles page" width="1366" height="768" decoding="async" loading="lazy" />
23+
[See the documentation](/docs/advanced/proxy/overview.mdx#1-automatic-configuration-with-proxy-profiles) for more information on how to set up your Proxy with profiles.
24+
25+
2. From the [v2.0.0](https://github.com/configcat/configcat-proxy/releases/tag/v2.0.0) version, the Proxy conforms to the [OpenFeature Remote Evaluation Protocol](https://github.com/open-feature/protocol) (OFREP), which means it can be used with OFREP compatible OpenFeature providers.
26+
[See the API documentation](/docs/advanced/proxy/endpoints/#openfeature-remote-evaluation-protocol-ofrep) for the OFREP implementation with usage examples.
27+
1128
## New SDK for JavaScript with Cloudflare Workers support
1229

1330
#### Aug 15, 2025

website/docs/sdk-reference/openfeature/overview.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,13 @@ ConfigCat offers providers for the following platforms supported by OpenFeature
2323
- [React](./react.mdx)
2424
- [Ruby](./ruby.mdx)
2525
- [Rust](./rust.mdx)
26-
- [Swift (iOS)](./swift.mdx)
26+
- [Swift (iOS)](./swift.mdx)
27+
28+
## OpenFeature Remote Evaluation Protocol (OFREP)
29+
30+
The <a href="https://github.com/open-feature/protocol" target="_blank">OpenFeature Remote Flag Evaluation Protocol</a> is an
31+
API specification for feature flagging that allows the use of generic providers to connect
32+
to any feature flag management systems that supports the protocol.
33+
34+
ConfigCat conforms to OFREP via the [ConfigCat Proxy](../../advanced/proxy/overview.mdx).
35+
The API documentation for the OFREP implementation with usage examples is available [here](../../advanced/proxy/endpoints.mdx#openfeature-remote-evaluation-protocol-ofrep).

website/docs/subscription-plan-limits.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ Every value marked with a \* in the table marks a technical limit. If you reach
3131
| User Provisioning (SCIM) synced users | 10000\* | 10000\* | 10000\* | 10000\* | 10000\* | 10000\* | 10000\* |
3232
| User Provisioning (SCIM) synced groups | 1000\* | 1000\* | 1000\* | 1000\* | 1000\* | 1000\* | 1000\* |
3333
| User Provisioning (SCIM) groups with permissions | 2 | 5 | 10 | 500\* | 500\* | 5\* | 5\* |
34+
| Proxy profiles | 1 | 2 | 10 | 100\* | 100\* | 2\* | 2\* |

website/src/css/custom.scss

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,23 @@
5252
height: 100%;
5353
}
5454

55-
.video{
55+
.video {
5656
width: 100%;
5757
height: auto;
5858
}
5959

60+
li > h3 {
61+
font-size: 1.4rem;
62+
}
63+
64+
h4 {
65+
font-size: 1.2rem;
66+
}
67+
68+
h5 {
69+
font-size: 1.1rem;
70+
}
71+
6072
.bordered-img {
6173
border: 1px solid var(--bordered-img-color);
6274
margin-bottom: 1rem;

website/src/css/proxy.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626
td:nth-child(1) {
2727
max-width: 500px;
2828
}
29+
30+
th:last-of-type {
31+
width: 100%;
32+
}
2933
}
3034

3135
.endpoint {
526 KB
Loading
307 KB
Loading

0 commit comments

Comments
 (0)