Skip to content

Docs

Getting started

Create a workspace, install the CLI, and ship the first thing — a site, a bucket, an image or a server. Each path takes a few minutes.

1 · Create a workspace

Sign up at app.subnomic.com. The free plan needs no card and does not expire. Everything you create — sites, buckets, repositories, workflows — belongs to the workspace, and so do its bill and its activity log.

2 · Install the CLI

curl -fsSL https://get.subnomic.com | bash
subnomic login
subnomic whoami

login asks for your email or username and password, and for a two-factor code if your account has one. See CLI for every command.

3 · Ship something

Pick whichever you came for. Each works on the free plan unless it says otherwise.

Deploy a site

From the directory your project lives in, after building it:

subnomic sites create blog --dir dist
subnomic sites deploy --prod

The second command prints the live URL. Without --prod it prints a preview address for that build instead. More in Sites.

Store objects

Open Infrastructure → Object storage, create a bucket, then create a key under Access keys — the secret is shown once. Use the endpoint shown in the console with any S3 client:

export AWS_ACCESS_KEY_ID=<access key id>
export AWS_SECRET_ACCESS_KEY=<secret>
aws --endpoint-url https://s3.subnomic.com s3 ls

More in Object storage.

Push an image

docker login registry.subnomic.com -u <your username>
docker tag my-app:latest registry.subnomic.com/<workspace>/my-app:latest
docker push registry.subnomic.com/<workspace>/my-app:latest

The repository is created by the first push. For CI, create a robot account instead of using your own login — see Container registry.

Ask Runa

Open Runa and ask about the workspace’s activity — who changed what, and when. To let it read databases, clusters or hosts, give it an agent access; those start on Pro. See Runa.

Automate something Pro and up

Open Workflows → New workflow and start from a template. Nothing runs until you save and enable it. See Workflows.

Connect a server Pro and up

Open Servers → New server, then run the install command from its Agents tab on the host. The agent opens one outbound connection; nothing inbound is needed.

curl -fsSL https://cdn.subnomic.com/subnomic/install.sh | sudo TOKEN=<token> bash

See Servers & terminal and Agents.

4 · Deploy from CI

A pipeline has no browser to sign in with. Create a workspace API key with only the sites.deploy scope — it can publish and roll back, and cannot delete the site — and give it to the runner:

- run: curl -fsSL https://get.subnomic.com | bash
- run: subnomic sites deploy --prod
  env:
    SUBNOMIC_TOKEN: ${{ secrets.SUBNOMIC_TOKEN }}
    SUBNOMIC_API: https://api.subnomic.com

Only the URL is printed on stdout, so URL=$(subnomic sites deploy --prod) captures it.

Everything is permission-gated. If you cannot see a feature in the console, your role does not include it — ask a workspace admin.