You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Change all occurrences of previous sandbox/prod distinction to reflect our new model (#251)
## Description
Documentation should now be up to date with our new changes made to room
manager as well as web-client-sdk
---------
Co-authored-by: adrian <33912477+czerwiukk@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/examples/react-native.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ sidebar_position: 0
8
8
_Runnable reference apps demonstrating common Fishjam use cases in React Native_
9
9
10
10
Each example is a standalone Expo application you can run locally and use as a starting point for your own project.
11
-
All examples use `@fishjam-cloud/react-native-client` and require a Fishjam ID from the [Fishjam Dashboard](https://fishjam.io/app).
11
+
All examples use `@fishjam-cloud/react-native-client`. You need a Fishjam ID to connect to the media server, and a Sandbox API URL to create rooms and get peer tokens. Get your Fishjam ID from the [Fishjam Dashboard](https://fishjam.io/app), and your Sandbox API URL from the [Sandbox tab](https://fishjam.io/app/sandbox). See [What is the Sandbox API?](../explanation/sandbox-api-concept) for an in-depth explanation.
Copy file name to clipboardExpand all lines: docs/examples/react.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ sidebar_position: 1
8
8
_Runnable reference apps demonstrating common Fishjam use cases in React_
9
9
10
10
Each example is a standalone React application you can run locally and use as a starting point for your own project.
11
-
All examples use `@fishjam-cloud/react-client` and require a Fishjam ID from the [Fishjam Dashboard](https://fishjam.io/app).
11
+
All examples use `@fishjam-cloud/react-client`. You need a Fishjam ID to connect to the media server, and a Sandbox API URL to create rooms and get peer tokens. Get your Fishjam ID from the [Fishjam Dashboard](https://fishjam.io/app), and your Sandbox API URL from the [Sandbox tab](https://fishjam.io/app/sandbox). See [What is the Sandbox API?](../explanation/sandbox-api-concept) for an in-depth explanation.
Copy file name to clipboardExpand all lines: docs/explanation/glossary.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,4 +36,4 @@ The ID of your Fishjam instance. It is used by your backend server to add peers
36
36
37
37
### Sandbox API
38
38
39
-
A simple testing API allowing you to test Fishjam features without requiring you to add any functionalities to your backend. As the name suggests, it's available **only** in the Sandbox environment. You can find more details [here](/how-to/backend/sandbox-api-testing).
39
+
A simple testing API allowing you to test Fishjam features without requiring you to add any functionalities to your backend. It is intended for development and testing only, not for production use. You can find more details [here](/how-to/backend/sandbox-api-testing).
Copy file name to clipboardExpand all lines: docs/explanation/sandbox-api-concept.mdx
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,27 @@ The Sandbox API is a development tool that simplifies getting started with Fishj
10
10
11
11
## What can the Sandbox API do?
12
12
13
-
The Sandbox API is an HTTP server that comes with Fishjam's Sandbox environment.
13
+
The Sandbox API is an HTTP server provided by us for development and testing.
14
14
It provides basic room creation and peer management functionality without requiring you to set up your own backend infrastructure.
15
15
16
16
### Key Characteristics
17
17
18
18
-**Development-purposed**: Designed for initial development and testing
19
19
-**No authentication**: Simplified access for quick prototyping
20
-
-**Sandbox-only**: Only available in the Sandbox environment
20
+
-**Testing-only**: Not intended for production use; use your own authenticated backend for production
21
+
22
+
## Sandbox API URL and Fishjam ID
23
+
24
+
You can find your sandbox credentials in the [Sandbox tab](https://fishjam.io/app/sandbox) of the Fishjam Dashboard.
25
+
26
+
The **Sandbox API** is a hosted HTTP backend you can use to test Fishjam without writing your own server. It creates [**rooms**](../explanation/rooms) and **peers** for conferencing, and supports [**livestreaming**](../explanation/livestreams) by issuing the streamer and viewer credentials. It's an example implementation of what you need to build using our [**JavaScript server SDK**](../api/server) to go to production.
27
+
28
+
You can use your sandbox credentials by passing them to the `useSandbox` hook in the client SDK, which will create rooms and peer tokens for you, or by calling the Sandbox API URL directly from your client and using the returned `peerToken` to connect to Fishjam.
29
+
30
+
The **Fishjam ID** from the [Dashboard tab](https://fishjam.io/app) is passed to `FishjamProvider` so the client can connect to the Fishjam media server after it gets a peer token.
31
+
32
+
If your Sandbox API URL is exposed or your credentials are compromised, generate a new URL from the Sandbox tab to invalidate the old one. You can also disable the Sandbox API and enable it again when you want to resume sandbox testing.
33
+
If you expose your Sandbox API URL in a public deployment, it can leak (for example through client code or network requests). Anyone who obtains that URL can create rooms and peers on your behalf.
Copy file name to clipboardExpand all lines: docs/how-to/backend/production-deployment.mdx
+16-13Lines changed: 16 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@ type: how-to
3
3
description: Deploy your Fishjam backend safely to production, moving from sandbox to a production-ready setup.
4
4
---
5
5
6
-
importTabsfrom"@theme/Tabs";
7
6
importTabItemfrom"@theme/TabItem";
7
+
importTabsfrom"@theme/Tabs";
8
8
9
9
# How to Deploy Fishjam to Production
10
10
@@ -15,27 +15,29 @@ This guide covers the essential steps to move from development (using the Sandbo
15
15
## Prerequisites
16
16
17
17
- Working Fishjam backend (see [Backend Quick Start](../../tutorials/backend-quick-start))
18
-
-Production Fishjam environment (not Sandbox)
18
+
-A Fishjam account on the **Standard Jar** plan (recommended for production deployments)
19
19
- Domain and SSL certificates for your backend
20
20
- Production database and infrastructure
21
21
22
-
## Step 1: Set up production Fishjam environment
22
+
## Step 1: Get your Fishjam credentials
23
23
24
-
### Get production credentials
24
+
### Get credentials from the dashboard
25
25
26
26
1. Log in to [Fishjam Dashboard](https://fishjam.io/app)
27
-
2. Create or select your **Production** environment (not Sandbox)
28
-
3. Copy your production **Fishjam ID** and **Management Token**
29
-
4. Note: These are different from your sandbox credentials
27
+
2. Copy your **Fishjam ID** and **Management Token** from the dashboard
28
+
29
+
:::tip
30
+
The **Standard Jar** plan is recommended for production deployments. With the **Mini Jar** plan, you can still develop and test using the Sandbox API, but production deployments should use the Standard Jar plan to get full access and reliability guarantees.
**Problem**: Invalid Fishjam ID or network issues.
291
+
**Problem**: Invalid Fishjam ID, invalid Sandbox API URL, disabled Sandbox API, or network issues.
282
292
283
293
**Solution**:
284
294
285
-
1. Verify your Fishjam ID in the Fishjam Dashboard
286
-
2. Check network connectivity
287
-
3. Ensure you're using the sandbox environment
295
+
1. Verify your Fishjam ID in the Fishjam Dashboard.
296
+
2. Verify your Sandbox API URL in the [Sandbox tab](https://fishjam.io/app/sandbox).
297
+
3. Make sure the Sandbox API is enabled.
298
+
4. Check network connectivity.
288
299
289
300
## Security reminder
290
301
291
302
:::danger
292
303
**The Sandbox API is not safe for production!**
293
304
294
305
- No authentication required
295
-
- Anyone with your Fishjam ID can join rooms
306
+
- Anyone with your Sandbox API URL can create rooms and peer tokens
296
307
- Identical room/peer names get the same tokens
297
308
- No rate limiting or abuse protection
298
309
299
310
Only use the Sandbox API for development and testing.
300
311
:::
301
312
302
-
## Resetting your app
303
-
304
-
If you need to reset your Sandbox API:
313
+
## Managing your Sandbox API
305
314
306
-
1. Go to [Fishjam Dashboard](https://fishjam.io/app/sandbox)
307
-
2. Click **Settings**
308
-
3. Click **Reset App**
309
-
4. Get your new Fishjam ID
315
+
Manage the Sandbox API from the [Sandbox tab](https://fishjam.io/app/sandbox):
310
316
311
-
This will invalidate all existing tokens (including the management token!) and give you a fresh sandbox environment.
317
+
- If your Sandbox API URL is exposed or credentials are compromised, click **Generate new URL**. This invalidates the old URL.
318
+
- If you want to stop using it, click **Disable Sandbox API**.
319
+
- When you want to use it again, click **Enable Sandbox API**.
320
+
Your `FISHJAM_ID` is still required by `FishjamProvider` to connect to the Fishjam media server. The Sandbox API URL is only used to request test room and peer tokens.
0 commit comments