Workspaces

After having signed up to Modal, you’ve automatically received a Personal Workspace that you can use to run and deploy personal apps. To deploy collaborate with others, however, you can create or join additional Workspaces.

Create a Workspace

Modal Workspaces are always associated with a GitHub organization. On the settings page, every GitHub organization to which you’ve granted Modal access will be listed.

If you don’t see the GitHub organization you’re looking for, click “Refresh GitHub Organizations”. This will retrieve from GitHub all organizations of which you are a member and update the displayed list. (If you are an outside collaborator with a GitHub organization, you must be upgraded to an organization member.)

Within the displayed list of organizations, you can click a list item’s “create” button to create a new Modal Workspace.

Inviting new Workspace members

To invite a new Workspace member, first switch your dashboard environment to an organization Workspace. Navigate to the settings page and under the “Invite Member” section enter the email address of the person you would like to invite. Click “invite” to send the invite. Invited members must be a member of the active Workspaces’s associated GitHub organization.

The invited person will receive an email with a link to join your Workspace. The email link will also allow them to sign up to Modal and create a Personal Workspace if they do not have one already.

Create a token for a Workspace

To interact with a Workspace’s resources programmatically, you need to add an API token for that Workspace. Your existing API tokens are displayed on the settings page and new API tokens can be added for a particular Workspace.

After adding a token for a Workspace to your Modal config file you can activate that Workspace’s profile using the CLI (see below).

As an administrator or workspace owner you can manage active tokens for a workspace on the member tokens page. For more information on API token management see the documentation about configuration.

Switching active Workspace

When on the dashboard or using the CLI, the active profile determines which personal or organizational Workspace is associated with your actions.

Dashboard

You can switch between organization Workspaces and your Personal Workspace by using the workspace selector at the top of the dashboard.

CLI

To switch the Workspace associated with CLI commands, use modal profile activate.

Administrating workspace members

Workspaces have three different levels of access privileges:

• Owner
• Administrator
• User

The user that creates a workspace is automatically set as the Owner for that workspace. The owner can assign any other roles within the workspace, as well as disable other members of the workspace.

An Administrator within a workspace can assign all roles except Owner and can also disable other members of the workspace.

A User of a workspace can not assign any access privileges within the workspace but can otherwise perform any action like running and deploying apps and modify Secrets.

As an Owner or administrator you can administrate the access privileges of other members on the Members settings page

Leaving a Workspace

To leave a Workspace, navigate to the settings page and click “leave” on a listed Workspace.