gemstash 2.1.0 → 2.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +57 -0
  3. data/lib/gemstash/cache.rb +37 -0
  4. data/lib/gemstash/cli/authorize.rb +2 -2
  5. data/lib/gemstash/cli/setup.rb +11 -3
  6. data/lib/gemstash/configuration.rb +1 -1
  7. data/lib/gemstash/dependencies.rb +2 -2
  8. data/lib/gemstash/env.rb +2 -0
  9. data/lib/gemstash/gem_fetcher.rb +2 -2
  10. data/lib/gemstash/gem_pusher.rb +2 -2
  11. data/lib/gemstash/gem_source/private_source.rb +3 -3
  12. data/lib/gemstash/gem_source.rb +2 -2
  13. data/lib/gemstash/http_client.rb +8 -3
  14. data/lib/gemstash/logging.rb +1 -1
  15. data/lib/gemstash/man/gemstash-authorize.1 +36 -21
  16. data/lib/gemstash/man/gemstash-authorize.1.txt +21 -19
  17. data/lib/gemstash/man/gemstash-configuration.5 +118 -106
  18. data/lib/gemstash/man/gemstash-configuration.5.txt +105 -103
  19. data/lib/gemstash/man/gemstash-customize.7 +83 -68
  20. data/lib/gemstash/man/gemstash-customize.7.txt +63 -62
  21. data/lib/gemstash/man/gemstash-debugging.7 +24 -9
  22. data/lib/gemstash/man/gemstash-debugging.7.txt +11 -9
  23. data/lib/gemstash/man/gemstash-deploy.7 +30 -15
  24. data/lib/gemstash/man/gemstash-deploy.7.txt +18 -16
  25. data/lib/gemstash/man/gemstash-mirror.7 +25 -10
  26. data/lib/gemstash/man/gemstash-mirror.7.txt +9 -7
  27. data/lib/gemstash/man/gemstash-multiple-sources.7 +34 -20
  28. data/lib/gemstash/man/gemstash-multiple-sources.7.txt +30 -29
  29. data/lib/gemstash/man/gemstash-private-gems.7 +55 -40
  30. data/lib/gemstash/man/gemstash-private-gems.7.txt +40 -38
  31. data/lib/gemstash/man/gemstash-readme.7 +61 -49
  32. data/lib/gemstash/man/gemstash-readme.7.txt +58 -58
  33. data/lib/gemstash/man/gemstash-setup.1 +36 -21
  34. data/lib/gemstash/man/gemstash-setup.1.txt +19 -17
  35. data/lib/gemstash/man/gemstash-start.1 +29 -14
  36. data/lib/gemstash/man/gemstash-start.1.txt +14 -12
  37. data/lib/gemstash/man/gemstash-status.1 +27 -12
  38. data/lib/gemstash/man/gemstash-status.1.txt +12 -10
  39. data/lib/gemstash/man/gemstash-stop.1 +27 -12
  40. data/lib/gemstash/man/gemstash-stop.1.txt +12 -10
  41. data/lib/gemstash/man/gemstash-version.1 +25 -10
  42. data/lib/gemstash/man/gemstash-version.1.txt +7 -5
  43. data/lib/gemstash/storage.rb +5 -4
  44. data/lib/gemstash/upstream.rb +6 -5
  45. data/lib/gemstash/version.rb +2 -2
  46. data/lib/gemstash/web.rb +6 -4
  47. data/lib/gemstash.rb +1 -1
  48. metadata +31 -157
@@ -1,16 +1,31 @@
1
- .\" Automatically generated by Pandoc 2.5
1
+ <!-- Automatically generated by Pandoc -->
2
+ .\" Automatically generated by Pandoc 3.0.1
2
3
  .\"
3
- .TH "gemstash\-configuration" "5" "October 13, 2015" "" ""
4
+ .\" Define V font for inline verbatim, using C font in formats
5
+ .\" that render this, and otherwise B font.
6
+ .ie "\f[CB]x\f[]"x" \{\
7
+ . ftr V B
8
+ . ftr VI BI
9
+ . ftr VB B
10
+ . ftr VBI BI
11
+ .\}
12
+ .el \{\
13
+ . ftr V CR
14
+ . ftr VI CI
15
+ . ftr VB CB
16
+ . ftr VBI CBI
17
+ .\}
18
+ .TH "gemstash-configuration" "5" "October 13, 2015" "" ""
4
19
  .hy
