kompanee-recipes 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of kompanee-recipes might be problematic. Click here for more details.
- data/README.md +34 -34
- data/lib/kompanee-recipes/bundler.rb +1 -1
- data/lib/kompanee-recipes/deploy.rb +1 -0
- metadata +3 -3
data/README.md
CHANGED
@@ -2,34 +2,34 @@
|
|
2
2
|
|
3
3
|
[http://github.com/thekompanee/kompanee-recipes](http://github.com/thekompanee/kompanee-recipes)
|
4
4
|
|
5
|
-
##
|
5
|
+
## DESCRIPTION ##
|
6
6
|
|
7
7
|
These are the common recipes we've been using here at The Kompanee. Packaged as a gem.
|
8
8
|
|
9
|
-
##
|
9
|
+
## FEATURES/PROBLEMS ##
|
10
10
|
|
11
11
|
None yet
|
12
12
|
|
13
|
-
##
|
13
|
+
## SYNOPSIS ##
|
14
14
|
|
15
15
|
To the top of your Capfile add:
|
16
16
|
|
17
17
|
require 'rubygems'
|
18
18
|
require 'kompanee-recipes/deploy'
|
19
19
|
|
20
|
-
##
|
20
|
+
## REQUIREMENTS ##
|
21
21
|
|
22
22
|
Capistrano (Obv)
|
23
23
|
|
24
|
-
##
|
24
|
+
## INSTALL ##
|
25
25
|
|
26
26
|
gem install kompanee-recipes
|
27
27
|
|
28
|
-
##
|
28
|
+
## USAGE ##
|
29
29
|
|
30
30
|
### New Server Setup ###
|
31
31
|
|
32
|
-
####
|
32
|
+
#### initial connection ####
|
33
33
|
You need to add the server to your hosts file so you'll want to do an
|
34
34
|
initial SSH connection before we get into our Capistrano configuration.
|
35
35
|
|
@@ -37,19 +37,19 @@ initial SSH connection before we get into our Capistrano configuration.
|
|
37
37
|
|
38
38
|
Accept the authenticity of the host.
|
39
39
|
|
40
|
-
####
|
40
|
+
#### user creation ####
|
41
41
|
By default, the Kompanee recipes will install a `deploy` user and a
|
42
42
|
`manager` user.
|
43
43
|
|
44
44
|
##### Installation #####
|
45
45
|
cap <environment> os:users:create
|
46
46
|
|
47
|
-
##### Manual Steps As
|
47
|
+
##### Manual Steps As Root #####
|
48
48
|
Log in as `root`
|
49
49
|
|
50
50
|
ssh root@<server_name>
|
51
51
|
|
52
|
-
|
52
|
+
##### Password Assignment #####
|
53
53
|
Log in to each of these and give them their custom passwords. On
|
54
54
|
Ubuntu this is done by loggin in as root and typing:
|
55
55
|
|
@@ -61,7 +61,7 @@ something more secure as well.
|
|
61
61
|
|
62
62
|
passwd
|
63
63
|
|
64
|
-
|
64
|
+
##### Sudo Assignment #####
|
65
65
|
Finally, let's add the `manager` user to the `sudoers` file so we
|
66
66
|
no longer need to log in as `root`
|
67
67
|
|
@@ -77,17 +77,17 @@ And a line like this:
|
|
77
77
|
|
78
78
|
From the documentation:
|
79
79
|
|
80
|
-
**visiblepw**
|
81
|
-
By default, sudo will refuse to run if the user must enter
|
82
|
-
a password but it is not possible to disable echo on the
|
83
|
-
terminal. If the `visiblepw` flag is set, sudo will prompt
|
84
|
-
for a password even when it would be visible on the screen.
|
85
|
-
This makes it possible to run things like:
|
80
|
+
> **visiblepw**
|
81
|
+
> By default, sudo will refuse to run if the user must enter
|
82
|
+
> a password but it is not possible to disable echo on the
|
83
|
+
> terminal. If the `visiblepw` flag is set, sudo will prompt
|
84
|
+
> for a password even when it would be visible on the screen.
|
85
|
+
> This makes it possible to run things like:
|
86
86
|
|
87
|
-
|
87
|
+
> rsh somehost sudo ls
|
88
88
|
|
89
|
-
since rsh(1) does not allocate a tty. This flag is off by
|
90
|
-
default.
|
89
|
+
> since rsh(1) does not allocate a tty. This flag is off by
|
90
|
+
> default.
|
91
91
|
|
92
92
|
##### Authorize Public Key #####
|
93
93
|
Once that's finished, go back to Capistrano and type:
|
@@ -96,25 +96,25 @@ Once that's finished, go back to Capistrano and type:
|
|
96
96
|
|
97
97
|
That will give you the ability to log into your accounts with no password required.
|
98
98
|
|
99
|
-
####
|
100
|
-
If you're using Github to deploy your app, you're going to need to add the
|
101
|
-
public key of the deployment user to your Github account.
|
99
|
+
> #### note on using github ####
|
100
|
+
> If you're using Github to deploy your app, you're going to need to add the
|
101
|
+
> public key of the deployment user to your Github account.
|
102
102
|
|
103
|
-
|
103
|
+
> cap <environment> os:users:deploy:public_key:create
|
104
104
|
|
105
|
-
View the public key by logging in as `deploy` and typing:
|
105
|
+
> View the public key by logging in as `deploy` and typing:
|
106
106
|
|
107
|
-
|
107
|
+
> cat /home/deploy/.ssh/id_rsa.pub
|
108
108
|
|
109
|
-
Copy and paste the output into Github's "Public Keys" section of the Github at:
|
109
|
+
> Copy and paste the output into Github's "Public Keys" section of the Github at:
|
110
110
|
|
111
|
-
[https://github.com/account](https://github.com/account)
|
111
|
+
> * [https://github.com/account](https://github.com/account)
|
112
112
|
|
113
|
-
Log in as `deploy` and test it out by typing:
|
113
|
+
> Log in as `deploy` and test it out by typing:
|
114
114
|
|
115
|
-
|
115
|
+
> ssh git@github.com
|
116
116
|
|
117
|
-
####
|
117
|
+
#### setup deployment server ####
|
118
118
|
Now that we have our public keys installed, we can do a relatively simple installation.
|
119
119
|
|
120
120
|
cap <environment> server_setup
|
@@ -126,7 +126,7 @@ a `production` task in the application's `deploy.rb` file.
|
|
126
126
|
This will allow you to set specific environment variables for your application
|
127
127
|
and stage.
|
128
128
|
|
129
|
-
####
|
129
|
+
#### shared configuration files ####
|
130
130
|
Shared configuration files should be added to your local machine but not committed to
|
131
131
|
source control.
|
132
132
|
|
@@ -138,7 +138,7 @@ sensitive production logins.
|
|
138
138
|
When you deploy, if you have a file that meets these requirements, it will be copied
|
139
139
|
to the proper location on the server.
|
140
140
|
|
141
|
-
####
|
141
|
+
#### initial deployment ####
|
142
142
|
In order to perform the initial deployment, type:
|
143
143
|
|
144
144
|
cap <environment> deploy:initial
|
@@ -156,7 +156,7 @@ This will:
|
|
156
156
|
* Enables the website
|
157
157
|
* Restarts the server
|
158
158
|
|
159
|
-
##
|
159
|
+
## LICENSE ##
|
160
160
|
|
161
161
|
(The MIT License)
|
162
162
|
|
@@ -18,7 +18,7 @@ Capistrano::Configuration.instance(:must_exist).load do
|
|
18
18
|
namespace :bundler do
|
19
19
|
desc "Install Bundler"
|
20
20
|
task :install do
|
21
|
-
run "rvm use #{
|
21
|
+
run "rvm use #{app_ruby_version}@global && gem install bundler --version #{bundler_version} --no-ri --no-rdoc"
|
22
22
|
end
|
23
23
|
end
|
24
24
|
end
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: kompanee-recipes
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 29
|
5
5
|
prerelease: false
|
6
6
|
segments:
|
7
7
|
- 0
|
8
8
|
- 1
|
9
|
-
-
|
10
|
-
version: 0.1.
|
9
|
+
- 3
|
10
|
+
version: 0.1.3
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- The Kompanee
|