falcon 0.52.1 → 0.52.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ff41d54e933c37257afda238572f60d9d73cbc7a8d4e9455b114fcee69a35d
-  data.tar.gz: 0db20e527e3dbe621863bcb222082a1a6798357e7a5b667a7e333cfc4f10b35f
+  metadata.gz: 0f0eb04a60a0e8100f830405fc1a55fa3cc1a31f8b8ad76922aba21c8bfc6796
+  data.tar.gz: 9491638bdf672c83ad490af7e192dabc903d5743061fa4fa95228f8fe195e772
 SHA512:
-  metadata.gz: 26ca76ce7cf101b8ec3f0767b7c4fafa8edd6aa826622b22b861ebfc57c64baa7dec02693188ed57ef6756fd9f3919d274908ba5c975f79801197c7f9f26652c
-  data.tar.gz: 9ab2fa4115477cfb45359c8765ae3ee9540372fe4198f2534792bec94784b3471e28a9047767b2f4ec6e8848606675779147acfe7360d6cf89997a3cd5eb6842
+  metadata.gz: d4068f413136896989dabcf1642040a2dfc118176968aa91b249cfecf055801823df0f40912b774008c99ac2e2a87b178e842d54368458c0d6595ad8dcc36f6c
+  data.tar.gz: 1078328b527bfd6ec35041dfbd9e542d0b0a2c0018850bdf447ad6160d190ee9ad876d64b222b4dec571b8f56f2550c26a171190e0c8f060fd4a959b236089d0

data/context/deployment.md

@@ -1,6 +1,6 @@
 # Deployment
 
-This guide explains how to use Falcon in production environments.
+This guide explains how to deploy applications using the Falcon web server. It covers the recommended deployment methods, configuration options, and examples for different environments, including systemd and kubernetes.
 
 Falcon can be deployed into production either as a standalone application server, or as a virtual host routing to multiple applications. Both configurations can run behind a load balancer, but `falcon virtual` is designed to be zero-configuration deployment option.
 
@@ -145,6 +145,50 @@ service hostname do
 require_relative "config/environment"
 ~~~
 
+### Kubernetes Integration
+
+Falcon can be deployed in a Kubernetes cluster using the `falcon host` command. You can use the following example to create a Kubernetes deployment for Falcon:
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: falcon
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: falcon
+  template:
+    metadata:
+      labels:
+        app: falcon
+    spec:
+      containers:
+        - name: my-app
+          image: my-app-image:latest
+          env:
+            - name: NOTIFY_LOG
+              value: "/tmp/notify.log"
+          ports:
+            - containerPort: 9292
+          readinessProbe:
+            exec:
+              command: ["bundle", "exec", "bake", "async:container:notify:log:ready?"]
+            initialDelaySeconds: 5
+            periodSeconds: 5
+            failureThreshold: 12
+
+          # Assuming you are running Rails and have bound to port 3000:
+          livenessProbe:
+            httpGet:
+              path: /up
+              port: 3000
+            initialDelaySeconds: 10
+            periodSeconds: 10
+            failureThreshold: 3
+```
+
 ## Falcon Virtual
 
 Falcon virtual provides a virtual host proxy and HTTP-to-HTTPS redirection for multiple applications. It is designed to be a zero-configuration deployment option, allowing you to run multiple applications on the same server.
@@ -164,3 +208,23 @@ falcon virtual /srv/http/*/falcon.rb
 By default, it binds to both HTTP and HTTPS ports, and automatically redirects HTTP requests to HTTPS. It also supports TLS SNI for resolving the certificates.
 
 See the [docker example](https://github.com/socketry/falcon-virtual-docker-example) for a complete working example.
+
+### systemd Service File
+
+You can create a systemd service file to manage the Falcon virtual service. Here is an example of a systemd service file for Falcon:
+
+```ini
+[Unit]
+Description=Falcon Virtual Service
+After=network.target
+
+[Service]
+Type=notify
+User=http
+WorkingDirectory=/srv/http
+ExecStart=/usr/local/bin/falcon virtual /srv/http/*/falcon.rb
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```

data/context/index.yaml

@@ -1,34 +1,34 @@
 # Automatically generated context index for Utopia::Project guides.
 # Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
 ---
-getting-started:
+description: A fast, asynchronous, rack-compatible web server.
+metadata:
+  documentation_uri: https://socketry.github.io/falcon/
+  source_code_uri: https://github.com/socketry/falcon.git
+files:
+- path: getting-started.md
   title: Getting Started
-  order: 1
   description: This guide gives an overview of how to use Falcon for running Ruby
     web applications.
-rails-integration:
+- path: rails-integration.md
   title: Rails Integration
-  order: 2
   description: This guide explains how to host Rails applications with Falcon.
-deployment:
+- path: deployment.md
   title: Deployment
-  order: 3
-  description: This guide explains how to use Falcon in production environments.
-performance-tuning:
+  description: This guide explains how to deploy applications using the Falcon web
+    server. It covers the recommended deployment methods, configuration options, and
+    examples for different environments, including systemd and kubernetes.
+- path: performance-tuning.md
   title: Performance Tuning
-  order: 4
   description: This guide explains the performance characteristics of Falcon.
-websockets:
+- path: websockets.md
   title: WebSockets
-  order: 5
   description: This guide explains how to use WebSockets with Falcon.
-interim-responses:
+- path: interim-responses.md
   title: Interim Responses
-  order: 6
   description: This guide explains how to use interim responses in Falcon to send
     early hints to the client.
-how-it-works:
+- path: how-it-works.md
   title: How It Works
-  order: 10
   description: This guide gives an overview of how Falcon handles an incoming web
     request.

data/lib/falcon/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2017-2025, by Samuel Williams.
 
 module Falcon
-	VERSION = "0.52.1"
+	VERSION = "0.52.3"
 end

data/readme.md

@@ -33,7 +33,7 @@ Please see the [project documentation](https://socketry.github.io/falcon/) for m
 
   - [Rails Integration](https://socketry.github.io/falcon/guides/rails-integration/index) - This guide explains how to host Rails applications with Falcon.
 
-  - [Deployment](https://socketry.github.io/falcon/guides/deployment/index) - This guide explains how to use Falcon in production environments.
+  - [Deployment](https://socketry.github.io/falcon/guides/deployment/index) - This guide explains how to deploy applications using the Falcon web server. It covers the recommended deployment methods, configuration options, and examples for different environments, including systemd and kubernetes.
 
   - [Performance Tuning](https://socketry.github.io/falcon/guides/performance-tuning/index) - This guide explains the performance characteristics of Falcon.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: falcon
 version: !ruby/object:Gem::Version
-  version: 0.52.1
+  version: 0.52.3
 platform: ruby
 authors:
 - Samuel Williams