5
- .SH NAME
20
+ .SH Name
6
21
  .PP
7
- gemstash\-configuration
8
- .SH SYNOPSIS
22
+ gemstash-configuration
23
+ .SH Synopsis
9
24
  .IP
10
25
  .nf
11
26
  \f[C]
12
27
  # \[ti]/.gemstash/config.yml
13
- \-\-\-
28
+ ---
14
29
  :base_path: \[dq]/var/gemstash\[dq]
15
30
  :cache_type: memcached
16
31
  :memcached_servers: localhost:11211
@@ -19,7 +34,7 @@ gemstash\-configuration
19
34
  :db_connection_options:
20
35
  :test: true
21
36
  :pool_timeout: 2
22
- :rubygems_url: https://my.gem\-source.local
37
+ :rubygems_url: https://my.gem-source.local
23
38
  :ignore_gemfile_source: false
24
39
  :puma_threads: 32
25
40
  :bind: tcp://0.0.0.0:4242
@@ -28,9 +43,9 @@ gemstash\-configuration
28
43
  :log_file: gemstash.log
29
44
  \f[R]
30
45
  .fi
31
- .SH BASE PATH
46
+ .SH Base Path
32
47
  .PP
33
- \f[C]:base_path\f[R]
48
+ \f[V]:base_path\f[R]
34
49
  .PP
35
50
  Specifies where to store local files like the server log, cached gem
36
51
  files, and the database (when using SQLite).
@@ -38,192 +53,189 @@ If the default is being used, the directory will be created if it does
38
53
  not exist.
39
54
  Any other directory needs to be created ahead of time and be writable to
40
55
  the Gemstash server process.
41
- Specifying the \f[C]:base_path\f[R] via
42
- \f[C]gemstash setup\f[R] (gemstash help setup.1) will create the
43
- directory for you.
44
- .SS DEFAULT VALUE
56
+ Specifying the \f[V]:base_path\f[R] via \f[V]gemstash setup\f[R] will
57
+ create the directory for you.
58
+ .SS Default value
45
59
  .PP
46
- \f[C]\[ti]/.gemstash\f[R]
47
- .SS VALID VALUES
60
+ \f[V]\[ti]/.gemstash\f[R]
61
+ .SS Valid values
48
62
  .PP
49
63
  Any valid path
50
- .SH CACHE TYPE
64
+ .SH Cache Type
51
65
  .PP
52
- \f[C]:cache_type\f[R]
66
+ \f[V]:cache_type\f[R]
53
67
  .PP
54
68
  Specifies how to cache values other than gem files (such as gem
55
69
  dependencies).
56
- \f[C]memory\f[R] will use an in memory cache while \f[C]memcached\f[R]
70
+ \f[V]memory\f[R] will use an in memory cache while \f[V]memcached\f[R]
57
71
  will point to 1 or more Memcached servers.
58
- Use the \f[C]:memcached_servers\f[R] configuration key for specifying
72
+ Use the \f[V]:memcached_servers\f[R] configuration key for specifying
59
73
  where the Memcached server(s) are.
60
- .SS DEFAULT VALUE
74
+ .SS Default value
61
75
  .PP
62
- \f[C]memory\f[R]
63
- .SS VALID VALUES
76
+ \f[V]memory\f[R]
77
+ .SS Valid values
64
78
  .PP
65
- \f[C]memory\f[R], \f[C]memcached\f[R]
66
- .SH MEMCACHED SERVERS
79
+ \f[V]memory\f[R], \f[V]memcached\f[R]
80
+ .SH Memcached Servers
67
81
  .PP
68
- \f[C]:memcached_servers\f[R]
82
+ \f[V]:memcached_servers\f[R]
69
83
  .PP
70
84
  Specifies the Memcached servers to connect to when using
