clean project structure

README.md

@@ -42,7 +42,7 @@ Steep reads its configuration from environment variables (a `.env` file is suppo
 | `METRICS_BIND_ADDR` | *(optional)* Bind address for the Prometheus metrics endpoint (e.g. `0.0.0.0:9100`). If unset, the metrics exporter is disabled. |
 | `SENTRY_DSN` | *(optional)* Sentry DSN for error tracking |
 | `RUST_LOG` | *(optional)* Log level, defaults to `info` |
-| `SANDBOX_MAX_ITERATIONS` | *(optional)* Maximum number of tool-calling iterations per sandboxed review. Defaults to `8` |
+| `SANDBOX_MAX_ITERATIONS` | *(optional)* Maximum number of tool-calling iterations per sandboxed review. Defaults to `8`; a value that is set but is not a number stops the startup |
 | `DOCKER_HOST` | *(optional)* Container daemon socket Steep drives, e.g. `unix:///run/user/1000/podman/podman.sock` for a rootless podman. Defaults to `unix:///var/run/docker.sock` |
 
 ## Sandboxed reviews
@@ -139,6 +139,24 @@ cargo run -p steep-server
 
 Copy `.env.example` to `.env` and fill in your values before running.
 
+## Job queue
+
+Steep is meant to run as a **single instance**. Webhooks are stored in the `jobs` table
+of PostgreSQL, and the worker is woken up as soon as a job is pushed (no polling).
+A job still `processing` at startup was interrupted by the previous process: it is put
+back in the queue and reviewed again. Do not run two instances on the same database,
+they would both take over each other's running jobs.
+
+## Dependencies
+
+TLS is handled by [rustls](https://github.com/rustls/rustls) (with `ring`), so neither
+the build nor the image needs OpenSSL. The `Containerfile` runtime image only
+installs `ca-certificates` and `git`.
+
+`cargo deny check` audits the dependencies (security advisories, licenses, banned
+crates, sources) with the policy of `deny.toml`. It runs in the CI, and it also fails
+if `openssl-sys` or `native-tls` comes back into the dependency tree.
+
 ## Metrics
 
 Steep optionally exposes a Prometheus metrics endpoint, useful for scraping with an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) or any Prometheus-compatible scraper.