Getting Started

Getting Started

This page gives the shortest path from download to a working Jul.IA instance. For exact platform packages and current prerequisites, use the README and release guide.

1. Choose a binary

Use a release archive for your operating system and architecture, or build from source. Jul.IA commonly ships in two profiles:

• Lean - the core gateway with a smaller optional-feature surface.
• Full - the practical default when you want the optional integrations compiled in.

The exact contents of each profile can evolve. Check the build-tag reference before automating around a specific capability.

2. Try zero-config mode

Serve a directory:

jul run --serve ./public --listen :8080

Proxy to a local application:

jul run --proxy 127.0.0.1:3000 --listen :8080

Zero-config mode is ideal for evaluation and local development. It does not create or modify a TOML file.

3. Create a minimal configuration

[global]
log_level = "info"

[[servers]]
listen = "0.0.0.0:8080"
server_names = ["localhost"]

  [[servers.locations]]
  match = { type = "prefix", path = "/" }
  root = "./public"
  index = ["index.html"]

Start it:

jul serve -config server.toml

4. Validate before serving

jul check -config server.toml
jul lint -config server.toml

• check performs structural validation plus runtime preflight.
• lint adds best-practice findings suitable for local use and CI.

5. Add capabilities incrementally

A useful progression is:

1. Static files or one reverse-proxy route.
2. Named upstreams and health checks.
3. TLS and authentication.
4. Admin health endpoints and observability.
5. Optional features required by the deployment.

Copy examples from the getting-started guide, configuration reference, and examples directory. Avoid copying a large sample configuration and enabling everything at once.

Next step

Read Configuration Workflow before making production changes, then use Operations and Deployment for service installation and persistent state.