On this page
Quickstart
Deploy a public container image as a web service and open it at its HTTPS address. It takes about two minutes. The same steps over the REST API are at the end of this page. To deploy from a Git repository instead of an image, see Deploy from Git.
1. Create an account#
Sign up at /signup: Neuramorphic sign-in asks for your email, confirms it with a code, and has you choose a password of at least 12 characters and set up an authenticator app.
2. Create a web service#
In the dashboard click New, then Web Service.
Fill in the form:
Field Value Name hello-webContainer image public.ecr.aws/nginx/nginx:stable-alpinePort 80Instance type Starter Click Create and deploy.
The new-service page has an example button, "A web page (nginx)", that fills the form for you. If you would rather run a ready-made app (a chat interface, a vector database, a workflow tool), deploy a template.
3. Open it#
The service goes from Queued to Deploying to Live. When it is Live, click Open. Its address looks like https://my-api-x7k2.apps.kilby.neuramorphic.ai: the name you chose, four random characters, and Kilby's apps domain. The address is HTTPS from the first request.
If the deploy fails, the service page says why in one sentence. See Troubleshooting.
4. Change it#
- Add a variable in the Environment tab and click Save and deploy: Kilby starts a new deploy with it.
- Read what the service prints in the Logs tab.
- Roll back to the previous deploy from the More actions menu of the service.
- Point your own domain at it in the Domains tab: Custom domains.
The same with the API#
Create an API key with the Developer role under API keys (a workspace admin can do this), then export it:
export KILBY_API_KEY="<your key>"Create the service:
curl -sS -X POST https://onkilby.com/api/v1/services \
-H "Authorization: Bearer $KILBY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "hello-web", "type": "web", "image": "public.ecr.aws/nginx/nginx:stable-alpine", "port": 80, "plan": "starter"}'The answer is the service, with its id, its url and a status. Poll it until status is live, or failed:
curl -sS -H "Authorization: Bearer $KILBY_API_KEY" https://onkilby.com/api/v1/services/<id>Related#
- Services: every kind of service, ports, health checks and instance types.
- Templates: ready-made apps you deploy from the dashboard, the CLI or the API.
- Environment variables and secrets: configure what you just deployed.
- Deploys, rollbacks and downtime: what happens when you deploy again.
- Use Kilby from an AI agent: let an agent do these steps.