gemstash 1.0.0.pre.1-java → 2.5.0-java

data/lib/gemstash/man/gemstash-customize.7

@@ -0,0 +1,273 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.1.8
+.\"
+.TH "gemstash-customize" "7" "October 28, 2015" "" ""
+.SH Customizing the Server
+Although Gemstash is designed for as minimal setup as possible, there
+may be times you will want to change some of the default configuration.
+By the end of this guide, you will be able to customize some of the
+Gemstash behavior, including where files are stored, what database
+Gemstash uses, and how Gemstash caches certain requests.
+.SS Setup
+Several customizable options are available via an interactive Gemstash
+command.
+Run \f[CR]gemstash setup\f[R] and answer the questions it provides (a
+blank answer will use the default value):
+.RS
+.PP
+$ gemstash setup
+.PD 0
+.P
+.PD
+Where should files go?
+[\[ti]/.gemstash]
+.PD 0
+.P
+.PD
+Cache with what?
+[MEMORY, memcached] \f[B]memcached\f[R]
+.PD 0
+.P
+.PD
+What is the comma separated Memcached servers?
+[localhost:11211]
+.PD 0
+.P
+.PD
+What database adapter?
+[SQLITE3, postgres, mysql, mysql2] \f[B]postgres\f[R]
+.PD 0
+.P
+.PD
+Where is the database?
+[postgres:///gemstash]
+.PD 0
+.P
+.PD
+Checking that the cache is available
+.PD 0
+.P
+.PD
+Checking that the database is available
+.PD 0
+.P
+.PD
+The database is not available
+.PD 0
+.P
+.PD
+.RE
+.PP
+Once you\[cq]ve answered the questions, some checks will be made to
+ensure the configuration will work.
+For example, the database didn\[cq]t exist in the previous example, so
+the command failed and the configuration wasn\[cq]t saved.
+If the command passes, you may provide the \f[CR]--redo\f[R] option to
+force configuration to be redone:
+.RS
+.PP
+\f[CR]$ gemstash setup --redo\f[R]
+.PD 0
+.P
+.PD
+Where should files go?
+[\[ti]/.gemstash]
+.PD 0
+.P
+.PD
+Cache with what?
+[MEMORY, memcached] \f[B]memcached\f[R]
+.PD 0
+.P
+.PD
+What is the comma separated Memcached servers?
+[localhost:11211]
+.PD 0
+.P
+.PD
+What database adapter?
+[SQLITE3, postgres, mysql, mysql2]
+.PD 0
+.P
+.PD
+Checking that the cache is available
+.PD 0
+.P
+.PD
+Checking that the database is available
+.PD 0
+.P
+.PD
+You are all setup!
+.PD 0
+.P
+.PD
+.RE
+.PP
+Once all checks have passed, Gemstash will store your answers in the
+configuration file located at \f[CR]\[ti]/.gemstash/config.yml\f[R].
+.SS Files
+Storage in Gemstash defaults to \f[CR]\[ti]/.gemstash\f[R] unless
+otherwise specified.
+You can change this in your config file via the \f[CR]:base_path\f[R]
+key:
+.IP
+.EX
+# \[ti]/.gemstash/config.yml
+---
+:base_path: \[dq]/var/gemstash\[dq]
+.EE
+.PP
+When customizing the \f[CR]base_path\f[R], the directory must exist,
+otherwise Gemstash will fail to run.
+Thus, if you want to use \f[CR]/var/gemstash\f[R] like in the previous
+example, make sure to \f[CR]mkdir /var/gemstash\f[R] and grant access to
+the directory for the user you run Gemstash with.
+.SS Database
+The \f[CR]:db_adapter\f[R] configuration key specifies what database you
+will be using.
+The default \f[CR]:db_adapter\f[R] is
+\f[CR]sqlite3\f[R] (https://www.sqlite.org/), which will use a database
+file located within your \f[CR]:base_path\f[R].
+The database file will always be named \f[CR]gemstash.db\f[R].
+.PP
+You may also use \f[CR]postgres\f[R] (http://www.postgresql.org/),
+\f[CR]mysql\f[R] (http://www.mysql.com/), or
+\f[CR]mysql2\f[R] (http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-mysql2)
+for your \f[CR]:db_adapter\f[R].
+When using any of these options, you need to specify the
+\f[CR]:db_url\f[R] to point to an existing database.
+Here is an example configuration to use the \f[CR]postgres\f[R] adapter:
+.IP
+.EX
+# \[ti]/.gemstash/config.yml
+---
+:db_adapter: postgres
+:db_url: postgres:///gemstash
+:db_connection_options: # Sequel.connect options
+  :connect_timeout: 10
+  :read_timeout: 5
+  :timeout: 30
+.EE
+.PP
+Regardless of the adapter you choose, the database will automatically
+migrate to your version of Gemstash whenever the database is needed.
+You only need to ensure the database exists and Gemstash will do the
+rest, except for \f[CR]sqlite3\f[R] (for which Gemstash will also create
+the database for you).
+.SS Cache
+Certain things (like dependencies) are cached in memory.
+This avoids web calls to the gem source, and database calls for private
+gems.
+.IP
+.EX
+# \[ti]/.gemstash/config.yml
+---
+:cache_type: memory
+:cache_max_size: 2000
+.EE
+.PP
+This configuration uses the default \f[CR]memory\f[R] cache, and has
+increased the \f[CR]cache_max_size\f[R] setting from its default of 500
+items.
+.PP
+The memory cache can optionally be swapped out with a
+Memcached (http://memcached.org/) server (or cluster of servers).
+.PP
+To use Memcached, use the \f[CR]memcached\f[R] \f[CR]:cache_type\f[R]
+configuration.
+.PP
+Provide the servers as a comma-separated list to the
+\f[CR]:memcached_servers\f[R] configuration key:
+.IP
+.EX
+# \[ti]/.gemstash/config.yml
+---
+:cache_type: memcached
+:memcached_servers: memcached1.local:11211,memcached2.local:11211
+:cache_expiration: 1800
+.EE
+.PP
+All caching expires in \f[CR]cache_expiration\f[R] number of seconds.
+Default is 1800 seconds (30 minutes).
+This option applies to all caching.
+.SS Server
+Gemstash uses Puma (http://puma.io/) and Rack (http://rack.github.io/)
+as the server.
+Alternate server configurations are not currently supported, but you can
+take a look at the Puma
+configuration (https://github.com/rubygems/gemstash/blob/master/lib/gemstash/puma.rb)
+and the rackup
+file (https://github.com/rubygems/gemstash/blob/master/lib/gemstash/config.ru)
+for inspiration.
+.PP
+While the server is not customizable, the way Gemstash binds the port
+can be changed.
+To change the binding, update the \f[CR]:bind\f[R] configuration key:
+.IP
+.EX
+# \[ti]/.gemstash/config.yml
+---
+:bind: tcp://0.0.0.0:4242
+.EE
+.PP
+This maps directly to the Puma bind
+flag (https://github.com/puma/puma#binding-tcp--sockets), and will
+support anything valid for that flag.
+.PP
+The number of threads Puma uses is also customizable via the
+\f[CR]:puma_threads\f[R] configuration key.
+The default is \f[CR]16\f[R].
+.SS Protected Fetch
+Gemstash by default allows unauthenticated access for private gems.
+Authenticated access is available via the \f[CR]:protected_fetch\f[R]
+configuration key.
+.IP
+.EX
+# \[ti]/.gemstash/config.yml
+---
+:protected_fetch: true
+.EE
+.PP
+More details on protected_fetch are here.
+.SS Fetch Timeout
+The default fetch timeout is 20 seconds.
+Use the \f[CR]:fetch_timeout\f[R] configuration key to change it.
+.IP
+.EX
+---
+:fetch_timeout: 20
+.EE
+.SS Config File Location
+By default, configuration for Gemstash will be at
+\f[CR]\[ti]/.gemstash/config.yml\f[R].
+This can be changed by providing the \f[CR]--config-file\f[R] option to
+the various Gemstash commands:
+.IP
+.EX
+$ gemstash setup --config-file ./gemstash-config.yml
+$ gemstash authorize --config-file ./gemstash-config.yml
+$ gemstash start --config-file ./gemstash-config.yml
+$ gemstash stop --config-file ./gemstash-config.yml
+$ gemstash status --config-file ./gemstash-config.yml
+.EE
+.PP
+When providing \f[CR]--config-file\f[R] to \f[CR]gemstash setup\f[R],
+the provided file will be output to with the provided configuration.
+\f[B]This will overwrite\f[R] any existing configuration.
+If the file doesn\[cq]t exist when providing \f[CR]--config-file\f[R] to
+\f[CR]gemstash start\f[R], \f[CR]gemstash stop\f[R],
+\f[CR]gemstash status\f[R], and \f[CR]gemstash authorize\f[R], the
+default configuration will be used.
+.SS ERB parsed config
+You may also create a \f[CR]\[ti]/.gemstash/config.yml.erb\f[R] file.
+If present, this will be used instead of
+\f[CR]\[ti]/.gemstash/config.yml\f[R].
+For example, with this you can use environment variables in the config:
+.IP
+.EX
+# \[ti]/.gemstash/config.yml.erb
+---
+:db_adapter: postgres
+:db_url: <%= ENV[\[dq]DATABASE_URL\[dq]] %>
+.EE

data/lib/gemstash/man/gemstash-customize.7.txt

@@ -0,0 +1,184 @@
+4mgemstash-customize24m(7)				      4mgemstash-customize24m(7)
+
+<!-- Automatically generated by Pandoc -->
+
+1mCustomizing the Server0m
+       Although  Gemstash  is designed for as minimal setup as possible, there
+       may be times you will want to change some of the default configuration.
+       By the end of this guide, you will be able to  customize  some  of  the
+       Gemstash behavior, including where files are stored, what database Gem-
+       stash uses, and how Gemstash caches certain requests.
+
+   1mSetup0m
+       Several	customizable options are available via an interactive Gemstash
+       command.  Run gemstash setup and answer the questions  it  provides  (a
+       blank answer will use the default value):
+
+	      $ gemstash setup
+	      Where should files go?  [~/.gemstash]
+	      Cache with what?	[MEMORY, memcached] 1mmemcached0m
+	      What   is   the  comma  separated  Memcached  servers?   [local-
+	      host:11211]
+	      What database adapter?  [SQLITE3, postgres, mysql, mysql2] 1mpost-0m
+	      1mgres0m
+	      Where is the database?  [postgres:///gemstash]
+	      Checking that the cache is available
+	      Checking that the database is available
+	      The database is not available
+       Once you've answered the questions, some checks will be made to	ensure
+       the configuration will work.  For example, the database didn't exist in
+       the  previous  example,	so  the  command  failed and the configuration
+       wasn't saved.  If the command passes, you may provide the --redo option
+       to force configuration to be redone:
+
+	      $ gemstash setup --redo
+	      Where should files go?  [~/.gemstash]
+	      Cache with what?	[MEMORY, memcached] 1mmemcached0m
+	      What  is	the  comma  separated  Memcached   servers?    [local-
+	      host:11211]
+	      What database adapter?  [SQLITE3, postgres, mysql, mysql2]
+	      Checking that the cache is available
+	      Checking that the database is available
+	      You are all setup!
+       Once  all  checks  have passed, Gemstash will store your answers in the
+       configuration file located at ~/.gemstash/config.yml.
+
+   1mFiles0m
+       Storage in Gemstash defaults to ~/.gemstash unless otherwise specified.
+       You can change this in your config file via the :base_path key:
+
+	      # ~/.gemstash/config.yml
+	      ---
+	      :base_path: "/var/gemstash"
+
+       When customizing the base_path, the  directory  must  exist,  otherwise
+       Gemstash will fail to run.  Thus, if you want to use /var/gemstash like
+       in the previous example, make sure to mkdir /var/gemstash and grant ac-
+       cess to the directory for the user you run Gemstash with.
+
+   1mDatabase0m
+       The  :db_adapter  configuration key specifies what database you will be
+       using.  The default :db_adapter is  sqlite3  (https://www.sqlite.org/),
+       which  will  use  a  database file located within your :base_path.  The
+       database file will always be named gemstash.db.
+
+       You  may  also	use   postgres	 (http://www.postgresql.org/),	 mysql
+       (http://www.mysql.com/),      or     mysql2     (http://sequel.jeremye-
+       vans.net/rdoc/files/doc/opening_databases_rdoc.html#label-mysql2)   for
+       your :db_adapter.  When using any of these options, you need to specify
+       the  :db_url to point to an existing database.  Here is an example con-
+       figuration to use the postgres adapter:
+
+	      # ~/.gemstash/config.yml
+	      ---
+	      :db_adapter: postgres
+	      :db_url: postgres:///gemstash
+	      :db_connection_options: # Sequel.connect options
+		:connect_timeout: 10
+		:read_timeout: 5
+		:timeout: 30
+
+       Regardless of the adapter you choose, the database  will  automatically
+       migrate	to  your  version of Gemstash whenever the database is needed.
+       You only need to ensure the database exists and Gemstash  will  do  the
+       rest, except for sqlite3 (for which Gemstash will also create the data-
+       base for you).
+
+   1mCache0m
+       Certain	things	(like dependencies) are cached in memory.  This avoids
+       web calls to the gem source, and database calls for private gems.
+
+	      # ~/.gemstash/config.yml
+	      ---
+	      :cache_type: memory
+	      :cache_max_size: 2000
+
+       This configuration uses the default memory cache, and has increased the
+       cache_max_size setting from its default of 500 items.
+
+       The memory cache  can  optionally  be  swapped  out  with  a  Memcached
+       (http://memcached.org/) server (or cluster of servers).
+
+       To use Memcached, use the memcached :cache_type configuration.
+
+       Provide the servers as a comma-separated list to the :memcached_servers
+       configuration key:
+
+	      # ~/.gemstash/config.yml
+	      ---
+	      :cache_type: memcached
+	      :memcached_servers: memcached1.local:11211,memcached2.local:11211
+	      :cache_expiration: 1800
+
+       All  caching expires in cache_expiration number of seconds.  Default is
+       1800 seconds (30 minutes).  This option applies to all caching.
+
+   1mServer0m
+       Gemstash uses Puma (http://puma.io/) and Rack  (http://rack.github.io/)
+       as  the server.	Alternate server configurations are not currently sup-
+       ported,	but  you  can  take  a	look   at   the   Puma	 configuration
+       (https://github.com/rubygems/gemstash/blob/master/lib/gemstash/puma.rb)
+       and  the  rackup  file  (https://github.com/rubygems/gemstash/blob/mas-
+       ter/lib/gemstash/config.ru) for inspiration.
+
+       While the server is not customizable, the way Gemstash binds  the  port
+       can  be changed.  To change the binding, update the :bind configuration
+       key:
+
+	      # ~/.gemstash/config.yml
+	      ---
+	      :bind: tcp://0.0.0.0:4242
+
+       This	maps	 directly     to     the      Puma	bind	  flag
+       (https://github.com/puma/puma#binding-tcp--sockets),  and  will support
+       anything valid for that flag.
+
+       The  number  of	threads  Puma  uses  is  also  customizable  via   the
+       :puma_threads configuration key.  The default is 16.
+
+   1mProtected Fetch0m
+       Gemstash  by  default  allows  unauthenticated access for private gems.
+       Authenticated access is available via the  :protected_fetch  configura-
+       tion key.
+
+	      # ~/.gemstash/config.yml
+	      ---
+	      :protected_fetch: true
+
+       More details on protected_fetch are here.
+
+   1mFetch Timeout0m
+       The  default  fetch timeout is 20 seconds.  Use the :fetch_timeout con-
+       figuration key to change it.
+
+	      ---
+	      :fetch_timeout: 20
+
+   1mConfig File Location0m
+       By default, configuration for  Gemstash	will  be  at  ~/.gemstash/con-
+       fig.yml.   This can be changed by providing the --config-file option to
+       the various Gemstash commands:
+
+	      $ gemstash setup --config-file ./gemstash-config.yml
+	      $ gemstash authorize --config-file ./gemstash-config.yml
+	      $ gemstash start --config-file ./gemstash-config.yml
+	      $ gemstash stop --config-file ./gemstash-config.yml
+	      $ gemstash status --config-file ./gemstash-config.yml
+
+       When providing --config-file to gemstash setup, the provided file  will
+       be  output to with the provided configuration.  1mThis will overwrite 22many
+       existing configuration.	If  the  file  doesn't	exist  when  providing
+       --config-file  to  gemstash  start, gemstash stop, gemstash status, and
+       gemstash authorize, the default configuration will be used.
+
+   1mERB parsed config0m
+       You may also create a  ~/.gemstash/config.yml.erb  file.   If  present,
+       this will be used instead of ~/.gemstash/config.yml.  For example, with
+       this you can use environment variables in the config:
+
+	      # ~/.gemstash/config.yml.erb
+	      ---
+	      :db_adapter: postgres
+	      :db_url: <%= ENV["DATABASE_URL"] %>
+
+			       October 28, 2015 	 4mgemstash-customize24m(7)

data/lib/gemstash/man/gemstash-debugging.7

@@ -0,0 +1,30 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.1.8
+.\"
+.TH "gemstash-debugging" "7" "October 28, 2015" "" ""
+.SH Debugging Gemstash
+If you are finding Gemstash isn\[cq]t behaving as you would expect, you
+might want to start by looking at the server log.
+You can find the log at \f[CR]server.log\f[R] within your base
+directory.
+By default, this will be at \f[CR]\[ti]/.gemstash/server.log\f[R].
+.PP
+You might find it easier to view the log directly in your terminal.
+If you run Gemstash in non-daemonized form, the log will be output
+directly to standard out:
+.IP
+.EX
+$ gemstash start --no-daemonize
+.EE
+.PP
+You can also check the status of the server:
+.IP
+.EX
+$ gemstash status
+.EE
+.PP
+The server status is checked by passing through to
+pumactl (https://github.com/puma/puma#pumactl).
+.PP
+If you find a bug, please don\[cq]t hesitate to open a bug
+report (https://github.com/rubygems/gemstash#contributing)!

data/lib/gemstash/man/gemstash-debugging.7.txt

@@ -0,0 +1,27 @@
+4mgemstash-debugging24m(7)				      4mgemstash-debugging24m(7)
+
+<!-- Automatically generated by Pandoc -->
+
+1mDebugging Gemstash0m
+       If  you	are  finding  Gemstash isn't behaving as you would expect, you
+       might want to start by looking at the server log.  You can find the log
+       at server.log within your base directory.  By default, this will be  at
+       ~/.gemstash/server.log.
+
+       You might find it easier to view the log directly in your terminal.  If
+       you  run  Gemstash  in  non-daemonized form, the log will be output di-
+       rectly to standard out:
+
+	      $ gemstash start --no-daemonize
+
+       You can also check the status of the server:
+
+	      $ gemstash status
+
+       The  server  status  is	checked  by   passing	through   to   pumactl
+       (https://github.com/puma/puma#pumactl).
+
+       If  you	find  a  bug,  please  don't  hesitate	to  open  a bug report
+       (https://github.com/rubygems/gemstash#contributing)!
+
+			       October 28, 2015 	 4mgemstash-debugging24m(7)

data/lib/gemstash/man/gemstash-deploy.7

@@ -0,0 +1,63 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.1.8
+.\"
+.TH "gemstash-deploy" "7" "October 25, 2015" "" ""
+.SH Deploying Gemstash
+Bundler is here for the rescue to keep Gemstash up to date!
+Create a \f[CR]Gemfile\f[R] pointing to Gemstash:
+.IP
+.EX
+# ./Gemfile
+source \[dq]https://rubygems.org\[dq]
+gem \[dq]gemstash\[dq]
+.EE
+.PP
+Then \f[CR]bundle\f[R] to create your \f[CR]Gemfile.lock\f[R].
+When you are ready to upgrade, simply \f[CR]bundle update\f[R].
+You may need to run \f[CR]gemstash\f[R] via \f[CR]bundle exec\f[R].
+Alternatively, you can \f[CR]gem uninstall gemstash\f[R] and
+\f[CR]gem install gemstash\f[R] when you want to upgrade.
+.PP
+Gemstash will automatically run any necessary migrations, so updating
+the gem is all that needs to be done.
+.PP
+It is probably wise to stop Gemstash before upgrading, then starting
+again once you are done:
+.IP
+.EX
+$ bundle exec gemstash stop
+$ bundle update
+$ bundle exec gemstash start
+.EE
+.SS Monitoring
+Health monitoring is built in to Gemstash using the
+server_health_check-rack (https://github.com/on-site/server_health_check-rack)
+gem.
+If you request \f[CR]/health\f[R] from your Gemstash instance, you will
+get a JSON response along with an HTTP status code indicating success or
+failure.
+The JSON response will look something like this for a success case:
+.IP
+.EX
+{
+  \[dq]status\[dq]: {
+    \[dq]heartbeat\[dq]: \[dq]OK\[dq],
+    \[dq]storage_read\[dq]: \[dq]OK\[dq],
+    \[dq]storage_write\[dq]: \[dq]OK\[dq],
+    \[dq]db_read\[dq]: \[dq]OK\[dq],
+    \[dq]db_write\[dq]: \[dq]OK\[dq]
+  }
+}
+.EE
+.PP
+This request will test storage and database access and report on the
+result.
+Each key in the status can be requested alone to just report on that
+status.
+For example, if you would like a health check that doesn\[cq]t interact
+with storage or the database, you can use \f[CR]/health/heartbeat\f[R]
+which will always respond with a success while your Gemstash server is
+running.
+.SS Downgrading
+It is not recommended to go backwards in Gemstash versions.
+Migrations may have run that could leave the database in a bad state.

data/lib/gemstash/man/gemstash-deploy.7.txt

@@ -0,0 +1,57 @@
+4mgemstash-deploy24m(7) 					 4mgemstash-deploy24m(7)
+
+<!-- Automatically generated by Pandoc -->
+
+1mDeploying Gemstash0m
+       Bundler	is  here for the rescue to keep Gemstash up to date!  Create a
+       Gemfile pointing to Gemstash:
+
+	      # ./Gemfile
+	      source "https://rubygems.org"
+	      gem "gemstash"
+
+       Then bundle to create your Gemfile.lock.  When you  are	ready  to  up-
+       grade,  simply  bundle update.  You may need to run gemstash via bundle
+       exec.  Alternatively, you can gem uninstall gemstash  and  gem  install
+       gemstash when you want to upgrade.
+
+       Gemstash  will  automatically run any necessary migrations, so updating
+       the gem is all that needs to be done.
+
+       It is probably wise to stop Gemstash before  upgrading,	then  starting
+       again once you are done:
+
+	      $ bundle exec gemstash stop
+	      $ bundle update
+	      $ bundle exec gemstash start
+
+   1mMonitoring0m
+       Health	 monitoring    is    built    in   to	Gemstash   using   the
+       server_health_check-rack 		       (https://github.com/on-
+       site/server_health_check-rack)  gem.   If you request /health from your
+       Gemstash instance, you will get a JSON response along with an HTTP sta-
+       tus code indicating success or failure.	The JSON  response  will  look
+       something like this for a success case:
+
+	      {
+		"status": {
+		  "heartbeat": "OK",
+		  "storage_read": "OK",
+		  "storage_write": "OK",
+		  "db_read": "OK",
+		  "db_write": "OK"
+		}
+	      }
+
+       This  request  will  test storage and database access and report on the
+       result.	Each key in the status can be requested alone to  just	report
+       on  that  status.   For	example, if you would like a health check that
+       doesn't	interact  with	storage  or  the   database,   you   can   use
+       /health/heartbeat  which  will always respond with a success while your
+       Gemstash server is running.
+
+   1mDowngrading0m
+       It is not recommended to go backwards in Gemstash versions.  Migrations
+       may have run that could leave the database in a bad state.
+
+			       October 25, 2015 	    4mgemstash-deploy24m(7)

data/lib/gemstash/man/gemstash-mirror.7

@@ -0,0 +1,34 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.1.8
+.\"
+.TH "gemstash-mirror" "7" "October 25, 2015" "" ""
+.SH Using Gemstash as a Mirror
+If you don\[cq]t have control over your \f[CR]Gemfile\f[R], or you
+don\[cq]t want to force everyone on your team to go through the Gemstash
+server, you can use Bundler mirroring to bundle against your Gemstash
+server.
+.PP
+For each source in your \f[CR]Gemfile\f[R], add a mirror pointing to
+your Gemstash server:
+.IP
+.EX
+$ bundle config mirror.http://rubygems.org http://localhost:9292
+$ bundle config mirror.https://my.gem-source.local http://localhost:9292/upstream/$(ruby -rcgi -e \[aq]puts CGI.escape(\[dq]https://my.gem-source.local\[dq])\[aq])
+.EE
+.PP
+From now on, bundler will fetch gems from those sources via your
+Gemstash server.
+.SH Simpler Gemstash Mirrors
+\f[B]This feature requires Bundler to be at least version
+\f[CB]1.11.0\f[B].\f[R]
+.PP
+If you are using Bundler version \f[CR]1.11.0\f[R] or greater, the
+mirroring becomes a bit easier:
+.IP
+.EX
+$ bundle config mirror.http://rubygems.org http://localhost:9292
+$ bundle config mirror.https://my.gem-source.local http://localhost:9292
+.EE
+.PP
+Bundler will then send headers to Gemstash to indicate the correct
+upstream.