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, web hooks, and callbacks or exposing 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, as shown below, 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 will inherit this setting automatically.
In either case, you will need to enter the following information:
- Port where the app or process is running on your workspace
- Name for the workspace app. SDS will use this name to reference the app.
- Enable Use HTTPS to allow to use https in the application. For most scenarios, the HTTPS application setting toggle can be kept off for most scenarios. It only needs to be turned on if your application serves TLS certificates. For example, turn on this toggle to test the HTTPS flow during front-end development, even if your development server runs on HTTP. 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 to allow others to access the application (Public, Project Sharing or Share With Project members).
Tip:
When you create an Workspace App for a Node Js project, make sure the port number is the same as the one opened in the localhost of the workspace.
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:
- 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 the Edit Ports button
There are three sharing options:
- Public, everyone with the link who can connect to the SDS environment over the network, can connect to 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 one of your Workspace Apps does not provide access to the workspace running the app. To share a workspace with another user, please use the Share Workspace functionality.
Delete a Workspace App
You can delete a Workspace App from the Overview Pagee by pressing the “…” icon and clicking the Delete button. You can also delete a Workspace App from a workspace by clicking the “…” icon and select Edit Ports from a workspace on the Overview or Workspaces Pages.