71
- \f[C]memcached\f[R] for the \f[C]:cache_type\f[R].
72
- Only used when \f[C]memcached\f[R] is used for \f[C]:cache_type\f[R].
73
- .SS DEFAULT VALUE
85
+ \f[V]memcached\f[R] for the \f[V]:cache_type\f[R].
86
+ Only used when \f[V]memcached\f[R] is used for \f[V]:cache_type\f[R].
87
+ .SS Default value
74
88
  .PP
75
- \f[C]localhost:11211\f[R]
76
- .SS VALID VALUES
89
+ \f[V]localhost:11211\f[R]
90
+ .SS Valid values
77
91
  .PP
78
92
  A comma delimited list of Memcached servers
79
- .SH DB ADAPTER
93
+ .SH DB Adapter
80
94
  .PP
81
- \f[C]:db_adapter\f[R]
95
+ \f[V]:db_adapter\f[R]
82
96
  .PP
83
97
  Specifies what database adapter to use.
84
- When \f[C]sqlite3\f[R] is used, the database will be located at
85
- \f[C]gemstash.db\f[R] within the directory specified by
86
- \f[C]:base_path\f[R].
87
- The database will automatically be created when using \f[C]sqlite3\f[R].
88
- When \f[C]postgres\f[R], \f[C]mysql\f[R], or \f[C]mysql2\f[R] is used,
89
- the database to connect to must be specified in the \f[C]:db_url\f[R]
98
+ When \f[V]sqlite3\f[R] is used, the database will be located at
99
+ \f[V]gemstash.db\f[R] within the directory specified by
100
+ \f[V]:base_path\f[R].
101
+ The database will automatically be created when using \f[V]sqlite3\f[R].
102
+ When \f[V]postgres\f[R], \f[V]mysql\f[R], or \f[V]mysql2\f[R] is used,
103
+ the database to connect to must be specified in the \f[V]:db_url\f[R]
90
104
  configuration key.
91
105
  The database must already be created when using anything other than
92
- \f[C]sqlite3\f[R].
93
- .SS DEFAULT VALUE
106
+ \f[V]sqlite3\f[R].
107
+ .SS Default value
94
108
  .PP
95
- \f[C]sqlite3\f[R]
96
- .SS VALID VALUES
109
+ \f[V]sqlite3\f[R]
110
+ .SS Valid values
97
111
  .PP
98
- \f[C]sqlite3\f[R], \f[C]postgres\f[R], \f[C]mysql\f[R], \f[C]mysql2\f[R]
112
+ \f[V]sqlite3\f[R], \f[V]postgres\f[R], \f[V]mysql\f[R], \f[V]mysql2\f[R]
99
113
  .SH DB URL
100
114
  .PP
101
- \f[C]:db_url\f[R]
115
+ \f[V]:db_url\f[R]
102
116
  .PP
103
- Specifies the database to connect to when using \f[C]postgres\f[R],
104
- \f[C]mysql\f[R], or \f[C]mysql2\f[R] for the \f[C]:db_adapter\f[R].
105
- Only used when the \f[C]:db_adapter\f[R] is not \f[C]sqlite3\f[R].
106
- .SS DEFAULT VALUE
117
+ Specifies the database to connect to when using \f[V]postgres\f[R],
118
+ \f[V]mysql\f[R], or \f[V]mysql2\f[R] for the \f[V]:db_adapter\f[R].
119
+ Only used when the \f[V]:db_adapter\f[R] is not \f[V]sqlite3\f[R].
120
+ .SS Default value
107
121
  .PP
108
122
  None
109
- .SS VALID VALUES
123
+ .SS Valid values
110
124
  .PP
