gemstash 1.1.0 → 2.0.0

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

@@ -1,175 +1,66 @@
-gemstash-customize(7)					 gemstash-customize(7)
-
-
-
-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 Gem-
-       stash uses, and how Gemstash caches certain requests.
-
-   SETUP
-       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] memcached
-	      What   is   the  comma  separated  Memcached  servers?   [local-
-	      host:11211]
-	      What database adapter?  [SQLITE3, postgres, mysql, mysql2] post-
-	      gres
-	      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] memcached
-	      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.
-
-   FILES
-       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.
-
-   DATABASE
-       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).
-
-   CACHE
-       Certain	things	(like dependencies) are cached in memory.  This avoids
-       web calls to the gem source, and database calls for private gems.   The
-       memory	cache	can   optionally  be  swapped  out  with  a  Memcached
-       (http://memcached.org/) server (or cluster of servers).	 To  use  Mem-
-       cached,	you  must  update the :cache_type configuration key to be mem-
-       cached, and provide the servers via the	:memcached_servers  configura-
-       tion key:
-
-	      # ~/.gemstash/config.yml
-	      ---
-	      :cache_type: memcached
-	      :memcached_servers: memcached1.local:11211,memcached2.local:11211
-
-       Note  that  the	:memcached_servers  requires a comma separated list of
-       servers.  All caching lasts for 30 minutes.
-
-   SERVER
-       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/bundler/gemstash/blob/master/lib/gemstash/puma.rb)
-       and  the  rackup  file	(https://github.com/bundler/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.
-
-   PROTECTED FETCH
-       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  (gemstash	help  private-
-       gems.7).
-
-   FETCH TIMEOUT
-       The  default  fetch timeout is 20 seconds.  Use the :fetch_timeout con-
-       figuration key to change it.
-
-	      ---
-	      :fetch_timeout: 20
-
-   CONFIG FILE LOCATION
-       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.  This will overwrite any
-       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.
-
-   ERB PARSED CONFIG
-       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 	 gemstash-customize(7)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

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

@@ -1,29 +1,66 @@
-gemstash-debugging(7)					 gemstash-debugging(7)
 
 
 
-DEBUGGING GEMSTASH
-       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 (gemstash help start.1), the
-       log will be output directly to standard out:
 
-	      $ gemstash start --no-daemonize
 
-       You can also check the status (gemstash help status.1) 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/bundler/gemstash#contributing)!
 
 
 
-			       October 28, 2015 	 gemstash-debugging(7)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

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

@@ -1,59 +1,66 @@
-gemstash-deploy(7)					    gemstash-deploy(7)
 
 
 
-DEPLOYING GEMSTASH
-       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 bun-
-       dle exec.  Alternatively, you can  gem uninstall gemstash  and  gem in-
-       stall 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
 
-   MONITORING
-       Health	monitoring   is   built   in   to  Gemstash  using  the  serv-
-       er_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 status code indicating suc-
-       cess 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.
 
-   DOWNGRADING
-       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 	    gemstash-deploy(7)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

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

@@ -1,33 +1,66 @@
-gemstash-mirror(7)					    gemstash-mirror(7)
 
 
 
-USING GEMSTASH AS A MIRROR
-       If you don't have control over your Gemfile, or you don'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.
 
-       For each source in your Gemfile, add a mirror pointing to your Gemstash
-       server:
 
-	      $ bundle config mirror.http://rubygems.org http://localhost:9292
-	      $ bundle config mirror.https://my.gem-source.local http://localhost:9292/upstream/$(ruby -rcgi -e 'puts CGI.escape("https://my.gem-source.local")')
 
-       From now on, bundler will fetch gems from those sources via  your  Gem-
-       stash server.
 
-SIMPLER GEMSTASH MIRRORS
-       This feature requires Bundler to be at least version 1.11.0.
 
-       If  you	are using Bundler version 1.11.0 or greater, the mirroring be-
-       comes a bit easier:
 
-	      $ bundle config mirror.http://rubygems.org http://localhost:9292
-	      $ bundle config mirror.https://my.gem-source.local http://localhost:9292
 
-       Bundler will then send headers to Gemstash to indicate the correct  up-
-       stream.
 
 
 
-			       October 25, 2015 	    gemstash-mirror(7)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+