Skip to content

getting-started.md

Latest commit

 

History

History
98 lines (65 loc) · 1.6 KB

getting-started.md

File metadata and controls

98 lines (65 loc) · 1.6 KB

Getting Started

This guide gets you from zero to first secure execution in under five minutes.

Prerequisites

  • Docker installed and running
  • Ignite installed (single binary)

Install Docker: https://docs.docker.com/get-docker/

Install Ignite

curl -fsSL https://raw.githubusercontent.com/dev-dami/ignite/master/install.sh | bash
ignite --version

Create a Service

ignite init hello-world
cd hello-world

Generated files:

hello-world/
├── service.yaml
├── package.json
└── index.ts

ignite init refuses to overwrite existing generated files.

Execute

ignite run .

Pass Input

ignite run . --input '{"name":"Developer"}'

Input is available via process.env.IGNITE_INPUT.

Run in Hardened Audit Mode

ignite run . --audit

Audit mode applies restrictive sandbox flags and prints a security audit summary.

Preflight Checks

ignite preflight .

Preflight validates memory, dependencies, timeout, and (when image exists) image size.

Serve Over HTTP

ignite serve --services . --port 3000

Then call:

curl -X POST http://localhost:3000/services/hello-world/execute \
  -H 'Content-Type: application/json' \
  -d '{"input":{"name":"Developer"}}'

Troubleshooting

Docker daemon not reachable

Start Docker Desktop or the Docker service and retry.

Docker permission denied (Linux)

sudo usermod -aG docker $USER
# sign out and sign in again

Next Steps