111
125
  A valid database URL for the Sequel gem (http://sequel.jeremyevans.net/)
112
- .SH DB CONNECTION OPTIONS
126
+ .SH DB Connection Options
113
127
  .PP
114
- \f[C]:db_connection_options\f[R]
128
+ \f[V]:db_connection_options\f[R]
115
129
  .PP
116
- Specifies additional \f[C]Sequel.connect\f[R] options to use.
130
+ Specifies additional \f[V]Sequel.connect\f[R] options to use.
117
131
  Note that any options here are merged in with the default options, so
118
- you need not specify the \f[C]max_connections\f[R] if you customize this
132
+ you need not specify the \f[V]max_connections\f[R] if you customize this
119
133
  option.
120
- .SS DEFAULT VALUE
134
+ .SS Default value
121
135
  .PP
122
- \f[C]{ max_connections: 1 }\f[R] for \f[C]sqlite3\f[R] adapter,
123
- \f[C]{ max_connections: config[:puma_threads] + 1 }\f[R] for any other
136
+ \f[V]{ max_connections: 1 }\f[R] for \f[V]sqlite3\f[R] adapter,
137
+ \f[V]{ max_connections: config[:puma_threads] + 1 }\f[R] for any other
124
138
  adapter.
125
- .SS VALID VALUES
139
+ .SS Valid values
126
140
  .PP
127
141
  A valid connection options Hash for the
128
142
  Sequel.connect (http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options)
129
143
  method.
130
- .SH RUBYGEMS URL
144
+ .SH Rubygems URL
131
145
  .PP
132
- \f[C]:rubygems_url\f[R]
146
+ \f[V]:rubygems_url\f[R]
133
147
  .PP
134
148
  Specifies the default gem source URL.
135
- When any API endpoint is called without a \f[C]/private\f[R] or
136
- \f[C]/upstream/<url>\f[R] prefix, this URL will be used to fetch the
149
+ When any API endpoint is called without a \f[V]/private\f[R] or
150
+ \f[V]/upstream/<url>\f[R] prefix, this URL will be used to fetch the
137
151
  result.
138
152
  This value can be safely changed even if there are already gems stashed
139
153
  for the previous value.
140
- .SS DEFAULT VALUE
154
+ .SS Default value
141
155
  .PP
142
- \f[C]https://rubygems.org\f[R]
143
- .SS VALID VALUES
156
+ \f[V]https://rubygems.org\f[R]
157
+ .SS Valid values
144
158
  .PP
145
159
  A valid gem source URL
146
- .SH IGNORE GEMFILE SOURCE
160
+ .SH Ignore Gemfile source
147
161
  .PP
148
- \f[C]:ignore_gemfile_source\f[R]
162
+ \f[V]:ignore_gemfile_source\f[R]
149
163
  .PP
150
164
  Ignore the source specified in Gemfile and always use
151
- \f[C]:rubygems_url\f[R] as gems upstream.
152
- .SS DEFAULT VALUE
165
+ \f[V]:rubygems_url\f[R] as gems upstream.
166
+ .SS Default value
153
167
  .PP
154
- \f[C]false\f[R]
155
- .SS VALID VALUES
168
+ \f[V]false\f[R]
169
+ .SS Valid values
156
170
  .PP
157
- Boolean: \f[C]true\f[R] or \f[C]false\f[R]
158
- .SH PUMA THREADS
171
+ Boolean: \f[V]true\f[R] or \f[V]false\f[R]
172
+ .SH Puma Threads
159
173
  .PP
160
- \f[C]:puma_threads\f[R]
174
+ \f[V]:puma_threads\f[R]
161
175
  .PP
162
176
  Specifies the number of threads used for the Gemstash server.
163
- .SS DEFAULT VALUE
177
+ .SS Default value
164
178
  .PP
165
- \f[C]16\f[R]
166
- .SS VALID VALUES
179
+ \f[V]16\f[R]
180
+ .SS Valid values
167
181
  .PP
168
- Integer value with a minimum of \f[C]1\f[R]
169
- .SH BIND ADDRESS
182
+ Integer value with a minimum of \f[V]1\f[R]
183
+ .SH Bind Address
170
184
  .PP
171
- \f[C]:bind\f[R]
185
+ \f[V]:bind\f[R]
172
186
  .PP
173
187
  Specifies the binding used to start the Gemstash server.
174
188
  Keep in mind the user starting Gemstash needs to have access to bind in
175
189
  this manner.
176
190
  For example, if you use a port below 1024, you will need to run Gemstash
177
191
  as the root user.
178
- .SS DEFAULT VALUE
192
+ .SS Default value
179
193
  .PP
180
- \f[C]tcp://0.0.0.0:9292\f[R]
181
- .SS VALID VALUES
194
+ \f[V]tcp://0.0.0.0:9292\f[R]
195
+ .SS Valid values
182
196
  .PP
183
197
  Any valid binding that is supported by
184
198
  Puma (https://github.com/puma/puma#binding-tcp--sockets)
185
- .SH PROTECTED FETCH
199
+ .SH Protected Fetch
186
200
  .PP
187
- \f[C]:protected_fetch\f[R]
201
+ \f[V]:protected_fetch\f[R]
188
202
  .PP
189
203
  Tells Gemstash to authenticate via an API key before allowing the
190
204
  fetching of private gems and specs.
191
205
  The default behavior is to allow unauthenticated download of private
192
206
  gems and specs.
193
- .SS DEFAULT VALUE
207
+ .SS Default value
194
208
  .PP
195
- \f[C]false\f[R]
196
- .SS VALID VALUES
209
+ \f[V]false\f[R]
210
+ .SS Valid values
197
211
  .PP
198
- Boolean values \f[C]true\f[R] or \f[C]false\f[R]
199
- .SH FETCH TIMEOUT
212
+ Boolean values \f[V]true\f[R] or \f[V]false\f[R]
213
+ .SH Fetch Timeout
200
214
  .PP
201
- \f[C]:fetch_timeout\f[R]
215
+ \f[V]:fetch_timeout\f[R]
202
216
  .PP
203
217
  The timeout setting for fetching gems.
204
218
  Fetching gems over a slow connection may cause timeout errors.
205
219
  If you experience timeout errors, you may want to increase this value.
206
- The default is \f[C]20\f[R] seconds.
207
- .SS DEFAULT VALUE
220
+ The default is \f[V]20\f[R] seconds.
221
+ .SS Default value
208
222
  .PP
209
- \f[C]20\f[R]
210
- .SS VALID VALUES
223
+ \f[V]20\f[R]
224
+ .SS Valid values
211
225
  .PP
212
- Integer value with a minimum of \f[C]1\f[R]
213
- .SH LOG FILE
226
+ Integer value with a minimum of \f[V]1\f[R]
227
+ .SH Log File
214
228
  .PP
215
- \f[C]:log_file\f[R]
229
+ \f[V]:log_file\f[R]
216
230
  .PP
217
231
  Indicates the name of the file to use for logging.
218
- The file will be placed in the base
219
- path (gemstash help configuration.5).
220
- .SS DEFAULT VALUE
232
+ The file will be placed in the base path.
233
+ .SS Default value
221
234
  .PP
222
- \f[C]server.log\f[R]
223
- .SS VALID VALUES
235
+ \f[V]server.log\f[R]
236
+ .SS Valid values
224
237
  .PP
225
- Any valid file name, or \f[C]:stdout\f[R] to log to \f[C]$stdout\f[R]
238
+ Any valid file name, or \f[V]:stdout\f[R] to log to \f[V]$stdout\f[R]
226
239
  .PP
227
- \f[I]Note: Using \f[CI]:stdout\f[I] for the \f[CI]:log_file\f[I]
228
- requires running with
229
- \f[CI]\-\-no\-daemonize\f[I] (gemstash help start.1).\f[R]
240
+ \f[I]Note: Using \f[VI]:stdout\f[I] for the \f[VI]:log_file\f[I]
241
+ requires running with \f[VI]--no-daemonize\f[I].\f[R]
@@ -2,10 +2,12 @@ gemstash-configuration(5) gemstash-configuration(5)
2
2
 
3
3
 
4
4
 
5
- 1mNAME0m
5
+ <!-- Automatically generated by Pandoc -->
6
+
7
+ 1mName0m
6
8
  gemstash-configuration
7
9
 
8
- 1mSYNOPSIS0m
10
+ 1mSynopsis0m
9
11
  # ~/.gemstash/config.yml
10
12
  ---
11
13
  :base_path: "/var/gemstash"
@@ -24,187 +26,187 @@ gemstash-configuration(5) gemstash-configuration(5)
24
26
  :fetch_timeout: 10
25
27
  :log_file: gemstash.log
26
28
 
27
- 1mBASE PATH0m
28
- :base_path
29
+ 1mBase Path0m
30
+ 1m:base_path0m
29
31
 
30
- Specifies where to store local files like the server log, cached gem
31
- files, and the database (when using SQLite). If the default is being
32
+ Specifies where to store local files like the server log, cached gem
33
+ files, and the database (when using SQLite). If the default is being
32
34
  used, the directory will be created if it does not exist. Any other
33
35
  directory needs to be created ahead of time and be writable to the Gem-
34
- stash server process. Specifying the :base_path via gemstash setup
35
- (gemstash help setup.1) will create the directory for you.
36
+ stash server process. Specifying the 1m:base_path 22mvia 1mgemstash setup0m
37
+ will create the directory for you.
36
38
 
37
- 1mDEFAULT VALUE0m
38
- ~/.gemstash
39
+ 1mDefault value0m
40
+ 1m~/.gemstash0m
39
41
 
40
- 1mVALID VALUES0m
42
+ 1mValid values0m
41
43
  Any valid path
42
44
 
43
- 1mCACHE TYPE0m
44
- :cache_type
45
+ 1mCache Type0m
46
+ 1m:cache_type0m
45
47
 
46
48
  Specifies how to cache values other than gem files (such as gem depen-
47
- dencies). memory will use an in memory cache while memcached will
48
- point to 1 or more Memcached servers. Use the :memcached_servers con-
49
+ dencies). 1mmemory 22mwill use an in memory cache while 1mmemcached 22mwill
50
+ point to 1 or more Memcached servers. Use the 1m:memcached_servers 22mcon-
49
51
  figuration key for specifying where the Memcached server(s) are.
50
52
 
51
- 1mDEFAULT VALUE0m
52
- memory
53
+ 1mDefault value0m
54
+ 1mmemory0m
53
55
 
54
- 1mVALID VALUES0m
55
- memory, memcached
56
+ 1mValid values0m
57
+ 1mmemory22m, 1mmemcached0m
56
58
 
57
- 1mMEMCACHED SERVERS0m
58
- :memcached_servers
59
+ 1mMemcached Servers0m
60
+ 1m:memcached_servers0m
59
61
 
60
- Specifies the Memcached servers to connect to when using memcached for
61
- the :cache_type. Only used when memcached is used for :cache_type.
62
+ Specifies the Memcached servers to connect to when using 1mmemcached 22mfor
63
+ the 1m:cache_type22m. Only used when 1mmemcached 22mis used for 1m:cache_type22m.
62
64
 
63
- 1mDEFAULT VALUE0m
64
- localhost:11211
65
+ 1mDefault value0m
66
+ 1mlocalhost:112110m
65
67
 
66
- 1mVALID VALUES0m
68
+ 1mValid values0m
67
69
  A comma delimited list of Memcached servers
68
70
 
69
- 1mDB ADAPTER0m
70
- :db_adapter
71
+ 1mDB Adapter0m
72
+ 1m:db_adapter0m
71
73
 
72
- Specifies what database adapter to use. When sqlite3 is used, the
73
- database will be located at gemstash.db within the directory specified
74
- by :base_path. The database will automatically be created when using
75
- sqlite3. When postgres, mysql, or mysql2 is used, the database to con-
76
- nect to must be specified in the :db_url configuration key. The data-
77
- base must already be created when using anything other than sqlite3.
74
+ Specifies what database adapter to use. When 1msqlite3 22mis used, the
75
+ database will be located at 1mgemstash.db 22mwithin the directory specified
76
+ by 1m:base_path22m. The database will automatically be created when using
77
+ 1msqlite322m. When 1mpostgres22m, 1mmysql22m, or 1mmysql2 22mis used, the database to con-
78
+ nect to must be specified in the 1m:db_url 22mconfiguration key. The data-
79
+ base must already be created when using anything other than 1msqlite322m.
78
80
 
79
- 1mDEFAULT VALUE0m
80
- sqlite3
81
+ 1mDefault value0m
82
+ 1msqlite30m
81
83
 
82
- 1mVALID VALUES0m
83
- sqlite3, postgres, mysql, mysql2
84
+ 1mValid values0m
85
+ 1msqlite322m, 1mpostgres22m, 1mmysql22m, 1mmysql20m
84
86
 
85
87
  1mDB URL0m
86
- :db_url
88
+ 1m:db_url0m
87
89
 
88
- Specifies the database to connect to when using postgres, mysql, or
89
- mysql2 for the :db_adapter. Only used when the :db_adapter is not
90
- sqlite3.
90
+ Specifies the database to connect to when using 1mpostgres22m, 1mmysql22m, or
91
+ 1mmysql2 22mfor the 1m:db_adapter22m. Only used when the 1m:db_adapter 22mis not
92
+ 1msqlite322m.
91
93
 
92
- 1mDEFAULT VALUE0m
94
+ 1mDefault value0m
93
95
  None
94
96
 
95
- 1mVALID VALUES0m
96
- A valid database URL for the Sequel gem (http://sequel.jeremye-
97
+ 1mValid values0m
98
+ A valid database URL for the Sequel gem (http://sequel.jeremye-
97
99
  vans.net/)
98
100
 
99
- 1mDB CONNECTION OPTIONS0m
100
- :db_connection_options
101
+ 1mDB Connection Options0m
102
+ 1m:db_connection_options0m
101
103
 
102
- Specifies additional Sequel.connect options to use. Note that any op-
103
- tions here are merged in with the default options, so you need not
104
- specify the max_connections if you customize this option.
104
+ Specifies additional 1mSequel.connect 22moptions to use. Note that any op-
105
+ tions here are merged in with the default options, so you need not
106
+ specify the 1mmax_connections 22mif you customize this option.
105
107
 
106
- 1mDEFAULT VALUE0m
107
- { max_connections: 1 } for sqlite3 adapter, { max_connections: con-
108
- fig[:puma_threads] + 1 } for any other adapter.
108
+ 1mDefault value0m
109
+ 1m{ max_connections: 1 } 22mfor 1msqlite3 22madapter, 1m{ max_connections: con-0m
110
+ 1mfig[:puma_threads] + 1 } 22mfor any other adapter.
109
111
 
110
- 1mVALID VALUES0m
111
- A valid connection options Hash for the Sequel.connect (http://se-
112
+ 1mValid values0m
113
+ A valid connection options Hash for the Sequel.connect (http://se-
112
114
  quel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-
113
115
  General+connection+options) method.
114
116
 
115
- 1mRUBYGEMS URL0m
116
- :rubygems_url
117
+ 1mRubygems URL0m
118
+ 1m:rubygems_url0m
117
119
 
118
120
  Specifies the default gem source URL. When any API endpoint is called
119
- without a /private or /upstream/<url> prefix, this URL will be used to
121
+ without a 1m/private 22mor 1m/upstream/<url> 22mprefix, this URL will be used to
120
122
  fetch the result. This value can be safely changed even if there are
121
123
  already gems stashed for the previous value.
122
124
 
123
- 1mDEFAULT VALUE0m
124
- https://rubygems.org
125
+ 1mDefault value0m
126
+ 1mhttps://rubygems.org0m
125
127
 
126
- 1mVALID VALUES0m
128
+ 1mValid values0m
127
129
  A valid gem source URL
128
130
 
129
- 1mIGNORE GEMFILE SOURCE0m
130
- :ignore_gemfile_source
131
+ 1mIgnore Gemfile source0m
132
+ 1m:ignore_gemfile_source0m
131
133
 
132
- Ignore the source specified in Gemfile and always use :rubygems_url as
134
+ Ignore the source specified in Gemfile and always use 1m:rubygems_url 22mas
133
135
  gems upstream.
134
136
 
135
- 1mDEFAULT VALUE0m
136
- false
137
+ 1mDefault value0m
138
+ 1mfalse0m
137
139
 
138
- 1mVALID VALUES0m
139
- Boolean: true or false
140
+ 1mValid values0m
141
+ Boolean: 1mtrue 22mor 1mfalse0m
140
142
 
141
- 1mPUMA THREADS0m
142
- :puma_threads
143
+ 1mPuma Threads0m
144
+ 1m:puma_threads0m
143
145
 
144
146
  Specifies the number of threads used for the Gemstash server.
145
147
 
146
- 1mDEFAULT VALUE0m
147
- 16
148
+ 1mDefault value0m
149
+ 1m160m
148
150
 
149
- 1mVALID VALUES0m
150
- Integer value with a minimum of 1
151
+ 1mValid values0m
152
+ Integer value with a minimum of 1m10m
151
153
 
152
- 1mBIND ADDRESS0m
153
- :bind
154
+ 1mBind Address0m
155
+ 1m:bind0m
154
156
 
155
157
  Specifies the binding used to start the Gemstash server. Keep in mind
156
158
  the user starting Gemstash needs to have access to bind in this manner.
157
159
  For example, if you use a port below 1024, you will need to run Gem-
158
160
  stash as the root user.
159
161
 
160
- 1mDEFAULT VALUE0m
161
- tcp://0.0.0.0:9292
162
+ 1mDefault value0m
163
+ 1mtcp://0.0.0.0:92920m
162
164
 
163
- 1mVALID VALUES0m
165
+ 1mValid values0m
164
166
  Any valid binding that is supported by Puma
165
167
  (https://github.com/puma/puma#binding-tcp--sockets)
166
168
 
167
- 1mPROTECTED FETCH0m
168
- :protected_fetch
169
+ 1mProtected Fetch0m
170
+ 1m:protected_fetch0m
169
171
 
170
172
  Tells Gemstash to authenticate via an API key before allowing the
171
- fetching of private gems and specs. The default behavior is to allow
173
+ fetching of private gems and specs. The default behavior is to allow
172
174
  unauthenticated download of private gems and specs.
173
175
 
174
- 1mDEFAULT VALUE0m
175
- false
176
+ 1mDefault value0m
177
+ 1mfalse0m
176
178
 
177
- 1mVALID VALUES0m
178
- Boolean values true or false
179
+ 1mValid values0m
180
+ Boolean values 1mtrue 22mor 1mfalse0m
179
181
 
180
- 1mFETCH TIMEOUT0m
181
- :fetch_timeout
182
+ 1mFetch Timeout0m
183
+ 1m:fetch_timeout0m
182
184
 
183
185
  The timeout setting for fetching gems. Fetching gems over a slow con-
184
186
  nection may cause timeout errors. If you experience timeout errors,
185
- you may want to increase this value. The default is 20 seconds.
187
+ you may want to increase this value. The default is 1m20 22mseconds.
186
188
 
187
- 1mDEFAULT VALUE0m
188
- 20
189
+ 1mDefault value0m
190
+ 1m200m
189
191
 
190
- 1mVALID VALUES0m
191
- Integer value with a minimum of 1
192
+ 1mValid values0m
193
+ Integer value with a minimum of 1m10m
192
194
 
193
- 1mLOG FILE0m
194
- :log_file
195
+ 1mLog File0m
196
+ 1m:log_file0m
195
197
 
196
198
  Indicates the name of the file to use for logging. The file will be
197
- placed in the base path (gemstash help configuration.5).
199
+ placed in the base path.
198
200
 
199
- 1mDEFAULT VALUE0m
200
- server.log
201
+ 1mDefault value0m
202
+ 1mserver.log0m
201
203
 
202
- 1mVALID VALUES0m
203
- Any valid file name, or :stdout to log to $stdout
204
+ 1mValid values0m
205
+ Any valid file name, or 1m:stdout 22mto log to 1m$stdout0m
204
206
 
205
- 4mNote:24m 4mUsing24m 4m:stdout24m 4mfor24m 4mthe24m 4m:log_file24m 4mrequires24m 4mrunning24m 4mwith24m 4m--no-daemo-0m
206
- 4mnize24m 4m(gemstash24m 4mhelp24m 4mstart.1).0m
207
+ 4mNote:24m 4mUsing24m 4m1m:stdout24m 4m22mfor24m 4mthe24m 4m1m:log_file24m 4m22mrequires24m 4mrunning24m 4mwith24m 4m1m--no-daemo-0m
208
+ 4m1mnize22m.0m
207
209
 
208
210
 
209
211
 
210
- October 13, 2015 gemstash-configuration(5)
212
+ October 13, 2015 gemstash-configuration(5)