gemstash 2.2.2 → 2.7.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +61 -17
- data/lib/gemstash/authorization.rb +5 -2
- data/lib/gemstash/cli/authorize.rb +42 -1
- data/lib/gemstash/cli/setup.rb +2 -2
- data/lib/gemstash/cli/start.rb +5 -25
- data/lib/gemstash/cli.rb +6 -2
- data/lib/gemstash/config.ru +0 -2
- data/lib/gemstash/configuration.rb +5 -0
- data/lib/gemstash/db/authorization.rb +3 -3
- data/lib/gemstash/env.rb +0 -11
- data/lib/gemstash/gem_source/upstream_source.rb +15 -0
- data/lib/gemstash/logging.rb +14 -2
- data/lib/gemstash/man/gemstash-authorize.1 +21 -33
- data/lib/gemstash/man/gemstash-authorize.1.txt +20 -16
- data/lib/gemstash/man/gemstash-configuration.5 +61 -119
- data/lib/gemstash/man/gemstash-configuration.5.txt +58 -65
- data/lib/gemstash/man/gemstash-customize.7 +60 -103
- data/lib/gemstash/man/gemstash-customize.7.txt +52 -56
- data/lib/gemstash/man/gemstash-debugging.7 +11 -31
- data/lib/gemstash/man/gemstash-debugging.7.txt +8 -13
- data/lib/gemstash/man/gemstash-deploy.7 +15 -39
- data/lib/gemstash/man/gemstash-deploy.7.txt +18 -22
- data/lib/gemstash/man/gemstash-mirror.7 +10 -31
- data/lib/gemstash/man/gemstash-mirror.7.txt +6 -10
- data/lib/gemstash/man/gemstash-multiple-sources.7 +72 -44
- data/lib/gemstash/man/gemstash-multiple-sources.7.txt +66 -22
- data/lib/gemstash/man/gemstash-private-gems.7 +51 -102
- data/lib/gemstash/man/gemstash-private-gems.7.txt +35 -39
- data/lib/gemstash/man/gemstash-readme.7 +42 -88
- data/lib/gemstash/man/gemstash-readme.7.txt +43 -48
- data/lib/gemstash/man/gemstash-setup.1 +13 -33
- data/lib/gemstash/man/gemstash-setup.1.txt +13 -17
- data/lib/gemstash/man/gemstash-start.1 +5 -29
- data/lib/gemstash/man/gemstash-start.1.txt +6 -14
- data/lib/gemstash/man/gemstash-status.1 +5 -23
- data/lib/gemstash/man/gemstash-status.1.txt +6 -10
- data/lib/gemstash/man/gemstash-stop.1 +5 -23
- data/lib/gemstash/man/gemstash-stop.1.txt +6 -10
- data/lib/gemstash/man/gemstash-version.1 +4 -24
- data/lib/gemstash/man/gemstash-version.1.txt +3 -7
- data/lib/gemstash/migrations/05_authorization_names.rb +10 -0
- data/lib/gemstash/upstream.rb +33 -2
- data/lib/gemstash/version.rb +1 -1
- data/lib/gemstash.rb +1 -0
- metadata +35 -14
@@ -1,29 +1,13 @@
|
|
1
1
|
<!-- Automatically generated by Pandoc -->
|
2
|
-
.\" Automatically generated by Pandoc 3.1
|
2
|
+
.\" Automatically generated by Pandoc 3.1.8
|
3
3
|
.\"
|
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
4
|
.TH "gemstash-readme" "7" "November 30, 2015" "" ""
|
19
|
-
.hy
|
20
5
|
.SH Gemstash
|
21
6
|
.SS What is Gemstash?
|
22
|
-
.PP
|
23
7
|
Gemstash is both a cache for remote servers such as
|
24
8
|
https://rubygems.org, and a private gem source.
|
25
9
|
.PP
|
26
|
-
If you are using bundler (
|
10
|
+
If you are using bundler (https://bundler.io/) across many machines that
|
27
11
|
have access to a server within your control, you might want to use
|
28
12
|
Gemstash.
|
29
13
|
.PP
|
@@ -38,16 +22,15 @@ the same gems frequently?
|
|
38
22
|
Well, maybe you don\[cq]t need Gemstash\&...
|
39
23
|
yet.
|
40
24
|
.PP
|
41
|
-
Gemstash is maintained by Ruby
|
42
|
-
|
43
|
-
|
44
|
-
Contribute today as an individual
|
45
|
-
|
46
|
-
|
47
|
-
|
25
|
+
Gemstash is maintained by Ruby Central (https://rubycentral.org/), a
|
26
|
+
non-profit committed to supporting the critical Ruby infrastructure you
|
27
|
+
rely on.
|
28
|
+
Contribute today as an individual, or even better, as a
|
29
|
+
company (https://rubycentral.org/#/portal/signup), and ensure that
|
30
|
+
Bundler, RubyGems, Gemstash, and other shared tooling is around for
|
31
|
+
years to come.
|
48
32
|
.SS Quickstart Guide
|
49
33
|
.SS Setup
|
50
|
-
.PP
|
51
34
|
Gemstash is designed to be quick and painless to get set up.
|
52
35
|
By the end of this Quickstart Guide, you will be able to bundle stashed
|
53
36
|
gems from public sources against a Gemstash server running on your
|
@@ -55,56 +38,45 @@ machine.
|
|
55
38
|
.PP
|
56
39
|
Install Gemstash to get started:
|
57
40
|
.IP
|
58
|
-
.
|
59
|
-
\f[C]
|
41
|
+
.EX
|
60
42
|
$ gem install gemstash
|
61
|
-
|
62
|
-
.fi
|
43
|
+
.EE
|
63
44
|
.PP
|
64
45
|
After it is installed, starting Gemstash requires no additional steps.
|
65
|
-
Simply start the Gemstash server with the \f[
|
46
|
+
Simply start the Gemstash server with the \f[CR]gemstash\f[R] command:
|
66
47
|
.IP
|
67
|
-
.
|
68
|
-
\f[C]
|
48
|
+
.EX
|
69
49
|
$ gemstash start
|
70
|
-
|
71
|
-
.fi
|
50
|
+
.EE
|
72
51
|
.PP
|
73
52
|
You may have noticed that the command finished quickly.
|
74
53
|
This is because Gemstash will run the server in the background by
|
75
54
|
default.
|
76
55
|
The server runs on port 9292.
|
77
56
|
.SS Bundling
|
78
|
-
.PP
|
79
57
|
With the server running, you can bundle against it.
|
80
58
|
Tell Bundler that you want to use Gemstash to find gems from
|
81
59
|
RubyGems.org:
|
82
60
|
.IP
|
83
|
-
.
|
84
|
-
\f[C]
|
61
|
+
.EX
|
85
62
|
$ bundle config mirror.https://rubygems.org http://localhost:9292
|
86
|
-
|
87
|
-
.fi
|
63
|
+
.EE
|
88
64
|
.PP
|
89
65
|
Now you can create a Gemfile and install gems through Gemstash:
|
90
66
|
.IP
|
91
|
-
.
|
92
|
-
\f[C]
|
67
|
+
.EX
|
93
68
|
# ./Gemfile
|
94
69
|
source \[dq]https://rubygems.org\[dq]
|
95
70
|
gem \[dq]rubywarrior\[dq]
|
96
|
-
|
97
|
-
.fi
|
71
|
+
.EE
|
98
72
|
.PP
|
99
73
|
The gems you include should be gems you don\[cq]t yet have installed,
|
100
74
|
otherwise Gemstash will have nothing to stash.
|
101
75
|
Now bundle:
|
102
76
|
.IP
|
103
|
-
.
|
104
|
-
\f[C]
|
77
|
+
.EX
|
105
78
|
$ bundle install --path .bundle
|
106
|
-
|
107
|
-
.fi
|
79
|
+
.EE
|
108
80
|
.PP
|
109
81
|
Your Gemstash server has fetched the gems from https://rubygems.org and
|
110
82
|
cached them for you!
|
@@ -114,65 +86,52 @@ Gem dependencies metadata are cached for 30 minutes, so if you bundle
|
|
114
86
|
again before that, you can successfully bundle without an Internet
|
115
87
|
connection:
|
116
88
|
.IP
|
117
|
-
.
|
118
|
-
\f[C]
|
89
|
+
.EX
|
119
90
|
$ # Disable your Internet first!
|
120
91
|
$ rm -rf Gemfile.lock .bundle
|
121
92
|
$ bundle
|
122
|
-
|
123
|
-
.fi
|
93
|
+
.EE
|
124
94
|
.SS Falling back to rubygems.org
|
125
|
-
.PP
|
126
95
|
If you want to make sure that your bundling from https://rubygems.org
|
127
96
|
still works as expected when the Gemstash server is not running, you can
|
128
97
|
easily configure Bundler to fallback to https://rubygems.org.
|
129
98
|
.IP
|
130
|
-
.
|
131
|
-
\f[C]
|
99
|
+
.EX
|
132
100
|
$ bundle config mirror.https://rubygems.org.fallback_timeout true
|
133
|
-
|
134
|
-
.fi
|
101
|
+
.EE
|
135
102
|
.PP
|
136
103
|
You can also configure this fallback as a number of seconds in case the
|
137
104
|
Gemstash server is simply unresponsive.
|
138
105
|
This example uses a 3 second timeout:
|
139
106
|
.IP
|
140
|
-
.
|
141
|
-
\f[C]
|
107
|
+
.EX
|
142
108
|
$ bundle config mirror.https://rubygems.org.fallback_timeout 3
|
143
|
-
|
144
|
-
.fi
|
109
|
+
.EE
|
145
110
|
.SS Stopping the Server
|
146
|
-
.PP
|
147
111
|
Once you\[cq]ve finish using your Gemstash server, you can stop it just
|
148
112
|
as easily as you started it:
|
149
113
|
.IP
|
150
|
-
.
|
151
|
-
\f[C]
|
114
|
+
.EX
|
152
115
|
$ gemstash stop
|
153
|
-
|
154
|
-
.fi
|
116
|
+
.EE
|
155
117
|
.PP
|
156
118
|
You\[cq]ll also want to tell Bundler that it can go back to getting gems
|
157
119
|
from RubyGems.org directly, instead of going through Gemstash:
|
158
120
|
.IP
|
159
|
-
.
|
160
|
-
\f[C]
|
121
|
+
.EX
|
161
122
|
$ bundle config --delete mirror.https://rubygems.org
|
162
|
-
|
163
|
-
.fi
|
123
|
+
.EE
|
164
124
|
.SS Under the Hood
|
165
|
-
.PP
|
166
125
|
You might wonder where the gems are stored.
|
167
126
|
After running the commands above, you will find a new directory at
|
168
|
-
\f[
|
127
|
+
\f[CR]\[ti]/.gemstash\f[R].
|
169
128
|
This directory holds all the cached and private gems.
|
170
129
|
It also has a server log, the database, and configuration for Gemstash.
|
171
130
|
If you prefer, you can point to a different directory.
|
172
131
|
.PP
|
173
132
|
Gemstash uses SQLite (https://www.sqlite.org/) to store details about
|
174
133
|
private gems.
|
175
|
-
The database will be located in \f[
|
134
|
+
The database will be located in \f[CR]\[ti]/.gemstash\f[R], however you
|
176
135
|
won\[cq]t see the database appear until you start using private gems.
|
177
136
|
If you prefer, you can use a different database.
|
178
137
|
.PP
|
@@ -181,14 +140,13 @@ Anything cached in memory will last for 30 minutes before being
|
|
181
140
|
retrieved again.
|
182
141
|
You can use memcached instead of caching in memory.
|
183
142
|
Gem files are always cached permanently, so bundling with a
|
184
|
-
\f[
|
143
|
+
\f[CR]Gemfile.lock\f[R] with all gems cached will never call out to
|
185
144
|
https://rubygems.org.
|
186
145
|
.PP
|
187
|
-
The server you ran is provided via Puma (
|
188
|
-
Rack (
|
189
|
-
point.
|
146
|
+
The server you ran is provided via Puma (https://puma.io/) and
|
147
|
+
Rack (https://github.com/rack/rack), however they are not customizable
|
148
|
+
at this point.
|
190
149
|
.SS Deep Dive
|
191
|
-
.PP
|
192
150
|
Deep dive into more subjects:
|
193
151
|
.IP \[bu] 2
|
194
152
|
Private gems
|
@@ -203,7 +161,6 @@ Deploying Gemstash
|
|
203
161
|
.IP \[bu] 2
|
204
162
|
Debugging Gemstash
|
205
163
|
.SS Reference
|
206
|
-
.PP
|
207
164
|
An anatomy of various configuration and commands:
|
208
165
|
.IP \[bu] 2
|
209
166
|
Configuration
|
@@ -221,25 +178,22 @@ Setup
|
|
221
178
|
Version
|
222
179
|
.PP
|
223
180
|
To see what has changed in recent versions of Gemstash, see the
|
224
|
-
CHANGELOG (https://github.com/rubygems/gemstash/blob/
|
181
|
+
CHANGELOG (https://github.com/rubygems/gemstash/blob/main/CHANGELOG.md).
|
225
182
|
.SS Development
|
226
|
-
|
227
|
-
After checking out the repo, run \f[V]bin/setup\f[R] to install
|
183
|
+
After checking out the repo, run \f[CR]bin/setup\f[R] to install
|
228
184
|
dependencies.
|
229
|
-
Then, run \f[
|
230
|
-
While developing, you can run \f[
|
231
|
-
You can also run \f[
|
185
|
+
Then, run \f[CR]rake\f[R] to run RuboCop and the tests.
|
186
|
+
While developing, you can run \f[CR]bin/gemstash\f[R] to run Gemstash.
|
187
|
+
You can also run \f[CR]bin/console\f[R] for an interactive prompt that
|
232
188
|
will allow you to experiment.
|
233
189
|
.SS Contributing
|
234
|
-
.PP
|
235
190
|
Bug reports and pull requests are welcome on GitHub at
|
236
191
|
https://github.com/rubygems/gemstash.
|
237
192
|
This project is intended to be a safe, welcoming space for
|
238
193
|
collaboration, and contributors are expected to adhere to the
|
239
194
|
Contributor
|
240
|
-
Covenant (https://github.com/rubygems/gemstash/blob/
|
195
|
+
Covenant (https://github.com/rubygems/gemstash/blob/main/CODE_OF_CONDUCT.md)
|
241
196
|
code of conduct.
|
242
197
|
.SS License
|
243
|
-
.PP
|
244
198
|
The gem is available as open source under the terms of the MIT
|
245
199
|
License (http://opensource.org/licenses/MIT).
|
@@ -1,6 +1,4 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
1
|
+
4mgemstash-readme24m(7) 4mgemstash-readme24m(7)
|
4
2
|
|
5
3
|
<!-- Automatically generated by Pandoc -->
|
6
4
|
|
@@ -9,11 +7,11 @@ gemstash-readme(7) gemstash-readme(7)
|
|
9
7
|
Gemstash is both a cache for remote servers such as
|
10
8
|
https://rubygems.org, and a private gem source.
|
11
9
|
|
12
|
-
If you are using bundler
|
13
|
-
have access to a server within your control, you might want to use
|
14
|
-
|
10
|
+
If you are using bundler (https://bundler.io/) across many machines
|
11
|
+
that have access to a server within your control, you might want to use
|
12
|
+
Gemstash.
|
15
13
|
|
16
|
-
If
|
14
|
+
If you produce gems that you don't want everyone in the world to have
|
17
15
|
access to, you might want to use Gemstash.
|
18
16
|
|
19
17
|
If you frequently bundle the same set of gems across multiple projects,
|
@@ -22,35 +20,34 @@ gemstash-readme(7) gemstash-readme(7)
|
|
22
20
|
Are you only using gems from https://rubygems.org, and don't bundle the
|
23
21
|
same gems frequently? Well, maybe you don't need Gemstash... yet.
|
24
22
|
|
25
|
-
Gemstash
|
26
|
-
|
27
|
-
|
28
|
-
(https://
|
29
|
-
|
30
|
-
|
31
|
-
come.
|
23
|
+
Gemstash is maintained by Ruby Central (https://rubycentral.org/), a
|
24
|
+
non-profit committed to supporting the critical Ruby infrastructure you
|
25
|
+
rely on. Contribute today as an individual, or even better, as a com-
|
26
|
+
pany (https://rubycentral.org/#/portal/signup), and ensure that
|
27
|
+
Bundler, RubyGems, Gemstash, and other shared tooling is around for
|
28
|
+
years to come.
|
32
29
|
|
33
30
|
1mQuickstart Guide0m
|
34
31
|
1mSetup0m
|
35
|
-
Gemstash
|
36
|
-
end
|
32
|
+
Gemstash is designed to be quick and painless to get set up. By the
|
33
|
+
end of this Quickstart Guide, you will be able to bundle stashed gems
|
37
34
|
from public sources against a Gemstash server running on your machine.
|
38
35
|
|
39
36
|
Install Gemstash to get started:
|
40
37
|
|
41
38
|
$ gem install gemstash
|
42
39
|
|
43
|
-
After
|
44
|
-
Simply start the Gemstash server with the
|
40
|
+
After it is installed, starting Gemstash requires no additional steps.
|
41
|
+
Simply start the Gemstash server with the gemstash command:
|
45
42
|
|
46
43
|
$ gemstash start
|
47
44
|
|
48
|
-
You
|
49
|
-
cause
|
45
|
+
You may have noticed that the command finished quickly. This is be-
|
46
|
+
cause Gemstash will run the server in the background by default. The
|
50
47
|
server runs on port 9292.
|
51
48
|
|
52
49
|
1mBundling0m
|
53
|
-
With
|
50
|
+
With the server running, you can bundle against it. Tell Bundler that
|
54
51
|
you want to use Gemstash to find gems from RubyGems.org:
|
55
52
|
|
56
53
|
$ bundle config mirror.https://rubygems.org http://localhost:9292
|
@@ -61,7 +58,7 @@ gemstash-readme(7) gemstash-readme(7)
|
|
61
58
|
source "https://rubygems.org"
|
62
59
|
gem "rubywarrior"
|
63
60
|
|
64
|
-
The
|
61
|
+
The gems you include should be gems you don't yet have installed, oth-
|
65
62
|
erwise Gemstash will have nothing to stash. Now bundle:
|
66
63
|
|
67
64
|
$ bundle install --path .bundle
|
@@ -70,7 +67,7 @@ gemstash-readme(7) gemstash-readme(7)
|
|
70
67
|
cached them for you! To prove this, you can disable your Internet con-
|
71
68
|
nection and try again. Gem files (*.gem) are cached indefinitely. Gem
|
72
69
|
dependencies metadata are cached for 30 minutes, so if you bundle again
|
73
|
-
before
|
70
|
+
before that, you can successfully bundle without an Internet connec-
|
74
71
|
tion:
|
75
72
|
|
76
73
|
$ # Disable your Internet first!
|
@@ -78,8 +75,8 @@ gemstash-readme(7) gemstash-readme(7)
|
|
78
75
|
$ bundle
|
79
76
|
|
80
77
|
1mFalling back to rubygems.org0m
|
81
|
-
If
|
82
|
-
still
|
78
|
+
If you want to make sure that your bundling from https://rubygems.org
|
79
|
+
still works as expected when the Gemstash server is not running, you
|
83
80
|
can easily configure Bundler to fallback to https://rubygems.org.
|
84
81
|
|
85
82
|
$ bundle config mirror.https://rubygems.org.fallback_timeout true
|
@@ -103,26 +100,26 @@ gemstash-readme(7) gemstash-readme(7)
|
|
103
100
|
|
104
101
|
1mUnder the Hood0m
|
105
102
|
You might wonder where the gems are stored. After running the commands
|
106
|
-
above,
|
107
|
-
holds
|
103
|
+
above, you will find a new directory at ~/.gemstash. This directory
|
104
|
+
holds all the cached and private gems. It also has a server log, the
|
108
105
|
database, and configuration for Gemstash. If you prefer, you can point
|
109
106
|
to a different directory.
|
110
107
|
|
111
108
|
Gemstash uses SQLite (https://www.sqlite.org/) to store details about
|
112
|
-
private gems. The database will be located in
|
113
|
-
won't
|
109
|
+
private gems. The database will be located in ~/.gemstash, however you
|
110
|
+
won't see the database appear until you start using private gems. If
|
114
111
|
you prefer, you can use a different database.
|
115
112
|
|
116
|
-
Gemstash
|
117
|
-
Anything
|
118
|
-
trieved
|
119
|
-
Gem
|
120
|
-
|
113
|
+
Gemstash temporarily caches things like gem dependencies in memory.
|
114
|
+
Anything cached in memory will last for 30 minutes before being re-
|
115
|
+
trieved again. You can use memcached instead of caching in memory.
|
116
|
+
Gem files are always cached permanently, so bundling with a Gem-
|
117
|
+
file.lock with all gems cached will never call out to
|
121
118
|
https://rubygems.org.
|
122
119
|
|
123
|
-
The
|
124
|
-
(
|
125
|
-
point.
|
120
|
+
The server you ran is provided via Puma (https://puma.io/) and Rack
|
121
|
+
(https://github.com/rack/rack), however they are not customizable at
|
122
|
+
this point.
|
126
123
|
|
127
124
|
1mDeep Dive0m
|
128
125
|
Deep dive into more subjects:
|
@@ -156,27 +153,25 @@ gemstash-readme(7) gemstash-readme(7)
|
|
156
153
|
|
157
154
|
o Version
|
158
155
|
|
159
|
-
To
|
160
|
-
CHANGELOG
|
161
|
-
|
156
|
+
To see what has changed in recent versions of Gemstash, see the
|
157
|
+
CHANGELOG (https://github.com/rubygems/gem-
|
158
|
+
stash/blob/main/CHANGELOG.md).
|
162
159
|
|
163
160
|
1mDevelopment0m
|
164
|
-
After
|
165
|
-
Then, run
|
166
|
-
run
|
161
|
+
After checking out the repo, run bin/setup to install dependencies.
|
162
|
+
Then, run rake to run RuboCop and the tests. While developing, you can
|
163
|
+
run bin/gemstash to run Gemstash. You can also run bin/console for an
|
167
164
|
interactive prompt that will allow you to experiment.
|
168
165
|
|
169
166
|
1mContributing0m
|
170
167
|
Bug reports and pull requests are welcome on GitHub at
|
171
168
|
https://github.com/rubygems/gemstash. This project is intended to be a
|
172
|
-
safe,
|
169
|
+
safe, welcoming space for collaboration, and contributors are expected
|
173
170
|
to adhere to the Contributor Covenant (https://github.com/rubygems/gem-
|
174
|
-
stash/blob/
|
171
|
+
stash/blob/main/CODE_OF_CONDUCT.md) code of conduct.
|
175
172
|
|
176
173
|
1mLicense0m
|
177
174
|
The gem is available as open source under the terms of the MIT License
|
178
175
|
(http://opensource.org/licenses/MIT).
|
179
176
|
|
180
|
-
|
181
|
-
|
182
|
-
November 30, 2015 gemstash-readme(7)
|
177
|
+
November 30, 2015 4mgemstash-readme24m(7)
|
@@ -1,58 +1,38 @@
|
|
1
1
|
<!-- Automatically generated by Pandoc -->
|
2
|
-
.\" Automatically generated by Pandoc 3.1
|
2
|
+
.\" Automatically generated by Pandoc 3.1.8
|
3
3
|
.\"
|
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
4
|
.TH "gemstash-setup" "1" "October 9, 2015" "" ""
|
19
|
-
.hy
|
20
5
|
.SH Name
|
21
|
-
.PP
|
22
6
|
gemstash-setup - Customize your Gemstash configuration interactively
|
23
7
|
.SH Synopsis
|
24
|
-
|
25
|
-
\f[V]gemstash setup [--redo] [--debug] [--config-file FILE]\f[R]
|
8
|
+
\f[CR]gemstash setup [--redo] [--debug] [--config-file FILE]\f[R]
|
26
9
|
.SH Description
|
27
|
-
.PP
|
28
10
|
Customize your Gemstash configuration interactively.
|
29
11
|
This will save your config file, but only if a few checks pass after
|
30
12
|
you\[cq]ve provided your answers.
|
31
13
|
.SS Usage
|
32
14
|
.IP
|
33
|
-
.
|
34
|
-
\f[C]
|
15
|
+
.EX
|
35
16
|
gemstash setup
|
36
17
|
gemstash setup --redo
|
37
18
|
gemstash setup --config-file <file>
|
38
|
-
|
39
|
-
.fi
|
19
|
+
.EE
|
40
20
|
.SH Options
|
41
21
|
.IP \[bu] 2
|
42
|
-
\f[
|
43
|
-
This does nothing the first time \f[
|
44
|
-
If you want to change your configuration using \f[
|
22
|
+
\f[CR]--redo\f[R]: Redo the configuration.
|
23
|
+
This does nothing the first time \f[CR]gemstash setup\f[R] is run.
|
24
|
+
If you want to change your configuration using \f[CR]gemstash setup\f[R]
|
45
25
|
after you\[cq]ve run it before, you must provide this option, otherwise
|
46
26
|
Gemstash will simply indicate your setup is complete.
|
47
27
|
.IP \[bu] 2
|
48
|
-
\f[
|
49
|
-
the end of setup fails.
|
28
|
+
\f[CR]--debug\f[R]: Output additional information if one of the checks
|
29
|
+
at the end of setup fails.
|
50
30
|
This will do nothing if all checks pass.
|
51
31
|
.IP \[bu] 2
|
52
|
-
\f[
|
32
|
+
\f[CR]--config-file FILE\f[R]: Specify the config file to write to.
|
53
33
|
Without this option, your configuration will be written to
|
54
|
-
\f[
|
34
|
+
\f[CR]\[ti]/.gemstash/config.yml\f[R].
|
55
35
|
If you write to a custom location, you will need to pass the
|
56
|
-
\f[
|
36
|
+
\f[CR]--config-file\f[R] option to all Gemstash commands.
|
57
37
|
If you plan to use ERB in your config file, you might want to use
|
58
|
-
\f[
|
38
|
+
\f[CR]\[ti]/.gemstash/config.yml.erb\f[R].
|
@@ -1,6 +1,4 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
1
|
+
4mgemstash-setup24m(1) 4mgemstash-setup24m(1)
|
4
2
|
|
5
3
|
<!-- Automatically generated by Pandoc -->
|
6
4
|
|
@@ -8,7 +6,7 @@ gemstash-setup(1) gemstash-setup(1)
|
|
8
6
|
gemstash-setup - Customize your Gemstash configuration interactively
|
9
7
|
|
10
8
|
1mSynopsis0m
|
11
|
-
|
9
|
+
gemstash setup [--redo] [--debug] [--config-file FILE]
|
12
10
|
|
13
11
|
1mDescription0m
|
14
12
|
Customize your Gemstash configuration interactively. This will save
|
@@ -21,22 +19,20 @@ gemstash-setup(1) gemstash-setup(1)
|
|
21
19
|
gemstash setup --config-file <file>
|
22
20
|
|
23
21
|
1mOptions0m
|
24
|
-
o
|
25
|
-
|
26
|
-
ing
|
22
|
+
o --redo: Redo the configuration. This does nothing the first time
|
23
|
+
gemstash setup is run. If you want to change your configuration us-
|
24
|
+
ing gemstash setup after you've run it before, you must provide this
|
27
25
|
option, otherwise Gemstash will simply indicate your setup is com-
|
28
26
|
plete.
|
29
27
|
|
30
|
-
o
|
28
|
+
o --debug: Output additional information if one of the checks at the
|
31
29
|
end of setup fails. This will do nothing if all checks pass.
|
32
30
|
|
33
|
-
o
|
34
|
-
this option, your configuration will be written to
|
35
|
-
|
36
|
-
the
|
37
|
-
use ERB in your config file, you might want to use
|
38
|
-
|
39
|
-
|
40
|
-
|
31
|
+
o --config-file FILE: Specify the config file to write to. Without
|
32
|
+
this option, your configuration will be written to ~/.gemstash/con-
|
33
|
+
fig.yml. If you write to a custom location, you will need to pass
|
34
|
+
the --config-file option to all Gemstash commands. If you plan to
|
35
|
+
use ERB in your config file, you might want to use ~/.gemstash/con-
|
36
|
+
fig.yml.erb.
|
41
37
|
|
42
|
-
October 9, 2015
|
38
|
+
October 9, 2015 4mgemstash-setup24m(1)
|
@@ -1,41 +1,17 @@
|
|
1
1
|
<!-- Automatically generated by Pandoc -->
|
2
|
-
.\" Automatically generated by Pandoc 3.1
|
2
|
+
.\" Automatically generated by Pandoc 3.1.8
|
3
3
|
.\"
|
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
4
|
.TH "gemstash-start" "1" "October 9, 2015" "" ""
|
19
|
-
.hy
|
20
5
|
.SH Name
|
21
|
-
.PP
|
22
6
|
gemstash-start - Starts the Gemstash server
|
23
7
|
.SH Synopsis
|
24
|
-
|
25
|
-
\f[V]gemstash start [--no-daemonize] [--config-file FILE]\f[R]
|
8
|
+
\f[CR]gemstash start [--config-file FILE]\f[R]
|
26
9
|
.SH Description
|
27
|
-
.PP
|
28
10
|
Starts the Gemstash server.
|
29
11
|
.SH Options
|
30
12
|
.IP \[bu] 2
|
31
|
-
\f[
|
13
|
+
\f[CR]--config-file FILE\f[R]: Specify the config file to use.
|
32
14
|
If you aren\[cq]t using the default config file at
|
33
|
-
\f[
|
34
|
-
\f[
|
15
|
+
\f[CR]\[ti]/.gemstash/config.yml\f[R] or
|
16
|
+
\f[CR]\[ti]/.gemstash/config.yml.erb\f[R], then you must specify the
|
35
17
|
config file via this option.
|
36
|
-
.IP \[bu] 2
|
37
|
-
\f[V]--no-daemonize\f[R]: The Gemstash server daemonizes itself by
|
38
|
-
default.
|
39
|
-
Provide this option to instead run the server until \f[V]Ctrl-C\f[R] is
|
40
|
-
typed.
|
41
|
-
When not daemonized, the log will be output to standard out.
|
@@ -1,6 +1,4 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
1
|
+
4mgemstash-start24m(1) 4mgemstash-start24m(1)
|
4
2
|
|
5
3
|
<!-- Automatically generated by Pandoc -->
|
6
4
|
|
@@ -8,21 +6,15 @@ gemstash-start(1) gemstash-start(1)
|
|
8
6
|
gemstash-start - Starts the Gemstash server
|
9
7
|
|
10
8
|
1mSynopsis0m
|
11
|
-
|
9
|
+
gemstash start [--config-file FILE]
|
12
10
|
|
13
11
|
1mDescription0m
|
14
12
|
Starts the Gemstash server.
|
15
13
|
|
16
14
|
1mOptions0m
|
17
|
-
o
|
18
|
-
using the default config file at
|
19
|
-
|
15
|
+
o --config-file FILE: Specify the config file to use. If you aren't
|
16
|
+
using the default config file at ~/.gemstash/config.yml or ~/.gem-
|
17
|
+
stash/config.yml.erb, then you must specify the config file via this
|
20
18
|
option.
|
21
19
|
|
22
|
-
|
23
|
-
Provide this option to instead run the server until 1mCtrl-C 22mis typed.
|
24
|
-
When not daemonized, the log will be output to standard out.
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
October 9, 2015 gemstash-start(1)
|
20
|
+
October 9, 2015 4mgemstash-start24m(1)
|