gemstash 2.7.1 → 2.8.0

data/lib/gemstash/man/gemstash-configuration.5

@@ -1,12 +1,28 @@
-<!-- Automatically generated by Pandoc -->
-.\" Automatically generated by Pandoc 3.1.8
+.\" Automatically generated by Pandoc 3.1.3
 .\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
 .TH "gemstash-configuration" "5" "October 13, 2015" "" ""
+.hy
 .SH Name
+.PP
 gemstash-configuration
 .SH Synopsis
 .IP
-.EX
+.nf
+\f[C]
 # \[ti]/.gemstash/config.yml
 ---
 :base_path: \[dq]/var/gemstash\[dq]
@@ -23,10 +39,13 @@ gemstash-configuration
 :bind: tcp://0.0.0.0:4242
 :protected_fetch: true
 :fetch_timeout: 10
+:open_timeout: 2
 :log_file: gemstash.log
-.EE
+\f[R]
+.fi
 .SH Base Path
-\f[CR]:base_path\f[R]
+.PP
+\f[V]:base_path\f[R]
 .PP
 Specifies where to store local files like the server log, cached gem
 files, and the database (when using SQLite).
@@ -34,111 +53,136 @@ If the default is being used, the directory will be created if it does
 not exist.
 Any other directory needs to be created ahead of time and be writable to
 the Gemstash server process.
-Specifying the \f[CR]:base_path\f[R] via \f[CR]gemstash setup\f[R] will
+Specifying the \f[V]:base_path\f[R] via \f[V]gemstash setup\f[R] will
 create the directory for you.
 .SS Default value
-\f[CR]\[ti]/.gemstash\f[R]
+.PP
+\f[V]\[ti]/.gemstash\f[R]
 .SS Valid values
+.PP
 Any valid path
 .SH Cache Type
-\f[CR]:cache_type\f[R]
+.PP
+\f[V]:cache_type\f[R]
 .PP
 Specifies how to cache values other than gem files (such as gem
 dependencies).
-\f[CR]memory\f[R] will use an in memory cache while \f[CR]memcached\f[R]
+\f[V]memory\f[R] will use an in memory cache while \f[V]memcached\f[R]
 will point to 1 or more Memcached servers.
-Use the \f[CR]:memcached_servers\f[R] configuration key for specifying
+Use the \f[V]:memcached_servers\f[R] configuration key for specifying
 where the Memcached server(s) are.
 .SS Default value
-\f[CR]memory\f[R]
+.PP
+\f[V]memory\f[R]
 .SS Valid values
-\f[CR]memory\f[R], \f[CR]memcached\f[R]
+.PP
+\f[V]memory\f[R], \f[V]memcached\f[R]
 .SH Memcached Servers
-\f[CR]:memcached_servers\f[R]
+.PP
+\f[V]:memcached_servers\f[R]
 .PP
 Specifies the Memcached servers to connect to when using
-\f[CR]memcached\f[R] for the \f[CR]:cache_type\f[R].
-Only used when \f[CR]memcached\f[R] is used for \f[CR]:cache_type\f[R].
+\f[V]memcached\f[R] for the \f[V]:cache_type\f[R].
+Only used when \f[V]memcached\f[R] is used for \f[V]:cache_type\f[R].
 .SS Default value
-\f[CR]localhost:11211\f[R]
+.PP
+\f[V]localhost:11211\f[R]
 .SS Valid values
+.PP
 A comma delimited list of Memcached servers
 .SH DB Adapter
-\f[CR]:db_adapter\f[R]
+.PP
+\f[V]:db_adapter\f[R]
 .PP
 Specifies what database adapter to use.
-When \f[CR]sqlite3\f[R] is used, the database will be located at
-\f[CR]gemstash.db\f[R] within the directory specified by
-\f[CR]:base_path\f[R].
-The database will automatically be created when using
-\f[CR]sqlite3\f[R].
-When \f[CR]postgres\f[R], \f[CR]mysql\f[R], or \f[CR]mysql2\f[R] is
-used, the database to connect to must be specified in the
-\f[CR]:db_url\f[R] configuration key.
+When \f[V]sqlite3\f[R] is used, the database will be located at
+\f[V]gemstash.db\f[R] within the directory specified by
+\f[V]:base_path\f[R].
+The database will automatically be created when using \f[V]sqlite3\f[R].
+When \f[V]postgres\f[R], \f[V]mysql\f[R], or \f[V]mysql2\f[R] is used,
+the database to connect to must be specified in the \f[V]:db_url\f[R]
+configuration key.
 The database must already be created when using anything other than
