Skip to content

quickstart.mdx

Latest commit

 

History

History
94 lines (58 loc) · 3.51 KB

quickstart.mdx

File metadata and controls

94 lines (58 loc) · 3.51 KB
Raw
title Deploy your first app
description Deploy the quickstart example as an incremental app release.

Incremental app releases require the v0.13 CLI and matching server capability. v0.13 is currently available as a release candidate; see installation requirements.

Prerequisites

Create a Rigbox account, install the CLI, and install Git locally. Run every command below on your local machine.

1. Sign in

rig login
rig whoami
rig --version

Use the v0.13 CLI. Browser sign-in stores credentials for subsequent commands.

2. Get the example

git clone --branch codex/examples-docs-v013 https://github.com/rigbox-dev/rigbox-examples.git
cd rigbox-examples/quickstart

The example is a TypeScript HTTP service. Its rig.yaml declares port 8080, npm ci, npm start, and /healthz. Open that file and make the deployment choice and route explicit:

workspace:
  deployment:
    strategy: incremental
  resources: { ramMb: 1024, vcpuCount: 1, diskSizeMb: 3072 }

Keep the other application fields. Add visibility: public at the top level if you want anyone to open the example URL; otherwise the route stays private.

3. Deploy

From the example directory:

rig deploy --name my-first-app

Rigbox creates a workspace, prepares the app in a managed release directory, installs dependencies, activates it, and checks health. Subsequent deploys reuse the workspace recorded in .rig.lock. Keep that file locally; do not copy a production binding into an unrelated project.

4. Check the app

rig app ls --workspace my-first-app
rig app health --app <APP_NAME> --output json
rig app-release ls --workspace my-first-app

Replace <APP_NAME> with the name returned by the list command. Verify live and port_open are true, then open the actual URL returned by Rigbox. A private route may require authentication.

Deploy a change

Edit the example and run rig deploy again from the same directory. Activation briefly restarts the affected service; it does not replace the workspace filesystem. See the development loop and app rollback.

Troubleshooting

If install or health checking fails, find the release ID with rig app-release ls --workspace my-first-app and read rig app-release logs --workspace my-first-app --release <RELEASE_ID>. Confirm the process listens on port 8080 and /healthz returns success before retrying.

Cleanup

When you no longer need this test environment, inspect its apps and data first, then remove the workspace with rig workspace rm --workspace my-first-app. This removes the workspace; export data you want to retain before cleanup.

2. Create a workspace

For the earlier workspace-first quickstart, use Create and manage workspaces, then install a catalog app.

3. Install an app

Catalog recipes are documented in Catalog apps. Source deployment above uses an app release instead.

Optional: Configure AI Settings

Follow AI coding tools and Managed AI proxy.

Next Steps

Continue with multi-app projects, GitHub deployment, or the manifest reference.