Skip to content

Commit

Permalink
Improved documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioquatix committed Mar 23, 2024
1 parent 1567816 commit 09000ba
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions lib/falcon/environment/application.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

module Falcon
module Environment
# Provides an environment for hosting a web application that uses TLS.
module Application
include Server

Expand Down
2 changes: 1 addition & 1 deletion lib/falcon/environment/lets_encrypt_tls.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

module Falcon
module Environment
# A Lets Encrypt SSL context environment.
# Provides an environment that uses "Lets Encrypt" for TLS.
module LetsEncryptTLS
# The Lets Encrypt certificate store path.
# @parameter [String]
Expand Down
3 changes: 3 additions & 0 deletions lib/falcon/environment/proxy.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

module Falcon
module Environment
# Provides an environment for hosting a TLS-capable reverse proxy using SNI.
module Proxy
include Server

Expand All @@ -29,6 +30,8 @@ def environments
[]
end

# The hosts we will proxy to. This is a hash of SNI authority -> evaluator.
# @returns [Hash(String, Async::Service::Environment::Evaluator)]
def hosts
hosts = {}

Expand Down
1 change: 1 addition & 0 deletions lib/falcon/environment/rack.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

module Falcon
module Environment
# Provides an environment for hosting a web application that use a Rackup `config.ru` file.
module Rack
include Application
include Rackup
Expand Down
1 change: 1 addition & 0 deletions lib/falcon/environment/rackup.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

module Falcon
module Environment
# Provides an environment for hosting loading a Rackup `config.ru` file.
module Rackup
def rackup_path
'config.ru'
Expand Down
2 changes: 1 addition & 1 deletion lib/falcon/environment/redirect.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

module Falcon
module Environment
# A controller for redirecting requests.
# Provides an environment for redirecting insecure web traffic to a secure endpoint.
module Redirect
include Server

Expand Down
2 changes: 1 addition & 1 deletion lib/falcon/environment/self_signed_tls.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

module Falcon
module Environment
# A general SSL context environment.
# Provides an environment that exposes a self-signed TLS certificate using the `localhost` gem.
module SelfSignedTLS
# The default session identifier for the session cache.
# @returns [String]
Expand Down
1 change: 1 addition & 0 deletions lib/falcon/environment/server.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

module Falcon
module Environment
# Provides an environment for hosting a web application that uses a Falcon server.
module Server
# The service class to use for the proxy.
# @returns [Class]
Expand Down
2 changes: 1 addition & 1 deletion lib/falcon/environment/supervisor.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

module Falcon
module Environment
# A application process monitor environment.
# Provides an environment for hosting a supervisor which can monitor multiple applications.
module Supervisor
# The name of the supervisor
# @returns [String]
Expand Down
2 changes: 1 addition & 1 deletion lib/falcon/environment/tls.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

module Falcon
module Environment
# A general SSL context environment.
# Provides an environment that exposes a TLS context for hosting a secure web application.
module TLS
# The default session identifier for the session cache.
# @returns [String]
Expand Down

0 comments on commit 09000ba

Please sign in to comment.