Skip to content

docs: Show the api option for self-hosted users in the quick start #8829

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.

Sign up for GitHub

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

Closed
linear-code wants to merge 1 commit into from
Closed

docs: Show the api option for self-hosted users in the quick start #8829

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion docs/docs/getting-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,21 @@ Then paste your API key into the code below:
<script>
flagsmith.init({
environmentID: '<add your API key here!>',
// Only needed if you are self-hosting Flagsmith or using a private cloud.
// Leave this commented out if you are using app.flagsmith.com.
// api: 'https://flagsmith.example.com/api/v1/',
onChange: (oldFlags, params) => {},
});
</script>
```

If you are using the SaaS platform at [app.flagsmith.com](https://app.flagsmith.com/), you can leave the `api` option
commented out, as the SDK connects to Flagsmith's SaaS API by default. If you are self-hosting Flagsmith or using a
private cloud, uncomment it and replace the URL with your own Flagsmith API URL, including the `/api/v1/` suffix.

Comment on lines +97 to +100

@emyller emyller Oct 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is slop.

Now when the browser opens the web page, it will download the Javascript SDK and make a call to `edge.api.flagsmith.com`
to get the flags for our Environment. You can see this in the browser network tab:
(or your own API URL, if you set `api`) to get the flags for our Environment. You can see this in the browser network
tab:

<div style={{textAlign: 'center'}}><img width="75%" src="/img/quickstart/demo_create_7.png"/></div>

Expand All @@ -106,6 +114,7 @@ Let's hook this value up to our button, so that the value of the flag controls w
<script>
flagsmith.init({
environmentID: '<add your API key here!>',
// api: 'https://flagsmith.example.com/api/v1/', // Self-hosted or private cloud only
onChange: (oldFlags, params) => {
if (flagsmith.hasFeature('show_demo_button')) {
var submit_button = document.getElementById('submit_button');
Expand All @@ -131,6 +140,7 @@ Our entire web page now reads like this:
<script>
flagsmith.init({
environmentID: 'ZfmJTbLQZrhZVHkVhXbsNi',
// api: 'https://flagsmith.example.com/api/v1/', // Self-hosted or private cloud only
onChange: (oldFlags, params) => {
if (flagsmith.hasFeature('show_demo_button')) {
var submit_button = document.getElementById('submit_button');
Expand Down
Loading