Skip to content

Deploying an App ​

This guide walks you through deploying an application from the portal.

Prerequisites ​

  • A Shaep workspace
  • An application in the catalog (pushed via Docker or from the Store)

Step 1: Open the App Detail ​

  1. Navigate to Apps > Catalog
  2. Click the app you want to deploy
  3. Select a version from the versions list on the right

Step 2: Open the Deploy Dialog ​

Click the Deploy button. This opens a dialog with several configuration sections.

Step 3: Configure Basics ​

  • Name — A display name for this deployment
  • Slug — A URL-friendly identifier. Must match [a-z0-9][a-z0-9-]*[a-z0-9]. This becomes part of the deployment hostname.
  • Port — The port your container listens on (default: 8080, range: 1–65535). One port per deployment. The public URL always routes HTTP(S) to this port; sibling deployments in the same environment can also reach it directly on the same number (e.g. redis://my-redis:6379), for any protocol. Non-HTTP listeners are namespace-internal only — see Networking.
  • Replicas — Number of container instances (default: 1; the maximum depends on your tier and is shown under the field). Each replica reserves the full CPU and memory request, and all replicas count against your tier's pod limit. Persistent storage allows one replica: the /data volume can only be attached to one node at a time, so disable storage before running more than one.

Step 4: Choose Resources ​

Select a resource preset or define custom values:

PresetCPU RequestMemory RequestCPU LimitMemory Limit
Starter100m128Mi250m256Mi
Standard500m512Mi1000m1Gi
Performance1000m1Gi2000m2Gi
Heavy2000m4Gi4000m8Gi

Select Custom to set exact CPU and memory requests and limits.

WARNING

If total resources across all replicas exceed your available quota, or the replicas would exceed your tier's pod limit, the deployment cannot be created. The same check runs when you change the replica count later.

Step 5: Persistent Storage ​

Set a storage size (e.g., 1Gi, 10Gi, 100Gi). Storage is mounted at /data inside your container.

WARNING

Storage size is set at creation and cannot be changed later.

Step 6: Access Control ​

Choose an auth mode. Browser (SSO) is the default: only signed-in members of your organization can open the app until you choose otherwise.

ModeDescription
PublicAnyone can access the deployment
Browser (SSO)Users authenticate via SSO. A session cookie is set automatically.
Token (Bearer)API clients must provide a Bearer token. Returns 401 on failure.

When using Browser or Token mode, you can set a minimum role to restrict access:

  • Any authenticated user (default)
  • Viewer
  • User
  • Contributor
  • Admin
  • Owner

Step 7: Environment Variables ​

Add key-value pairs for environment variables your app needs. Click Add for each variable and fill in the key and value.

Step 8: Deploy ​

Click Deploy to create the deployment. Your app will appear in the Deployed tab.

Next Steps ​

Shaep Documentation