diff options
| -rw-r--r-- | .olddoc.yml | 22 | ||||
| -rw-r--r-- | Documentation/.gitignore | 4 | ||||
| -rw-r--r-- | Documentation/GNUmakefile | 33 | ||||
| -rw-r--r-- | Documentation/comparison.haml | 2 | ||||
| -rw-r--r-- | Documentation/rainbows.1.txt | 161 | ||||
| -rw-r--r-- | FAQ | 2 | ||||
| -rwxr-xr-x | GIT-VERSION-GEN | 2 | ||||
| -rw-r--r-- | GNUmakefile | 27 | ||||
| -rw-r--r-- | HACKING | 4 | ||||
| -rw-r--r-- | README | 18 | ||||
| -rw-r--r-- | Sandbox | 2 | ||||
| -rw-r--r-- | TUNING | 4 | ||||
| -rw-r--r-- | archive/rfmig.rb | 32 | ||||
| -rw-r--r-- | archive/slrnpull.conf | 2 | ||||
| -rw-r--r-- | examples/reverse_proxy.ru | 2 | ||||
| -rw-r--r-- | lib/rainbows.rb | 2 | ||||
| -rw-r--r-- | lib/rainbows/configurator.rb | 4 | ||||
| -rw-r--r-- | lib/rainbows/epoll.rb | 2 | ||||
| -rw-r--r-- | lib/rainbows/reverse_proxy.rb | 2 | ||||
| -rw-r--r-- | man/man1/rainbows.1 | 193 | ||||
| -rw-r--r-- | pkg.mk | 2 | ||||
| -rw-r--r-- | rainbows.gemspec | 16 | ||||
| -rw-r--r-- | vs_Unicorn | 2 |
23 files changed, 255 insertions, 285 deletions
diff --git a/.olddoc.yml b/.olddoc.yml index 3e776ef..2e0f170 100644 --- a/.olddoc.yml +++ b/.olddoc.yml @@ -1,12 +1,10 @@ --- -cgit_url: https://bogomips.org/rainbows.git -git_url: https://bogomips.org/rainbows.git -rdoc_url: https://bogomips.org/rainbows/ +cgit_url: https://yhbt.net/rainbows.git/ +rdoc_url: https://yhbt.net/rainbows/ merge_html: - rainbows_1: Documentation/rainbows.1.html + rainbows_1: man/man1/rainbows.1.html Summary: Documentation/comparison.html -public_email: rainbows-public@bogomips.org -private_email: rainbows@bogomips.org +public_email: rainbows-public@yhbt.net noindex: - TODO - LATEST @@ -15,7 +13,13 @@ noindex: - Unicorn::SocketHelper - EM - Revactor -ml_url: https://bogomips.org/rainbows-public/ +ml_url: +- https://yhbt.net/rainbows-public/ +- http://ou63pmih66umazou.onion/rainbows-public/ +source_code: +- git clone https://yhbt.net/rainbows.git +- torsocks git clone http://ou63pmih66umazou.onion/rainbows.git nntp_url: - - nntp://news.public-inbox.org/inbox.comp.lang.ruby.rainbows - - nntp://news.gmane.org/gmane.comp.lang.ruby.rainbows.general +- nntp://news.public-inbox.org/inbox.comp.lang.ruby.rainbows +- nntp://ou63pmih66umazou.onion/inbox.comp.lang.ruby.rainbows +- nntp://news.gmane.io/gmane.comp.lang.ruby.rainbows.general diff --git a/Documentation/.gitignore b/Documentation/.gitignore index 46679d6..0a3b033 100644 --- a/Documentation/.gitignore +++ b/Documentation/.gitignore @@ -1,5 +1,3 @@ -*.1 -*.5 -*.7 *.gz *.html +*.txt diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile deleted file mode 100644 index df5c706..0000000 --- a/Documentation/GNUmakefile +++ /dev/null @@ -1,33 +0,0 @@ -all:: - -PANDOC = pandoc -PANDOC_OPTS = -f markdown --email-obfuscation=none -pandoc = $(PANDOC) $(PANDOC_OPTS) -pandoc_html = $(pandoc) --toc -t html --no-wrap - -man1 := $(addsuffix .1,rainbows) -html1 := $(addsuffix .html,$(man1)) - -all:: html man - -html: $(html1) -man: $(man1) - -install-html: html - mkdir -p ../doc/man1 - install -m 644 $(html1) ../doc/man1 - -install-man: man - mkdir -p ../man/man1 - install -m 644 $(man1) ../man/man1 - -%.1: %.1.txt - $(pandoc) -s -t man < $< > $@+ && mv $@+ $@ -%.1.html: %.1.txt - $(pandoc_html) < $< > $@+ && mv $@+ $@ - -comparison.html: comparison.haml - haml -t ugly < $< > $@+ && mv $@+ $@ - -clean:: - $(RM) $(man1) $(html1) comparison.html diff --git a/Documentation/comparison.haml b/Documentation/comparison.haml index 4fd02eb..8586a0b 100644 --- a/Documentation/comparison.haml +++ b/Documentation/comparison.haml @@ -153,7 +153,7 @@ CoolioThread* and CoolioThread* requires Ruby 1.9 reasonable performance %li rack.input streaming is what makes - %a(href="http://upr.bogomips.org/") upload progress, + %a(href="http://yhbt.net/upr/") upload progress, and BOSH possible %li rack.input streaming is NOT compatible with current versions of nginx diff --git a/Documentation/rainbows.1.txt b/Documentation/rainbows.1.txt deleted file mode 100644 index cdf7863..0000000 --- a/Documentation/rainbows.1.txt +++ /dev/null @@ -1,161 +0,0 @@ -% rainbows(1) Rainbows! User Manual -% Rainbows! Hackers <rainbows-public@bogomips.org> -% December 3, 2009 - -# NAME - -rainbows - rackup-like command to launch Rainbows! - -# SYNOPSIS - -rainbows [-c CONFIG_FILE] [-E RACK_ENV] [-D] [RACKUP_FILE] - -# DESCRIPTION - -A rackup(1)-like command to launch Rack applications using Rainbows!. -It is expected to be started in your application root (APP_ROOT), -but the "working_directory" directive may be used in the CONFIG_FILE. - -While Rainbows! takes a myriad of command-line options for -compatibility with ruby(1) and rackup(1), it is recommended to stick -to the few command-line options specified in the SYNOPSIS and use -the CONFIG_FILE as much as possible. - -# RACKUP FILE - -This defaults to \"config.ru\" in APP_ROOT. It should be the same -file used by rackup(1) and other Rack launchers, it uses the -*Rack::Builder* DSL. - -Embedded command-line options are mostly parsed for compatibility -with rackup(1) but strongly discouraged. - -# UNICORN OPTIONS --c, \--config-file CONFIG_FILE -: Path to the Unicorn-specific config file. The config file is - implemented as a Ruby DSL, so Ruby code may executed. - See the RDoc/ri for the *Unicorn::Configurator* class for the full - list of directives available from the DSL. - --D, \--daemonize -: Run daemonized in the background. The process is detached from - the controlling terminal and stdin is redirected to "/dev/null". - Unlike many common UNIX daemons, we do not chdir to \"/\" - upon daemonization to allow more control over the startup/upgrade - process. - Unless specified in the CONFIG_FILE, stderr and stdout will - also be redirected to "/dev/null". - --E, \--env RACK_ENV -: Run under the given RACK_ENV. See the RACK ENVIRONMENT section - for more details. - --l, \--listen ADDRESS -: Listens on a given ADDRESS. ADDRESS may be in the form of - HOST:PORT or PATH, HOST:PORT is taken to mean a TCP socket - and PATH is meant to be a path to a UNIX domain socket. - Defaults to "0.0.0.0:8080" (all addresses on TCP port 8080) - For production deployments, specifying the "listen" directive in - CONFIG_FILE is recommended as it allows fine-tuning of socket - options. --N, \--no-default-middleware -: Disables loading middleware implied by RACK_ENV. This bypasses the - configuration documented in the RACK ENVIRONMENT section, but still - allows RACK_ENV to be used for application/framework-specific purposes. - -# RACKUP COMPATIBILITY OPTIONS --o, \--host HOST -: Listen on a TCP socket belonging to HOST, default is - "0.0.0.0" (all addresses). - If specified multiple times on the command-line, only the - last-specified value takes effect. - This option only exists for compatibility with the rackup(1) command, - use of "-l"/"\--listen" switch is recommended instead. - --p, \--port PORT -: Listen on the specified TCP PORT, default is 8080. - If specified multiple times on the command-line, only the last-specified - value takes effect. - This option only exists for compatibility with the rackup(1) command, - use of "-l"/"\--listen" switch is recommended instead. - --s, \--server SERVER -: No-op, this exists only for compatibility with rackup(1). - -# RUBY OPTIONS --e, \--eval LINE -: Evaluate a LINE of Ruby code. This evaluation happens - immediately as the command-line is being parsed. - --d, \--debug -: Turn on debug mode, the $DEBUG variable is set to true. - --w, \--warn -: Turn on verbose warnings, the $VERBOSE variable is set to true. - --I, \--include PATH -: specify $LOAD_PATH. PATH will be prepended to $LOAD_PATH. - The \':\' character may be used to delimit multiple directories. - This directive may be used more than once. Modifications to - $LOAD_PATH take place immediately and in the order they were - specified on the command-line. - --r, \--require LIBRARY -: require a specified LIBRARY before executing the application. The - \"require\" statement will be executed immediately and in the order - they were specified on the command-line. - -# SIGNALS - -The following UNIX signals may be sent to the master process: - -* HUP - reload config file, app, and gracefully restart all workers -* INT/TERM - quick shutdown, kills all workers immediately -* QUIT - graceful shutdown, waits for workers to finish their - current request before finishing. -* USR1 - reopen all logs owned by the master and all workers - See Unicorn::Util.reopen_logs for what is considered a log. -* USR2 - reexecute the running binary. A separate QUIT - should be sent to the original process once the child is verified to - be up and running. -* WINCH - gracefully stops workers but keep the master running. - This will only work for daemonized processes. -* TTIN - increment the number of worker processes by one -* TTOU - decrement the number of worker processes by one - -See the [SIGNALS][4] document for full description of all signals -used by Rainbows!. - -# RACK ENVIRONMENT - -Accepted values of RACK_ENV and the middleware they automatically load -(outside of RACKUP_FILE) are exactly as those in rackup(1): - -* development - loads Rack::CommonLogger, Rack::ShowExceptions, and - Rack::Lint middleware -* deployment - loads Rack::CommonLogger middleware -* none - loads no middleware at all, relying - entirely on RACKUP_FILE - -All unrecognized values for RACK_ENV are assumed to be -"none". Production deployments are strongly encouraged to use -"deployment" or "none" for maximum performance. - -Note the Rack::ContentLength and Rack::Chunked middlewares are also -loaded by "deployment" and "development", but no other values of -RACK_ENV. If needed, they must be individually specified in the -RACKUP_FILE, some frameworks do not require them. - -# SEE ALSO - -* unicorn(1) -* *Rack::Builder* ri/RDoc -* *Unicorn::Configurator* ri/RDoc -* [Rainbows! RDoc][1] -* [Rack RDoc][2] -* [Rackup HowTo][3] - -[1]: https://bogomips.org/rainbows/ -[2]: http://rdoc.info/gems/r#/gems/rack/frames -[3]: http://wiki.github.com/rack/rack/tutorial-rackup-howto -[4]: https://bogomips.org/rainbows/SIGNALS.html @@ -64,7 +64,7 @@ requires a extra {patch}[http://haproxy.1wt.eu/download/patches/]. If you don't need streaming "rack.input", then nginx is a great HTTPS reverse proxy. -Refer to the {unicorn FAQ}[https://bogomips.org/unicorn/FAQ.html] on how +Refer to the {unicorn FAQ}[https://yhbt.net/unicorn/FAQ.html] on how to ensure redirects go to "https://" URLs. diff --git a/GIT-VERSION-GEN b/GIT-VERSION-GEN index 4053d57..ff103a7 100755 --- a/GIT-VERSION-GEN +++ b/GIT-VERSION-GEN @@ -1,5 +1,5 @@ #!/usr/bin/env ruby -DEF_VER = "v5.1.1" +DEF_VER = "v5.2.1" CONSTANT = "Rainbows::Const::RAINBOWS_VERSION" RVF = "lib/rainbows/version.rb" GVF = "GIT-VERSION-FILE" diff --git a/GNUmakefile b/GNUmakefile index af8be80..3a739b3 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -1,31 +1,30 @@ # use GNU Make to run tests in parallel, and without depending on RubyGems all:: -RSYNC_DEST := bogomips.org:/srv/bogomips/rainbows +RSYNC_DEST := yhbt.net:/srv/yhbt/rainbows rfpackage := rainbows PLACEHOLDERS := rainbows_1 Summary -man-rdoc: man html - $(MAKE) -C Documentation comparison.html -doc:: man-rdoc -include pkg.mk +Documentation/comparison.html: Documentation/comparison.haml + haml < $< >$@+ && mv $@+ $@ + +# only for the website +doc :: Documentation/comparison.html +doc :: man/man1/rainbows.1.html -base_bins := rainbows -bins := $(addprefix bin/, $(base_bins)) -man1_bins := $(addsuffix .1, $(base_bins)) -man1_paths := $(addprefix man/man1/, $(man1_bins)) +include pkg.mk +man1 := man/man1/rainbows.1 clean: -$(MAKE) -C Documentation clean + $(RM) $(man1) $(html1) -man html: - $(MAKE) -C Documentation install-$@ +pkg_extra += $(man1) lib/rainbows/version.rb -pkg_extra += $(man1_paths) lib/rainbows/version.rb +%.1.html: %.1 + $(OLDDOC) man2html -o $@ $< lib/rainbows/version.rb: GIT-VERSION-FILE all:: test test: lib/rainbows/version.rb $(MAKE) -C t - -.PHONY: man html @@ -13,7 +13,7 @@ Please wrap documentation at 72 characters-per-line or less (long URLs are exempt) so it is comfortably readable from terminals. When referencing mailing list posts, use -"https://bogomips.org/rainbows-public/<Message-ID>/" if possible since +"https://yhbt.net/rainbows-public/<Message-ID>/" if possible since the Message-ID remains searchable even if the website becomes unavailable. == Contributing @@ -38,7 +38,7 @@ distributed with git on on patch submission guidelines to follow. Just don't email the git mailing list or maintainer with Rainbows! patches :) No subscription is required to post to the mailing list at -rainbows-public@bogomips.org +rainbows-public@yhbt.net Please Cc: everyone on replies, as not everyone is subscribed. @@ -51,7 +51,7 @@ network concurrency. * Designed for {Rack}[http://rack.github.io/], the standard for modern Ruby HTTP applications. -* Built on {unicorn}[https://bogomips.org/unicorn/], inheriting its +* Built on {unicorn}[https://yhbt.net/unicorn/], inheriting its process/socket management features such as transparent upgrades and Ruby configuration DSL. @@ -116,7 +116,7 @@ In APP_ROOT (where config.ru is located), run: For deployments, it can use a config file for Unicorn and \Rainbows!-specific options specified by the +--config-file/-c+ command-line switch. \Rainbows! accepts all options found in -{Unicorn::Configurator}[https://bogomips.org/unicorn/Unicorn/Configurator.html] +{Unicorn::Configurator}[https://yhbt.net/unicorn/Unicorn/Configurator.html] as well as the "\Rainbows!" block, so you can have the following in your config file: @@ -135,13 +135,13 @@ for more details. You can get the latest source via git from the following locations (these versions may not be stable): - https://bogomips.org/rainbows.git + https://yhbt.net/rainbows.git https://repo.or.cz/rainbows.git (mirror) You may browse the code from the web and download the latest snapshot tarballs here: -* https://bogomips.org/rainbows.git +* https://yhbt.net/rainbows.git * https://repo.or.cz/rainbows.git (gitweb) Inline patches (from "git format-patch") to the mailing list are @@ -175,8 +175,10 @@ requests) go to the mailing list. Patches must be sent inline (git format-patch -M + git send-email). No subscription is necessary to post on the mailing list. No top posting. -* email: mailto:rainbows-public@bogomips.org -* subscribe: mailto:rainbows-public+subscribe@bogomips.org -* archives: https://bogomips.org/rainbows-public/ +* email: mailto:rainbows-public@yhbt.net +* subscribe: mailto:rainbows-public+subscribe@yhbt.net +* archives: https://yhbt.net/rainbows-public/ + http://ou63pmih66umazou.onion/rainbows-public/ nntp://news.public-inbox.org/inbox.comp.lang.ruby.rainbows - nntp://news.gmane.org/gmane.comp.lang.ruby.rainbows.general + nntp://ou63pmih66umazou.onion/inbox.comp.lang.ruby.rainbows + nntp://news.gmane.io/gmane.comp.lang.ruby.rainbows.general @@ -1,6 +1,6 @@ = Tips for using \Rainbows! with Sandbox installation tools -Most {tips for unicorn}[https://bogomips.org/unicorn/Sandbox.html] +Most {tips for unicorn}[https://yhbt.net/unicorn/Sandbox.html] for Bundler and Isolate apply to \Rainbows! as well. == TLDR (Bundler) @@ -1,6 +1,6 @@ = Tuning \Rainbows! -Most of the {tuning notes}[https://bogomips.org/unicorn/TUNING.html] +Most of the {tuning notes}[https://yhbt.net/unicorn/TUNING.html] apply to \Rainbows! as well. \Rainbows! is not particularly optimized at the moment and is designed for applications that spend large amounts of the time waiting on network activity. Thus memory usage and memory @@ -26,7 +26,7 @@ never be the primary goal of the project. the kernel. * If your workers do not seem to be releasing memory to the OS after - traffic spikes, consider the {mall}[https://bogomips.org/mall/] library + traffic spikes, consider the {mall}[https://yhbt.net/mall/] library which allows access to the mallopt(3) function from Ruby. As of October 2009 tcmalloc (the default allocator for Ruby Enterprise Edition) does not release memory back to the kernel, the best it can diff --git a/archive/rfmig.rb b/archive/rfmig.rb deleted file mode 100644 index a7d31e5..0000000 --- a/archive/rfmig.rb +++ /dev/null @@ -1,32 +0,0 @@ -#!/usr/bin/env ruby -require 'find' -require 'fileutils' -rfdir = 'rubyforge.org:/var/www/gforge-projects/rainbows/' -newbase = 'https://bogomips.org/rainbows/' -refresh = '<meta http-equiv="refresh" content="0; url=%s" />' -old = 'rf.old' -new = 'rf.new' -cmd = %W(rsync -av #{rfdir} #{old}/) -unless File.directory?(old) - system(*cmd) or abort "#{cmd.inspect} failed: #$?" -end - -Find.find(old) do |path| - path =~ /\.html\z/ or next - data = File.read(path) - tmp = path.split(%r{/}) - tmp.shift == old or abort "BUG" - dst = "#{new}/#{tmp.join('/')}" - - tmp[-1] = '' if tmp[-1] == "index.html" - url = "#{newbase}#{tmp.join('/')}" - meta = sprintf(refresh, url) - data.sub!(/(<head[^>]*>)/i, "#$1#{meta}") - data.sub!(/(<body[^>]*>)/i, - "#{$1}Redirecting to <a href=\"#{url}\">#{url}</a> ...<br/>") - FileUtils.mkdir_p(File.dirname(dst)) - File.open(dst, "w") { |fp| fp.write(data) } -end - -print "Verify results in #{new}/, then run:\n " -puts %W(rsync -av #{new}/ #{rfdir}).join(' ') diff --git a/archive/slrnpull.conf b/archive/slrnpull.conf index 9cf80ba..480cbec 100644 --- a/archive/slrnpull.conf +++ b/archive/slrnpull.conf @@ -1,4 +1,4 @@ # group_name max expire headers_only gmane.comp.lang.ruby.rainbows.general 1000000000 1000000000 0 -# usage: slrnpull -d $PWD -h news.gmane.org --no-post +# usage: slrnpull -d $PWD -h news.gmane.io --no-post diff --git a/examples/reverse_proxy.ru b/examples/reverse_proxy.ru index fcb9e74..432a37f 100644 --- a/examples/reverse_proxy.ru +++ b/examples/reverse_proxy.ru @@ -2,7 +2,7 @@ cfg = { :upstreams => [ "/tmp/.r.sock", - "http://bogomips.org/", + "http://yhbt.net/", [ "http://10.6.6.6:666/", { :weight => 666 } ], ] } diff --git a/lib/rainbows.rb b/lib/rainbows.rb index 584c94b..9d6d103 100644 --- a/lib/rainbows.rb +++ b/lib/rainbows.rb @@ -4,7 +4,7 @@ require 'unicorn' # the value passed to TCP_DEFER_ACCEPT actually matters in Linux 2.6.32+ Unicorn::SocketHelper::DEFAULTS[:tcp_defer_accept] = 60 -# See https://bogomips.org/rainbows/ for documentation +# See https://yhbt.net/rainbows/ for documentation module Rainbows # :stopdoc: O = {} diff --git a/lib/rainbows/configurator.rb b/lib/rainbows/configurator.rb index 83077cb..5eb7606 100644 --- a/lib/rainbows/configurator.rb +++ b/lib/rainbows/configurator.rb @@ -1,7 +1,7 @@ # -*- encoding: binary -*- # This module adds \Rainbows! to the -# {Unicorn::Configurator}[https://bogomips.org/unicorn/Unicorn/Configurator.html] +# {Unicorn::Configurator}[https://yhbt.net/unicorn/Unicorn/Configurator.html] # \Rainbows!-specific configuration options must be inside a the Rainbows! # block, otherwise Unicorn::Configurator directives may be used anywhere # in the file. @@ -9,7 +9,7 @@ # Warning: The "timeout" directive in unicorn is far more dangerous # in Rainbows!, since ALL requests running on a process will be lost # on worker death, not just one. Instead, handle application-level -# timeouts yourself: https://bogomips.org/unicorn/Application_Timeouts.html +# timeouts yourself: https://yhbt.net/unicorn/Application_Timeouts.html # # Rainbows! do # use :ThreadSpawn # concurrency model to use diff --git a/lib/rainbows/epoll.rb b/lib/rainbows/epoll.rb index 45c4d08..1e0c7a2 100644 --- a/lib/rainbows/epoll.rb +++ b/lib/rainbows/epoll.rb @@ -3,7 +3,7 @@ require 'sleepy_penguin' require 'sendfile' # Edge-triggered epoll concurrency model using -# {sleepy_penguin}[https://bogomips.org/sleepy_penguin/] for epoll. +# {sleepy_penguin}[https://yhbt.net/sleepy_penguin/] for epoll. # # Unlike more portable options like Coolio and EventMachine, this # is Linux-only, but uses edge-triggering instead of level-triggering, diff --git a/lib/rainbows/reverse_proxy.rb b/lib/rainbows/reverse_proxy.rb index a4d8390..f844c1d 100644 --- a/lib/rainbows/reverse_proxy.rb +++ b/lib/rainbows/reverse_proxy.rb @@ -3,7 +3,7 @@ require 'socket' require 'thread' require 'uri' -require 'kcar' # https://bogomips.org/kcar/ -- gem install kcar +require 'kcar' # https://yhbt.net/kcar/ -- gem install kcar # This is lightly tested and has an unstable configuration interface. # ***** Do not rely on anything under the ReverseProxy namespace! ***** diff --git a/man/man1/rainbows.1 b/man/man1/rainbows.1 new file mode 100644 index 0000000..f7aa43d --- /dev/null +++ b/man/man1/rainbows.1 @@ -0,0 +1,193 @@ +.TH "rainbows" "1" "December 3, 2009" "Rainbows! User Manual" "" +.SH NAME +.PP +rainbows \- rackup\-like command to launch Rainbows! +.SH SYNOPSIS +.PP +rainbows [\-c CONFIG_FILE] [\-E RACK_ENV] [\-D] [RACKUP_FILE] +.SH DESCRIPTION +.PP +A rackup(1)\-like command to launch Rack applications using Rainbows!. +It is expected to be started in your application root (APP_ROOT), but +the "working_directory" directive may be used in the CONFIG_FILE. +.PP +While Rainbows! takes a myriad of command\-line options for +compatibility with ruby(1) and rackup(1), it is recommended to stick to +the few command\-line options specified in the SYNOPSIS and use the +CONFIG_FILE as much as possible. +.SH RACKUP FILE +.PP +This defaults to "config.ru" in APP_ROOT. +It should be the same file used by rackup(1) and other Rack launchers, +it uses the \f[I]Rack::Builder\f[] DSL. +.PP +Embedded command\-line options are mostly parsed for compatibility with +rackup(1) but strongly discouraged. +.SH UNICORN OPTIONS +.TP +.B \-c, \-\-config\-file CONFIG_FILE +Path to the Unicorn\-specific config file. +The config file is implemented as a Ruby DSL, so Ruby code may executed. +See the RDoc/ri for the \f[I]Unicorn::Configurator\f[] class for the +full list of directives available from the DSL. +.RS +.RE +.TP +.B \-D, \-\-daemonize +Run daemonized in the background. +The process is detached from the controlling terminal and stdin is +redirected to "/dev/null". +Unlike many common UNIX daemons, we do not chdir to "/" upon +daemonization to allow more control over the startup/upgrade process. +Unless specified in the CONFIG_FILE, stderr and stdout will also be +redirected to "/dev/null". +.RS +.RE +.TP +.B \-E, \-\-env RACK_ENV +Run under the given RACK_ENV. +See the RACK ENVIRONMENT section for more details. +.RS +.RE +.TP +.B \-l, \-\-listen ADDRESS +Listens on a given ADDRESS. +ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken to +mean a TCP socket and PATH is meant to be a path to a UNIX domain +socket. +Defaults to "0.0.0.0:8080" (all addresses on TCP port 8080) For +production deployments, specifying the "listen" directive in CONFIG_FILE +is recommended as it allows fine\-tuning of socket options. +.RS +.RE +.TP +.B \-N, \-\-no\-default\-middleware +Disables loading middleware implied by RACK_ENV. +This bypasses the configuration documented in the RACK ENVIRONMENT +section, but still allows RACK_ENV to be used for +application/framework\-specific purposes. +.RS +.RE +.SH RACKUP COMPATIBILITY OPTIONS +.TP +.B \-o, \-\-host HOST +Listen on a TCP socket belonging to HOST, default is "0.0.0.0" (all +addresses). +If specified multiple times on the command\-line, only the +last\-specified value takes effect. +This option only exists for compatibility with the rackup(1) command, +use of "\-l"/"\-\-listen" switch is recommended instead. +.RS +.RE +.TP +.B \-p, \-\-port PORT +Listen on the specified TCP PORT, default is 8080. +If specified multiple times on the command\-line, only the +last\-specified value takes effect. +This option only exists for compatibility with the rackup(1) command, +use of "\-l"/"\-\-listen" switch is recommended instead. +.RS +.RE +.TP +.B \-s, \-\-server SERVER +No\-op, this exists only for compatibility with rackup(1). +.RS +.RE +.SH RUBY OPTIONS +.TP +.B \-e, \-\-eval LINE +Evaluate a LINE of Ruby code. +This evaluation happens immediately as the command\-line is being +parsed. +.RS +.RE +.TP +.B \-d, \-\-debug +Turn on debug mode, the $DEBUG variable is set to true. +.RS +.RE +.TP +.B \-w, \-\-warn +Turn on verbose warnings, the $VERBOSE variable is set to true. +.RS +.RE +.TP +.B \-I, \-\-include PATH +specify +\f[I]L\f[]\f[I]O\f[]\f[I]A\f[]\f[I]D\f[]~\f[I]P\f[]~\f[I]A\f[]\f[I]T\f[]\f[I]H\f[].\f[I]P\f[]\f[I]A\f[]\f[I]T\f[]\f[I]H\f[]\f[I]w\f[]\f[I]i\f[]\f[I]l\f[]\f[I]l\f[]\f[I]b\f[]\f[I]e\f[]\f[I]p\f[]\f[I]r\f[]\f[I]e\f[]\f[I]p\f[]\f[I]e\f[]\f[I]n\f[]\f[I]d\f[]\f[I]e\f[]\f[I]d\f[]\f[I]t\f[]\f[I]o\f[]LOAD_PATH. +The \[aq]:\[aq] character may be used to delimit multiple directories. +This directive may be used more than once. +Modifications to $LOAD_PATH take place immediately and in the order they +were specified on the command\-line. +.RS +.RE +.TP +.B \-r, \-\-require LIBRARY +require a specified LIBRARY before executing the application. +The "require" statement will be executed immediately and in the order +they were specified on the command\-line. +.RS +.RE +.SH SIGNALS +.PP +The following UNIX signals may be sent to the master process: +.IP \[bu] 2 +HUP \- reload config file, app, and gracefully restart all workers +.IP \[bu] 2 +INT/TERM \- quick shutdown, kills all workers immediately +.IP \[bu] 2 +QUIT \- graceful shutdown, waits for workers to finish their current +request before finishing. +.IP \[bu] 2 +USR1 \- reopen all logs owned by the master and all workers See +Unicorn::Util.reopen_logs for what is considered a log. +.IP \[bu] 2 +USR2 \- reexecute the running binary. +A separate QUIT should be sent to the original process once the child is +verified to be up and running. +.IP \[bu] 2 +WINCH \- gracefully stops workers but keep the master running. +This will only work for daemonized processes. +.IP \[bu] 2 +TTIN \- increment the number of worker processes by one +.IP \[bu] 2 +TTOU \- decrement the number of worker processes by one +.PP +See the SIGNALS (https://yhbt.net/rainbows/SIGNALS.html) document +for full description of all signals used by Rainbows!. +.SH RACK ENVIRONMENT +.PP +Accepted values of RACK_ENV and the middleware they automatically load +(outside of RACKUP_FILE) are exactly as those in rackup(1): +.IP \[bu] 2 +development \- loads Rack::CommonLogger, Rack::ShowExceptions, and +Rack::Lint middleware +.IP \[bu] 2 +deployment \- loads Rack::CommonLogger middleware +.IP \[bu] 2 +none \- loads no middleware at all, relying entirely on RACKUP_FILE +.PP +All unrecognized values for RACK_ENV are assumed to be "none". +Production deployments are strongly encouraged to use "deployment" or +"none" for maximum performance. +.PP +Note the Rack::ContentLength and Rack::Chunked middlewares are also +loaded by "deployment" and "development", but no other values of +RACK_ENV. +If needed, they must be individually specified in the RACKUP_FILE, some +frameworks do not require them. +.SH SEE ALSO +.IP \[bu] 2 +unicorn(1) +.IP \[bu] 2 +\f[I]Rack::Builder\f[] ri/RDoc +.IP \[bu] 2 +\f[I]Unicorn::Configurator\f[] ri/RDoc +.IP \[bu] 2 +Rainbows! RDoc (https://yhbt.net/rainbows/) +.IP \[bu] 2 +Rack RDoc (http://rdoc.info/gems/r#/gems/rack/frames) +.IP \[bu] 2 +Rackup HowTo (http://wiki.github.com/rack/rack/tutorial-rackup-howto) +.SH AUTHORS +Rainbows! Hackers <rainbows-public@yhbt.net>. @@ -68,7 +68,7 @@ doc:: .document .olddoc.yml $(pkg_extra) $(PLACEHOLDERS) -find lib -type f -name '*.rbc' -exec rm -f '{}' ';' -find ext -type f -name '*.rbc' -exec rm -f '{}' ';' $(RM) -r doc - $(RDOC) -f oldweb + $(RDOC) -f dark216 $(OLDDOC) merge install -m644 COPYING doc/COPYING install -m644 NEWS doc/NEWS diff --git a/rainbows.gemspec b/rainbows.gemspec index 259e2ab..558799e 100644 --- a/rainbows.gemspec +++ b/rainbows.gemspec @@ -8,13 +8,13 @@ Gem::Specification.new do |s| s.authors = ['Rainbows! hackers'] s.description = File.read('README').split("\n\n")[1] - s.email = %q{rainbows-public@bogomips.org} + s.email = %q{rainbows-public@yhbt.net} s.executables = %w(rainbows) s.extra_rdoc_files = IO.readlines('.document').map!(&:chomp!).keep_if do |f| File.exist?(f) end s.files = manifest - s.homepage = 'https://bogomips.org/rainbows/' + s.homepage = 'https://yhbt.net/rainbows/' s.summary = 'Rack app server for sleepy apps and slow clients' # we want a newer Rack for a valid HeaderHash#each @@ -59,11 +59,11 @@ Gem::Specification.new do |s| ruby_1_8 = 'Nonstandard' s.licenses = [ 'GPL-2.0+', ruby_1_8 ] s.metadata = { - 'bug_tracker_uri' => 'https://bogomips.org/rainbows/#label-Contact', - 'changelog_uri' => 'https://bogomips.org/rainbows/NEWS.html', - 'documentation_uri' => 'https://bogomips.org/rainbows/', - 'homepage_uri' => 'https://bogomips.org/rainbows/', - 'mailing_list_uri' => 'https://bogomips.org/rainbows-public/', - 'source_code_uri' => 'https://bogomips.org/rainbows.git', + 'bug_tracker_uri' => 'https://yhbt.net/rainbows/#label-Contact', + 'changelog_uri' => 'https://yhbt.net/rainbows/NEWS.html', + 'documentation_uri' => 'https://yhbt.net/rainbows/', + 'homepage_uri' => 'https://yhbt.net/rainbows/', + 'mailing_list_uri' => 'https://yhbt.net/rainbows-public/', + 'source_code_uri' => 'https://yhbt.net/rainbows.git', } end @@ -82,7 +82,7 @@ unicorn code), some things are not: to different worker processes, and if your listen() +:backlog+ is overflowing: to other machines in your cluster. -* Accepts the same {signals}[https://bogomips.org/unicorn/SIGNALS.html] +* Accepts the same {signals}[https://yhbt.net/unicorn/SIGNALS.html] for process management, so you can share scripts to manage them (and nginx, too). |