Workspace Apps
A Workspace App lets you access an application or process through HTTP or HTTPS running on a port of your Workspace. You can have multiple Workspace Apps attached to a single workspace, each accessing an application running on a different port. Common use cases include testing web applications, webhooks and callbacks, and exposing the web interfaces of development tooling.
Create a Workspace App
Workspace apps can be created in different ways.
-
From the Project Overview page, select the Create Workspace App button from the Workspace Apps drop-down menu and follow the onscreen instructions.
-
When creating or editing a workspace or workspace template, select the Workspace Apps menu in the wizard and follow the onscreen instructions. When adding a workspace app to a template, all child workspaces inherit this setting automatically.
-
Click the “…“ icon on a workspace and select Edit Ports.
In either case, you need to enter the following information:
- Port — The port where the app or process is running in your workspace.
- Name — A display name for the workspace app. SDS uses this name to reference the app.
- Override Host Header — Enable this option when your application rejects requests because of a Host header mismatch. See Override Host Header for details.
- Use HTTPS — Enable this option only if your application serves its own TLS certificates. For most scenarios, leave this off. Regardless of this setting, the platform is always exposed over HTTPS, so the browser connection appears as HTTPS. The toggle controls only whether the platform calls the app within the workspace using HTTP or HTTPS.
- Share — Control who can access the application. See Share a Workspace App for options.
Tip
When you create a workspace app for a Node.js project, make sure the port number matches the one opened in the localhost of the workspace.
Override Host Header
When a workspace app runs behind the SDS proxy, some applications (such as Jupyter Notebook or pgAdmin) may block requests because of a mismatch between the Host header and the Origin header. By default, the proxy forwards localhost as the Host header, while the Origin header contains the workspace app’s public URL. Applications that do not check X-Forwarded-Host interpret this as a cross-origin request and reject it.
Enable Override Host Header to have the proxy send the workspace app’s public URL in the Host header instead of localhost. This aligns the Host, Origin, and X-Forwarded-Host headers so that the application works without per-tool proxy configuration.
When enabled, a Host Header field appears, pre-filled with the workspace app’s fully qualified domain name (FQDN). You can accept the default or enter a custom value.
Important
Leave Override Host Header disabled for local development workflows where the server expects
localhostas the Host header. Enabling it in those cases can break the application.
Share a Workspace App
You can share a workspace app when creating it or by editing an existing one.
To update the properties of a workspace app, either:
- On the Project Overview page, click the “…“ icon on the workspace app and select Edit.
- Click the “…“ icon on the workspace that hosts the app and select Edit Ports.
There are three sharing options:
- Public — Everyone with the link who can connect to the SDS environment over the network can access the workspace app.
- Project Sharing — Only members of the SDS project can access the workspace app.
- Share With Project members — Only the selected members of the SDS project can access the workspace app.
Granting access to a workspace app does not provide access to the workspace that runs the app. To share a workspace with another user, use the Share Workspace functionality.
Delete a Workspace App
You can delete a workspace app from the Overview page by pressing the “…“ icon and selecting Delete. You can also delete a workspace app by clicking the “…“ icon on a workspace and selecting Edit Ports.
