# Ferron

> Ferron is a fast, modern, and easily configurable web server with automatic TLS.

## Ferron 2 documentation

- [Welcome to the documentation!](https://ferron.sh/docs/index.md)
- [Playground](https://ferron.sh/docs/playground.md)
- [Getting started](https://ferron.sh/docs/getting-started.md)
- [Troubleshooting](https://ferron.sh/docs/troubleshooting.md)

## Ferron 2 documentation: Installation

- [Docker](https://ferron.sh/docs/installation/docker.md)
- [Package managers (community)](https://ferron.sh/docs/installation/package-managers.md)
- [Manual installation](https://ferron.sh/docs/installation/manual.md)

## Ferron 2 documentation: Common use cases

- [Logging & observability](https://ferron.sh/docs/use-cases/logging-observability.md)
- [`ferron serve` subcommand](https://ferron.sh/docs/use-cases/ferron-serve.md)

## Ferron 2 documentation: Configuration

- [Fundamentals](https://ferron.sh/docs/configuration/fundamentals.md)
- [Placeholders](https://ferron.sh/docs/configuration/placeholders.md)
- [Conditionals](https://ferron.sh/docs/configuration/conditionals.md)
- [Examples](https://ferron.sh/docs/configuration/examples.md)

## Ferron 2 documentation: Reference

- [Server configuration (legacy)](https://ferron.sh/docs/reference/configuration-legacy.md)
- [Server modules](https://ferron.sh/docs/reference/modules.md)
- [Observability backends](https://ferron.sh/docs/reference/observability.md)
- [Commands](https://ferron.sh/docs/reference/commands.md)
- [FerrBench](https://ferron.sh/docs/reference/ferrbench.md)
- [Rust crate documentation](https://ferron.shhttps://rustdocs-v2.ferron.sh.md)

## Ferron 2 documentation: GNU/Linux

- [Debian/Ubuntu](https://ferron.sh/docs/installation/debian.md)
- [RHEL/Fedora](https://ferron.sh/docs/installation/rpm.md)
- [Installer](https://ferron.sh/docs/installation/installer-linux.md)

## Ferron 2 documentation: Windows Server

- [Installer](https://ferron.sh/docs/installation/installer-windows.md)

## Ferron 2 documentation: Static & content

- [Static file serving](https://ferron.sh/docs/use-cases/static-file-serving.md)
- [PHP hosting](https://ferron.sh/docs/use-cases/php.md)
- [CGI applications](https://ferron.sh/docs/use-cases/cgi-applications.md)
- [Web applications](https://ferron.sh/docs/use-cases/web-applications.md)

## Ferron 2 documentation: Traffic & routing

- [Reverse proxying](https://ferron.sh/docs/use-cases/reverse-proxy.md)
- [Forward auth](https://ferron.sh/docs/use-cases/forward-auth.md)
- [Client IP](https://ferron.sh/docs/use-cases/client-ip.md)
- [Rate limiting](https://ferron.sh/docs/use-cases/rate-limiting.md)
- [Error pages](https://ferron.sh/docs/use-cases/error-pages.md)
- [URL rewriting](https://ferron.sh/docs/use-cases/url-rewriting.md)
- [Redirecting](https://ferron.sh/docs/use-cases/redirecting.md)

## Ferron 2 documentation: Security

- [Automatic TLS](https://ferron.sh/docs/use-cases/automatic-tls.md)
- [Manual TLS](https://ferron.sh/docs/use-cases/manual-tls.md)
- [mTLS](https://ferron.sh/docs/use-cases/mtls.md)
- [Access control](https://ferron.sh/docs/use-cases/access-control.md)
- [Security headers](https://ferron.sh/docs/use-cases/security-headers.md)
- [CORS headers](https://ferron.sh/docs/use-cases/cors.md)

## Ferron 2 documentation: Directives

- [Core directives](https://ferron.sh/docs/configuration/core-directives.md)
- [Security & TLS](https://ferron.sh/docs/configuration/security-tls.md)
- [Reverse proxying](https://ferron.sh/docs/configuration/reverse-proxying.md)
- [Static & content handling](https://ferron.sh/docs/configuration/static-content.md)
- [Routing & URL processing](https://ferron.sh/docs/configuration/routing-url-processing.md)
- [Application backends](https://ferron.sh/docs/configuration/application-backends.md)
- [Traffic control](https://ferron.sh/docs/configuration/traffic-control.md)
- [Observability & logging](https://ferron.sh/docs/configuration/observability-logging.md)

## Ferron 1.x (EOL) documentation

- [Welcome to the documentation!](https://ferron.sh/docs/v1.md)
- [System requirements](https://ferron.sh/docs/v1/requirements.md)
- [Server configuration properties](https://ferron.sh/docs/v1/configuration.md)
- [Environment overrides](https://ferron.sh/docs/v1/environment-overrides.md)
- [Server modules](https://ferron.sh/docs/v1/modules.md)
- [PHP support](https://ferron.sh/docs/v1/php.md)
- [Reverse proxy functionality](https://ferron.sh/docs/v1/reverse-proxy.md)
- [Automatic TLS](https://ferron.sh/docs/v1/automatic-tls.md)
- [FerrBench](https://ferron.sh/docs/v1/ferrbench.md)
- [Compatibility with web applications](https://ferron.sh/docs/v1/web-application-compatibility.md)
- [Installation](https://ferron.sh/docs/v1/installation.md)

## Ferron 3 (beta) documentation

- [Documentation home](https://ferron.sh/docs/v3.md)
- [Getting started](https://ferron.sh/docs/v3/getting-started.md)
- [Troubleshooting](https://ferron.sh/docs/v3/troubleshooting.md)

## Ferron 3 (beta) documentation: Installation

- [Windows](https://ferron.sh/docs/v3/installation/windows.md)
- [Docker](https://ferron.sh/docs/v3/installation/docker.md)
- [Manual installation (archive)](https://ferron.sh/docs/v3/installation/manual-installation.md)

## Ferron 3 (beta) documentation: Migration

- [From Ferron 2](https://ferron.sh/docs/v3/migration/from-v2.md)

## Ferron 3 (beta) documentation: Common use cases


## Ferron 3 (beta) documentation: Configuration


## Ferron 3 (beta) documentation: Linux

- [Installer](https://ferron.sh/docs/v3/installation/linux/installer.md)
- [Debian/Ubuntu](https://ferron.sh/docs/v3/installation/linux/debian-ubuntu.md)
- [RHEL/Fedora](https://ferron.sh/docs/v3/installation/linux/rhel-fedora.md)

## Ferron 3 (beta) documentation: Building from source

- [Default modules](https://ferron.sh/docs/v3/installation/source/default-modules.md)
- [Custom modules](https://ferron.sh/docs/v3/installation/source/custom-modules.md)

## Ferron 3 (beta) documentation: Static & content

- [Static file serving](https://ferron.sh/docs/v3/use-cases/content/static-files.md)
- [HTTP caching](https://ferron.sh/docs/v3/use-cases/content/caching.md)
- [Edge caching (CDN)](https://ferron.sh/docs/v3/use-cases/content/edge-caching.md)
- [CGI applications](https://ferron.sh/docs/v3/use-cases/content/cgi.md)
- [PHP hosting](https://ferron.sh/docs/v3/use-cases/content/php.md)
- [PHP edge caching (LSCache)](https://ferron.sh/docs/v3/use-cases/content/php-edge-cache.md)

## Ferron 3 (beta) documentation: Traffic & routing

- [Reverse proxying](https://ferron.sh/docs/v3/use-cases/traffic/reverse-proxy.md)
- [URL rewriting](https://ferron.sh/docs/v3/use-cases/traffic/url-rewriting.md)
- [Error pages](https://ferron.sh/docs/v3/use-cases/traffic/error-pages.md)

## Ferron 3 (beta) documentation: Security

- [Automatic TLS](https://ferron.sh/docs/v3/use-cases/security/automatic-tls.md)
- [Rate limiting](https://ferron.sh/docs/v3/use-cases/security/rate-limiting.md)
- [Abuse protection](https://ferron.sh/docs/v3/use-cases/security/abuse-protection.md)
- [Security headers](https://ferron.sh/docs/v3/use-cases/security/security-headers.md)
- [Manual TLS](https://ferron.sh/docs/v3/use-cases/security/manual-tls.md)
- [mTLS (mutual TLS)](https://ferron.sh/docs/v3/use-cases/security/mtls.md)
- [Access control](https://ferron.sh/docs/v3/use-cases/security/access-control.md)
- [Fail2ban integration](https://ferron.sh/docs/v3/use-cases/security/fail2ban.md)

## Ferron 3 (beta) documentation: Operations

- [Admin API](https://ferron.sh/docs/v3/use-cases/operations/admin-api.md)
- [Logging & observability](https://ferron.sh/docs/v3/use-cases/operations/logging-observability.md)
- ['ferron-serve' command](https://ferron.sh/docs/v3/use-cases/operations/ferron-serve.md)

## Ferron 3 (beta) documentation: Fundamentals

- [Syntax and file structure](https://ferron.sh/docs/v3/configuration/fundamentals/syntax.md)
- [JSON configuration](https://ferron.sh/docs/v3/configuration/fundamentals/json-config.md)
- [Configuration validation](https://ferron.sh/docs/v3/configuration/fundamentals/validation.md)
- [Configuration doctor](https://ferron.sh/docs/v3/configuration/fundamentals/doctor.md)
- [Configuration formatting](https://ferron.sh/docs/v3/configuration/fundamentals/formatting.md)
- [Conditionals and variables](https://ferron.sh/docs/v3/configuration/fundamentals/conditionals.md)

## Ferron 3 (beta) documentation: Server

- [Core directives](https://ferron.sh/docs/v3/configuration/server/core-directives.md)
- [HTTP host directives](https://ferron.sh/docs/v3/configuration/server/host.md)

## Ferron 3 (beta) documentation: Routing & control

- [Routing and URL processing](https://ferron.sh/docs/v3/configuration/routing/url-processing.md)
- [HTTP response control and early hints](https://ferron.sh/docs/v3/configuration/routing/response.md)
- [URL rewriting](https://ferron.sh/docs/v3/configuration/routing/rewrite.md)
- [HTTP map](https://ferron.sh/docs/v3/configuration/routing/map.md)
- [Variable setting](https://ferron.sh/docs/v3/configuration/routing/variables.md)

## Ferron 3 (beta) documentation: Proxying

- [Reverse proxy](https://ferron.sh/docs/v3/configuration/proxy/reverse-proxy.md)
- [Forward proxy](https://ferron.sh/docs/v3/configuration/proxy/forward-proxy.md)

## Ferron 3 (beta) documentation: Security

- [HTTP basic authentication](https://ferron.sh/docs/v3/configuration/security/basic-auth.md)
- [Forwarded authentication](https://ferron.sh/docs/v3/configuration/security/forwarded-auth.md)
- [Security and TLS](https://ferron.sh/docs/v3/configuration/security/tls.md)
- [ACME automatic TLS](https://ferron.sh/docs/v3/configuration/security/acme.md)
- [DNS providers](https://ferron.sh/docs/v3/configuration/security/dns-providers.md)
- [Local development TLS](https://ferron.sh/docs/v3/configuration/security/local-tls.md)
- [HTTP TLS provider](https://ferron.sh/docs/v3/configuration/security/tls-http.md)
- [TLS session ticket keys](https://ferron.sh/docs/v3/configuration/security/session-tickets.md)
- [OCSP stapling](https://ferron.sh/docs/v3/configuration/security/ocsp.md)

## Ferron 3 (beta) documentation: Content & traffic

- [Static file serving](https://ferron.sh/docs/v3/configuration/content/static-files.md)
- [HTTP compression](https://ferron.sh/docs/v3/configuration/content/compression.md)
- [HTTP cache](https://ferron.sh/docs/v3/configuration/content/cache.md)
- [CGI support](https://ferron.sh/docs/v3/configuration/content/cgi.md)
- [FastCGI support](https://ferron.sh/docs/v3/configuration/content/fastcgi.md)
- [SCGI support](https://ferron.sh/docs/v3/configuration/content/scgi.md)
- [HTTP buffering](https://ferron.sh/docs/v3/configuration/content/buffering.md)
- [HTTP response body replacement](https://ferron.sh/docs/v3/configuration/content/response-replace.md)
- [HTTP headers and CORS](https://ferron.sh/docs/v3/configuration/content/headers.md)
- [Rate limiting](https://ferron.sh/docs/v3/configuration/content/rate-limit.md)
- [Abuse protection](https://ferron.sh/docs/v3/configuration/content/abuse-ban.md)
- [JSON error responses](https://ferron.sh/docs/v3/configuration/content/json-error.md)

## Ferron 3 (beta) documentation: Observability

- [Logging](https://ferron.sh/docs/v3/configuration/observability/logging.md)
- [Metrics](https://ferron.sh/docs/v3/configuration/observability/metrics.md)
- [Tracing](https://ferron.sh/docs/v3/configuration/observability/tracing.md)
- [OTLP observability](https://ferron.sh/docs/v3/configuration/observability/otlp.md)
- [Prometheus metrics](https://ferron.sh/docs/v3/configuration/observability/prometheus.md)
- [Grafana reference dashboard](https://ferron.sh/docs/v3/configuration/observability/grafana-dashboard.md)
- [Cross-plane traceability](https://ferron.sh/docs/v3/configuration/observability/control-plane.md)