Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ Guidance for agentic coding agents working in this repository.
> `CLAUDE.md` is a symlink to this file. Both Claude Code and other agentic
> harnesses read the same content — edit `AGENTS.md` only.

> **Using this proxy in another project?** A dedicated `spark-http-proxy` agent
> skill covers exposing containers, certificates, DNS, and troubleshooting:
> [sparkfabrik/sf-agents-harness → skills/system/spark-http-proxy](https://github.com/sparkfabrik/sf-agents-harness/tree/main/skills/system/spark-http-proxy).
> This `AGENTS.md` is for working **on** the proxy's own source; the skill is for
> **using** the proxy from a consumer project.

## Repository Overview

Spark HTTP Proxy is a local development reverse proxy built on Traefik. It consists of:
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@

Simply add `VIRTUAL_HOST=myapp.local` to any container or use native Traefik labels, and your applications become accessible with both HTTP and HTTPS automatically. No port management, no `/etc/hosts` editing, no hunting for the right port number. **Only explicitly configured containers are exposed**, keeping your development environment secure by default.

> **Using an AI coding agent?** There is a `spark-http-proxy` agent skill that
> teaches agents to expose containers, generate certificates, configure DNS, and
> troubleshoot routing with this proxy:
> [sparkfabrik/sf-agents-harness → skills/system/spark-http-proxy](https://github.com/sparkfabrik/sf-agents-harness/tree/main/skills/system/spark-http-proxy).

## Table of Contents

- [Features](#features)
Expand Down Expand Up @@ -415,7 +420,7 @@ Traefik automatically generates self-signed certificates for HTTPS routes. For t
**HTTP Strict Transport Security (HSTS) headers are automatically disabled** for all HTTPS traffic at the entrypoint level to prevent browser caching issues during development. This ensures that:

- Browsers won't remember HTTPS requirements if certificates are changed or revoked
- Switching between different development setups remains seamless
- Switching between different development setups remains seamless
- Certificate issues don't persist in browser cache and block access

This is implemented using Traefik's `disable-hsts` middleware applied to the HTTPS entrypoint, ensuring **all HTTPS traffic** (both dinghy-layer and native Traefik routes) benefits from this development-friendly configuration. This is essential for development environments where certificates may frequently change, expire, or be regenerated.
Expand All @@ -436,6 +441,7 @@ spark-http-proxy generate-mkcert "*.project.loc"
```

The `generate-mkcert` command automatically:

- **Installs mkcert** if not already available (using Homebrew on macOS)
- **Creates the certificate directory** (`~/.local/spark/http-proxy/certs`)
- **Generates certificates** with safe filenames for wildcard domains
Expand Down
Loading