-\f[CR]sqlite3\f[R].
+\f[V]sqlite3\f[R].
 .SS Default value
-\f[CR]sqlite3\f[R]
+.PP
+\f[V]sqlite3\f[R]
 .SS Valid values
-\f[CR]sqlite3\f[R], \f[CR]postgres\f[R], \f[CR]mysql\f[R],
-\f[CR]mysql2\f[R]
+.PP
+\f[V]sqlite3\f[R], \f[V]postgres\f[R], \f[V]mysql\f[R], \f[V]mysql2\f[R]
 .SH DB URL
-\f[CR]:db_url\f[R]
 .PP
-Specifies the database to connect to when using \f[CR]postgres\f[R],
-\f[CR]mysql\f[R], or \f[CR]mysql2\f[R] for the \f[CR]:db_adapter\f[R].
-Only used when the \f[CR]:db_adapter\f[R] is not \f[CR]sqlite3\f[R].
+\f[V]:db_url\f[R]
+.PP
+Specifies the database to connect to when using \f[V]postgres\f[R],
+\f[V]mysql\f[R], or \f[V]mysql2\f[R] for the \f[V]:db_adapter\f[R].
+Only used when the \f[V]:db_adapter\f[R] is not \f[V]sqlite3\f[R].
 .SS Default value
+.PP
 None
 .SS Valid values
