Skip to content

Commit c309665

Browse files
authored
docs: FAQ page components and data (#6402)
1 parent 00cb29d commit c309665

File tree

27 files changed

+1060
-14
lines changed

27 files changed

+1060
-14
lines changed

docs/docs/administration-and-security/access-control/saml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Users that log in using SSO can only belong to one Flagsmith organisation. If a
2828

2929
If you are self-hosting Flagsmith, TLS is required. Encrypted SAML assertions are not supported.
3030

31-
## Setup SAML
31+
## Setup SAML {#setup}
3232

3333
:::tip
3434

@@ -105,7 +105,7 @@ this mapping tells Flagsmith to look for user groups in a claim other than the d
105105

106106
By default, users logging in via SAML will have no permissions to view or modify anything in the Flagsmith dashboard. You can customise this by creating a [group](/administration-and-security/access-control/rbac) with the "Add new users by default" option enabled, and assigning your desired default permissions to that group.
107107

108-
### Using groups from your identity provider
108+
### Using groups from your identity provider {#using-groups-from-your-saml-idp}
109109

110110
Flagsmith can add or remove a user from groups based on your identity provider's SAML response when logging in.
111111

docs/docs/deployment-self-hosting/core-configuration/environment-variables.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,14 @@ This page provides a comprehensive reference for all the environment variables y
5757
- `ALBACROSS_CLIENT_ID`: Albacross client ID key for behaviour tracking.
5858
- `BASE_URL`: Used for specifying a base URL path that's ignored during routing if serving from a subdirectory.
5959
- `USE_SECURE_COOKIES`: Enable/disable the use of secure cookies. If deploying the frontend in a private network without a domain/SSL cert, disable secure cookies to ensure that session token is persisted. Default: true.
60-
- `COOKIE_SAME_SITE`: Define the value of the SameSite attribute for the session token cookie set by the frontend. Further reading on this value is available [here](https://web.dev/articles/samesite-cookies-explained). Default: 'none'.
60+
- `COOKIE_SAME_SITE`: Define the value of the SameSite attribute for the session token cookie set by the frontend. Further reading on this value is available [here](https://web.dev/articles/samesite-cookies-explained). Default: 'none'.
61+
62+
## OAuth configuration
63+
64+
### Google OAuth {#oauth-google}
65+
66+
To configure Google OAuth, ensure you have set the relevant OAuth client credentials in your deployment platform, and created the **Flagsmith on Flagsmith** flag as described in the [OAuth guide](/administration-and-security/access-control/oauth). This flag controls whether Google SSO is available in your instance.
67+
68+
### GitHub OAuth {#oauth-github}
69+
70+
To configure GitHub OAuth, ensure you have set `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` in your environment, and created the **Flagsmith on Flagsmith** flag as described in the [OAuth guide](/administration-and-security/access-control/oauth). This enables the GitHub SSO option in your instance.

docs/docs/deployment-self-hosting/edge-proxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Optionally, specify the LRU cache size with `cache_max_size`. Defaults to 128.
157157

158158
When set to `true`, the Edge Proxy will use the `X-Forwarded-For` and `X-Forwarded-Proto` HTTP headers to determine
159159
client IP addresses. This is useful if the Edge Proxy is running behind a reverse proxy, and you want the
160-
[access logs](#logging.override) to show the real IP addresses of your clients.
160+
[access logs](#loggingoverride) to show the real IP addresses of your clients.
161161

162162
By default, only the loopback address is trusted. This can be changed with the [`FORWARDED_ALLOW_IPS` environment
163163
variable](#environment-variables).

docs/docs/flagsmith-concepts/identities.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ Trait values can be stored as one of four different data types:
100100

101101
If you need to store 64 bit integers or very high precision floats we suggest storing them as strings and then doing the type conversion within the SDK.
102102

103+
## Transient Traits and Identities {#transient-traits}
104+
105+
In some privacy-sensitive cases, you may want to evaluate flags based on traits without persisting those traits in Flagsmith long term. Transient traits and identities let you send data for evaluation while avoiding long-lived storage in the platform. See your SDK documentation for how to mark traits or identities as transient when evaluating flags.
106+
103107
## Bulk Uploading Identities and Traits
104108

105109
Identities are lazily created within Flagsmith. There might be instances where you want to push identity and trait data into the platform outside of a user session. We have [bulk upload API endpoints](/edge-api/bulk-insert-identities-update) for this.

docs/docs/flagsmith-concepts/segments/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ See [minimum required SDK versions](/flagsmith-concepts/segments/segment-rule-op
7878

7979
In addition to identity [traits](/flagsmith-concepts/identities#identity-traits), you can use the following context values as Segment rule properties. For more information about identities and traits, see the [Identities documentation](/flagsmith-concepts/identities).
8080

81-
- **Identifier**: a unique identifier for an identity, used for segment and multivariate feature flag targeting, and displayed in the Flagsmith UI. Useful for bucketing via the [`% Split`](./segment-rule-operators#percentage-split) operator, or managing a list of users via the [`In`](./segment-rule-operators#in) operator.
81+
- **Identifier**: a unique identifier for an identity, used for segment and multivariate feature flag targeting, and displayed in the Flagsmith UI. Useful for bucketing via the [`% Split`](./segment-rule-operators?operators=percent#operator-details) operator, or managing a list of users via the [`In`](./segment-rule-operators?operators=in#operator-details) operator.
8282
- **Identity Key**: a key used when selecting a value for a multivariate feature, or for % split segmentation. Set to an internal identifier or a composite value based on the environment key and identifier, depending on Flagsmith implementation.
8383
- **Environment Name**: an environment's human-readable name. Useful for restricting Segments to certain environments.
8484

docs/docs/integrating-with-flagsmith/integration-overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ For privacy-sensitive use cases, you can use transient traits and identities. Th
4949

5050
Learn more about this feature in our [Transient Traits and Identities documentation](/flagsmith-concepts/identities#transient-traits).
5151

52+
## Local Evaluation Mode {#local-evaluation-mode}
53+
54+
For low-latency, high-throughput back-end use cases, you can run SDKs in Local Evaluation mode or use the [Edge Proxy](/deployment-self-hosting/edge-proxy). In this mode the SDK periodically fetches an environment document and evaluates flags locally without making per-request calls to the Flagsmith API. See the [Server-side SDKs documentation](/integrating-with-flagsmith/sdks/server-side#local-evaluation-mode-network-behaviour) for detailed behaviour and trade-offs.
55+
5256
## Third-party Integrations
5357

5458
Flagsmith also integrates with a variety of third-party tools for analytics, project management, and more. You can browse all available integrations in the [Integrations section](/third-party-integrations/analytics/segment).

docs/docs/integrating-with-flagsmith/sdks/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ are all computed locally.
354354
- Identities and their Traits are **not** read from or written to the Flagsmith API, and so are not persisted in the
355355
datastore. This means that you have to provide the full complement of Traits when requesting the Flags for a
356356
particular Identity. Our SDKs all provide relevant methods to achieve this.
357-
- [Analytics-based Integrations](/third-party-integrations#analytics-platforms) do not run.
357+
- [Analytics-based Integrations](/third-party-integrations#analytics--data-platforms) do not run.
358358
- [Flag Analytics](/managing-flags/flag-analytics) do still work, if enabled within the
359359
[SDK setup](/integrating-with-flagsmith/sdks/server-side#configuring-the-sdk).
360360
- **[Edge API](/deployment-self-hosting/edge-proxy) only**: Currently, Flagsmith SDKs support up to ~500 identity overrides, depending on flag value sizes and segment count, when used with

docs/docs/integrating-with-flagsmith/sdks/server-side.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Server Side SDKs can run in 2 different modes: Local Evaluation and Remote Evalu
8484
</TabItem>
8585
</Tabs>
8686

87-
## Add the Flagsmith package
87+
## Add the Flagsmith package {#python}
8888

8989
<Tabs groupId="language" queryString>
9090
<TabItem value="python" label="Python">
@@ -117,7 +117,7 @@ pip install flagsmith
117117
</CodeBlock>
118118

119119
</TabItem>
120-
<TabItem value="dotnet" label=".NET">
120+
<TabItem value="dotnet" label=".NET" id="net">
121121

122122
<h3>Package Manager console</h3>
123123
<CodeBlock>

docs/docs/managing-flags/core-management.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,7 @@ Deleting a feature flag is permanent and cannot be undone. Make sure your applic
8888
### Permission Issues
8989

9090
- You may need additional permissions to create, edit, clone, or delete feature flags. If you see permission errors or options are disabled, contact your Flagsmith administrator to review your access rights. For more information, see the [Permissions and Roles](/administration-and-security/access-control/rbac) page.
91+
92+
## Remote Config {#remote-config}
93+
94+
Remote Config lets you return a typed value (string, number, boolean or JSON) alongside the on/off state of a feature. You configure Remote Config on the same feature definition, and SDKs read these values when evaluating flags, using the same targeting and rollout rules. This is useful for tweaking behaviour, thresholds, copy or layout without changing code, rather than only enabling or disabling features.

docs/docs/performance/edge-proxy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ Please see the [hosting documentation](/deployment-self-hosting/edge-proxy).
6666

6767
The standard Flagsmith architecture:
6868

69-
![Image](/img/edge-proxy-existing.svg)
69+
![Standard Flagsmith architecture](/img/architecture.svg)
7070

7171
With the proxy added to the mix:
7272

73-
![Image](/img/edge-proxy-proxy.svg)
73+
![Edge Proxy architecture](/img/edge-api-now.svg)

0 commit comments

Comments
 (0)