<!– Automatically generated by Pandoc –> ." Automatically generated by Pandoc 3.1.8 ." .TH “gemstash-configuration” “5” “October 13, 2015” “” “” .SH Name gemstash-configuration .SH Synopsis .IP .EX # [ti]/.gemstash/config.yml
:base_path: [dq]/var/gemstash[dq] :cache_type: memcached :memcached_servers: localhost:11211 :db_adapter: postgres :db_url: postgres:///gemstash :db_connection_options:
:test: true :pool_timeout: 2
:rubygems_url: my.gem-source.local :ignore_gemfile_source: false :puma_threads: 32 :bind: tcp://0.0.0.0:4242 :protected_fetch: true :fetch_timeout: 10 :log_file: gemstash.log .EE .SH Base Path f[CR]:base_pathf .PP 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 Gemstash
server process. Specifying the f[CR]:base_pathf via f[CR]gemstash setupf will create the directory for you. .SS Default value f[CR][ti]/.gemstashf .SS Valid values Any valid path .SH Cache Type f[CR]:cache_typef .PP Specifies how to cache values other than gem files (such as gem dependencies). f[CR]memoryf[R] will use an in memory cache while f[CR]memcachedf[R] will point to 1 or more Memcached servers. Use the f[CR]:memcached_serversf configuration key for specifying where the Memcached server(s) are. .SS Default value f[CR]memoryf[R] .SS Valid values f[CR]memoryf[R], f[CR]memcachedf[R] .SH Memcached Servers f[CR]:memcached_serversf .PP Specifies the Memcached servers to connect to when using f[CR]memcachedf[R] for the f[CR]:cache_typef. Only used when f[CR]memcachedf[R] is used for f[CR]:cache_typef. .SS Default value f[CR]localhost:11211f[R] .SS Valid values A comma delimited list of Memcached servers .SH DB Adapter f[CR]:db_adapterf .PP Specifies what database adapter to use. When f[CR]sqlite3f[R] is used, the database will be located at f[CR]gemstash.dbf[R] within the directory specified by f[CR]:base_pathf. The database will automatically be created when using f[CR]sqlite3f[R]. When f[CR]postgresf[R], f[CR]mysqlf[R], or f[CR]mysql2f[R] is used, the database to connect to must be specified in the f[CR]:db_urlf configuration key. The database must already be created when using anything other than f[CR]sqlite3f[R]. .SS Default value f[CR]sqlite3f[R] .SS Valid values f[CR]sqlite3f[R], f[CR]postgresf[R], f[CR]mysqlf[R], f[CR]mysql2f[R] .SH DB URL f[CR]:db_urlf .PP Specifies the database to connect to when using f[CR]postgresf[R], f[CR]mysqlf[R], or f[CR]mysql2f[R] for the f[CR]:db_adapterf. Only used when the f[CR]:db_adapterf is not f[CR]sqlite3f[R]. .SS Default value None .SS Valid values A valid database URL for the Sequel gem (sequel.jeremyevans.net/) .SH DB Connection Options f[CR]:db_connection_optionsf .PP Specifies additional f[CR]Sequel.connectf[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_connectionsf[R] if you customize this option. .SS Default value f[CR]{ max_connections: 1 }f for f[CR]sqlite3f[R] adapter, f[CR]{ max_connections: config + 1 }f for any other adapter. .SS Valid values A valid connection options Hash for the Sequel.connect (sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options) method. .SH Rubygems URL f[CR]:rubygems_urlf .PP Specifies the default gem source URL. When any API endpoint is called without a f[CR]/privatef or f[CR]/upstream/<url>f 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.orgf[R] .SS Valid values A valid gem source URL .SH Ignore Gemfile source f[CR]:ignore_gemfile_sourcef .PP Ignore the source specified in Gemfile and always use f[CR]:rubygems_urlf as gems upstream. .SS Default value f[CR]falsef[R] .SS Valid values Boolean: f[CR]truef[R] or f[CR]falsef[R] .SH Puma Threads f[CR]:puma_threadsf .PP Specifies the number of threads used for the Gemstash
server. .SS Default value f[CR]16f[R] .SS Valid values Integer value with a minimum of f[CR]1f[R] .SH Bind Address f[CR]:bindf .PP 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 Gemstash
as the root user. .SS Default value f[CR]tcp://0.0.0.0:9292f[R] .SS Valid values Any valid binding that is supported by Puma (github.com/puma/puma#binding-tcp–sockets) .SH Protected Fetch f[CR]:protected_fetchf .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]falsef[R] .SS Valid values Boolean values f[CR]truef[R] or f[CR]falsef[R] .SH Fetch Timeout f[CR]:fetch_timeoutf .PP The timeout setting for fetching gems. 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]20f[R] seconds. .SS Default value f[CR]20f[R] .SS Valid values Integer value with a minimum of f[CR]1f[R] .SH Log File f[CR]:log_filef .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.logf[R] .SS Valid values Any valid file name, or f[CR]:stdoutf to log to f[CR]$stdoutf