+.PP
 A valid database URL for the Sequel gem (http://sequel.jeremyevans.net/)
 .SH DB Connection Options
-\f[CR]:db_connection_options\f[R]
 .PP
-Specifies additional \f[CR]Sequel.connect\f[R] options to use.
+\f[V]:db_connection_options\f[R]
+.PP
+Specifies additional \f[V]Sequel.connect\f[R] options to use.
 Note that any options here are merged in with the default options, so
-you need not specify the \f[CR]max_connections\f[R] if you customize
-this option.
+you need not specify the \f[V]max_connections\f[R] if you customize this
+option.
 .SS Default value
-\f[CR]{ max_connections: 1 }\f[R] for \f[CR]sqlite3\f[R] adapter,
-\f[CR]{ max_connections: config[:puma_threads] + 1 }\f[R] for any other
+.PP
+\f[V]{ max_connections: 1 }\f[R] for \f[V]sqlite3\f[R] adapter,
+\f[V]{ max_connections: config[:puma_threads] + 1 }\f[R] for any other
 adapter.
 .SS Valid values
+.PP
 A valid connection options Hash for the
 Sequel.connect (http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options)
 method.
 .SH Rubygems URL
-\f[CR]:rubygems_url\f[R]
+.PP
+\f[V]:rubygems_url\f[R]
 .PP
 Specifies the default gem source URL.
-When any API endpoint is called without a \f[CR]/private\f[R] or
-\f[CR]/upstream/<url>\f[R] prefix, this URL will be used to fetch the
+When any API endpoint is called without a \f[V]/private\f[R] or
+\f[V]/upstream/<url>\f[R] prefix, this URL will be used to fetch the
 result.
 This value can be safely changed even if there are already gems stashed
 for the previous value.
 .SS Default value
-\f[CR]https://rubygems.org\f[R]
+.PP
+\f[V]https://rubygems.org\f[R]
 .SS Valid values
+.PP
 A valid gem source URL
 .SH Ignore Gemfile source
-\f[CR]:ignore_gemfile_source\f[R]
+.PP
+\f[V]:ignore_gemfile_source\f[R]
 .PP
 Ignore the source specified in Gemfile and always use
-\f[CR]:rubygems_url\f[R] as gems upstream.
+\f[V]:rubygems_url\f[R] as gems upstream.
 .SS Default value
-\f[CR]false\f[R]
+.PP
+\f[V]false\f[R]
 .SS Valid values
-Boolean: \f[CR]true\f[R] or \f[CR]false\f[R]
+.PP
+Boolean: \f[V]true\f[R] or \f[V]false\f[R]
 .SH Puma Threads
-\f[CR]:puma_threads\f[R]
+.PP
+\f[V]:puma_threads\f[R]
 .PP
 Specifies the number of threads used for the Gemstash server.
 .SS Default value
-\f[CR]16\f[R]
+.PP
+\f[V]16\f[R]
 .SS Valid values
-Integer value with a minimum of \f[CR]1\f[R]
+.PP
+Integer value with a minimum of \f[V]1\f[R]
 .SH Bind Address
-\f[CR]:bind\f[R]
+.PP
+\f[V]:bind\f[R]
 .PP
 Specifies the binding used to start the Gemstash server.
 Keep in mind the user starting Gemstash needs to have access to bind in
@@ -146,38 +190,67 @@ this manner.
 For example, if you use a port below 1024, you will need to run Gemstash
 as the root user.
 .SS Default value
-\f[CR]tcp://0.0.0.0:9292\f[R]
+.PP
+\f[V]tcp://0.0.0.0:9292\f[R]
 .SS Valid values
+.PP
 Any valid binding that is supported by
 Puma (https://github.com/puma/puma#binding-tcp--sockets)
 .SH Protected Fetch
-\f[CR]:protected_fetch\f[R]
+.PP
+\f[V]:protected_fetch\f[R]
 .PP
 Tells Gemstash to authenticate via an API key before allowing the
 fetching of private gems and specs.
 The default behavior is to allow unauthenticated download of private
 gems and specs.
 .SS Default value
-\f[CR]false\f[R]
+.PP
+\f[V]false\f[R]
 .SS Valid values
-Boolean values \f[CR]true\f[R] or \f[CR]false\f[R]
+.PP
+Boolean values \f[V]true\f[R] or \f[V]false\f[R]
 .SH Fetch Timeout
-\f[CR]:fetch_timeout\f[R]
 .PP
-The timeout setting for fetching gems.
+\f[V]:fetch_timeout\f[R]
+.PP
+This is the number of seconds to allow for fetching a gem from upstream.
+It covers establishing the connection and receiving the response.
 Fetching gems over a slow connection may cause timeout errors.
 If you experience timeout errors, you may want to increase this value.
-The default is \f[CR]20\f[R] seconds.
+The default is \f[V]20\f[R] seconds.
 .SS Default value
-\f[CR]20\f[R]
+.PP
+\f[V]20\f[R]
 .SS Valid values
-Integer value with a minimum of \f[CR]1\f[R]
+.PP
+Integer value with a minimum of \f[V]1\f[R]
+.SH Open Timeout
+.PP
+\f[V]:open_timeout\f[R]
+.PP
+The timeout setting for opening the connection to an upstream gem
+server.
+On high-latency networks, even establishing the connection to an
+upstream gem server can take a while.
+If you experience connection failures instead of timeout errors, you may
+want to increase this value.
+The default is \f[V]2\f[R] seconds.
+.SS Default value
+.PP
+\f[V]2\f[R]
+.SS Valid values
+.PP
+Integer value with a minimum of \f[V]1\f[R]
 .SH Log File
-\f[CR]:log_file\f[R]
+.PP
+\f[V]:log_file\f[R]
 .PP
 Indicates the name of the file to use for logging.
 The file will be placed in the base path.
 .SS Default value
-\f[CR]server.log\f[R]
+.PP
+\f[V]server.log\f[R]
 .SS Valid values
-Any valid file name, or \f[CR]:stdout\f[R] to log to \f[CR]$stdout\f[R]
+.PP
+Any valid file name, or \f[V]:stdout\f[R] to log to \f[V]$stdout\f[R]

data/lib/gemstash/man/gemstash-configuration.5.txt

@@ -1,7 +1,5 @@
 4mgemstash-configuration24m(5)				  4mgemstash-configuration24m(5)
 
-<!-- Automatically generated by Pandoc -->
-
 1mName0m
        gemstash-configuration
 
@@ -22,184 +20,202 @@
 	      :bind: tcp://0.0.0.0:4242
 	      :protected_fetch: true
 	      :fetch_timeout: 10
+	      :open_timeout: 2
 	      :log_file: gemstash.log
 
 1mBase Path0m
-       :base_path
+       1m:base_path0m
 
-       Specifies  where  to  store local files like the server log, cached gem
-       files, and the database (when using SQLite).  If the default  is  being
+       Specifies  where	 to  store local files like the server log, cached gem
+       files, and the database (when using SQLite).  If the default  is	 being
        used,  the  directory  will be created if it does not exist.  Any other
        directory needs to be created ahead of time and be writable to the Gem-
-       stash server process.  Specifying the  :base_path  via  gemstash  setup
+       stash server process.  Specifying the  1m:base_path  22mvia  1mgemstash	setup0m
        will create the directory for you.
 
    1mDefault value0m
-       ~/.gemstash
+       1m~/.gemstash0m
 
    1mValid values0m
        Any valid path
 
 1mCache Type0m
-       :cache_type
+       1m:cache_type0m
 
        Specifies  how to cache values other than gem files (such as gem depen-
-       dencies).  memory will use an in  memory  cache	while  memcached  will
-       point  to 1 or more Memcached servers.  Use the :memcached_servers con-
+       dencies).  1mmemory 22mwill use an in  memory  cache  while  1mmemcached	 22mwill
+       point  to 1 or more Memcached servers.  Use the 1m:memcached_servers 22mcon-
        figuration key for specifying where the Memcached server(s) are.
 
    1mDefault value0m
-       memory
+       1mmemory0m
 
    1mValid values0m
-       memory, memcached
+       1mmemory22m, 1mmemcached0m
 
 1mMemcached Servers0m
-       :memcached_servers
+       1m:memcached_servers0m
 
-       Specifies the Memcached servers to connect to when using memcached  for
-       the :cache_type.  Only used when memcached is used for :cache_type.
+       Specifies the Memcached servers to connect to when using 1mmemcached  22mfor
+       the 1m:cache_type22m.  Only used when 1mmemcached 22mis used for 1m:cache_type22m.
 
    1mDefault value0m
-       localhost:11211
+       1mlocalhost:112110m
 
    1mValid values0m
        A comma delimited list of Memcached servers
 
 1mDB Adapter0m
-       :db_adapter
+       1m:db_adapter0m
 
-       Specifies  what	database  adapter  to  use.  When sqlite3 is used, the
-       database will be located at gemstash.db within the directory  specified
-       by  :base_path.	 The database will automatically be created when using
-       sqlite3.  When postgres, mysql, or mysql2 is used, the database to con-
-       nect to must be specified in the :db_url configuration key.  The  data-
-       base must already be created when using anything other than sqlite3.
+       Specifies  what	database  adapter  to  use.  When 1msqlite3 22mis used, the
+       database will be located at 1mgemstash.db 22mwithin the directory  specified
+       by  1m:base_path22m.   The database will automatically be created when using
+       1msqlite322m.  When 1mpostgres22m, 1mmysql22m, or 1mmysql2 22mis used, the database to con-
+       nect to must be specified in the 1m:db_url 22mconfiguration key.	 The  data-
+       base must already be created when using anything other than 1msqlite322m.
 
    1mDefault value0m
-       sqlite3
+       1msqlite30m
 
    1mValid values0m
-       sqlite3, postgres, mysql, mysql2
+       1msqlite322m, 1mpostgres22m, 1mmysql22m, 1mmysql20m
 
 1mDB URL0m
-       :db_url
+       1m:db_url0m
 
-       Specifies  the  database  to  connect to when using postgres, mysql, or
-       mysql2 for the :db_adapter.  Only used  when  the  :db_adapter  is  not
-       sqlite3.
+       Specifies  the  database	 to  connect to when using 1mpostgres22m, 1mmysql22m, or
+       1mmysql2 22mfor the 1m:db_adapter22m.  Only used	 when  the  1m:db_adapter  22mis  not
+       1msqlite322m.
 
    1mDefault value0m
        None
 
    1mValid values0m
-       A  valid  database  URL	for  the  Sequel  gem  (http://sequel.jeremye-
+       A  valid	 database  URL	for  the  Sequel  gem  (http://sequel.jeremye-
        vans.net/)
 
 1mDB Connection Options0m
-       :db_connection_options
+       1m:db_connection_options0m
 
-       Specifies additional Sequel.connect options to use.  Note that any  op-
-       tions  here  are  merged  in  with the default options, so you need not
-       specify the max_connections if you customize this option.
+       Specifies additional 1mSequel.connect 22moptions to use.	 Note that any	op-
+       tions  here  are	 merged	 in  with the default options, so you need not
+       specify the 1mmax_connections 22mif you customize this option.
 
    1mDefault value0m
-       { max_connections: 1 } for sqlite3  adapter,  {	max_connections:  con-
-       fig[:puma_threads] + 1 } for any other adapter.
+       1m{ max_connections: 1 } 22mfor 1msqlite3  22madapter,  1m{  max_connections:  con-0m
+       1mfig[:puma_threads] + 1 } 22mfor any other adapter.
 
    1mValid values0m
-       A  valid  connection  options  Hash  for the Sequel.connect (http://se-
+       A  valid	 connection  options  Hash  for the Sequel.connect (http://se-
        quel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-
        General+connection+options) method.
 
 1mRubygems URL0m
-       :rubygems_url
+       1m:rubygems_url0m
 
        Specifies the default gem source URL.  When any API endpoint is	called
-       without	a /private or /upstream/<url> prefix, this URL will be used to
+       without	a 1m/private 22mor 1m/upstream/<url> 22mprefix, this URL will be used to
        fetch the result.  This value can be safely changed even if  there  are
        already gems stashed for the previous value.
 
    1mDefault value0m
-       https://rubygems.org
+       1mhttps://rubygems.org0m
 
    1mValid values0m
        A valid gem source URL
 
 1mIgnore Gemfile source0m
-       :ignore_gemfile_source
+       1m:ignore_gemfile_source0m
 
-       Ignore  the source specified in Gemfile and always use :rubygems_url as
+       Ignore  the source specified in Gemfile and always use 1m:rubygems_url 22mas
        gems upstream.
 
    1mDefault value0m
-       false
+       1mfalse0m
 
    1mValid values0m
-       Boolean: true or false
+       Boolean: 1mtrue 22mor 1mfalse0m
 
 1mPuma Threads0m
-       :puma_threads
+       1m:puma_threads0m
 
        Specifies the number of threads used for the Gemstash server.
 
    1mDefault value0m
-       16
+       1m160m
 
    1mValid values0m
-       Integer value with a minimum of 1
+       Integer value with a minimum of 1m10m
 
 1mBind Address0m
-       :bind
+       1m:bind0m
 
-       Specifies the binding used to start the Gemstash server.  Keep in  mind
+       Specifies the binding used to start the Gemstash server.	 Keep in  mind
        the user starting Gemstash needs to have access to bind in this manner.
        For  example,  if  you use a port below 1024, you will need to run Gem-
        stash as the root user.
 
    1mDefault value0m
-       tcp://0.0.0.0:9292
+       1mtcp://0.0.0.0:92920m
 
    1mValid values0m
        Any     valid	 binding     that     is     supported	   by	  Puma
        (https://github.com/puma/puma#binding-tcp--sockets)
 
 1mProtected Fetch0m
-       :protected_fetch
+       1m:protected_fetch0m
 
        Tells  Gemstash	to  authenticate  via  an  API key before allowing the
-       fetching of private gems and specs.  The default behavior is  to  allow
+       fetching of private gems and specs.  The default behavior is  to	 allow
        unauthenticated download of private gems and specs.
 
    1mDefault value0m
-       false
+       1mfalse0m
 
    1mValid values0m
-       Boolean values true or false
+       Boolean values 1mtrue 22mor 1mfalse0m
 
 1mFetch Timeout0m
-       :fetch_timeout
+       1m:fetch_timeout0m
+
+       This  is	 the  number  of  seconds to allow for fetching a gem from up-
+       stream.	It covers establishing the connection and  receiving  the  re-
+       sponse.	Fetching gems over a slow connection may cause timeout errors.
+       If  you experience timeout errors, you may want to increase this value.
+       The default is 1m20 22mseconds.
+
+   1mDefault value0m
+       1m200m
+
+   1mValid values0m
+       Integer value with a minimum of 1m10m
+
+1mOpen Timeout0m
+       1m:open_timeout0m
 
-       The  timeout setting for fetching gems.	Fetching gems over a slow con-
-       nection may cause timeout errors.  If you  experience  timeout  errors,
-       you may want to increase this value.  The default is 20 seconds.
+       The timeout setting for opening the connection to an upstream gem serv-
+       er.  On high-latency networks, even establishing the connection	to  an
+       upstream	 gem  server  can  take a while.  If you experience connection
+       failures instead of timeout errors, you may want to increase this  val-
+       ue.  The default is 1m2 22mseconds.
 
    1mDefault value0m
-       20
+       1m20m
 
    1mValid values0m
-       Integer value with a minimum of 1
+       Integer value with a minimum of 1m10m
 
 1mLog File0m
-       :log_file
+       1m:log_file0m
 
        Indicates  the  name  of the file to use for logging.  The file will be
        placed in the base path.
 
    1mDefault value0m
-       server.log
+       1mserver.log0m
 
    1mValid values0m
-       Any valid file name, or :stdout to log to $stdout
+       Any valid file name, or 1m:stdout 22mto log to 1m$stdout0m
 
-			       October 13, 2015      4mgemstash-configuration24m(5)
+			       October 13, 2015	     4mgemstash-configuration24m(5)