Skip to content

Commit cbc600d

Browse files
willmosswillmoss
committed
Added readme, changes some files to make ready for publishing to Github
1 parent 27d4e07 commit cbc600d

File tree

13 files changed

+277
-60
lines changed

13 files changed

+277
-60
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ modules/
55
*.DS_Store
66
*~
77
*#
8+
.ignore

‎README.md

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
Quick Ruby On Rails (RoR) VPS : QRoR
2+
=============
3+
4+
This is a quick way to get a Ruby on Rails enabled VPS set up on a linux box from scratch, in less than 10 minutes.
5+
6+
It uses Puppet, so you'll always have the latest version of all packages. It's also very easy to customize any settings to your liking, and provides a good base for new RoR VPS deployments.
7+
8+
Features
9+
-------
10+
11+
* Automated setup of an Apache/Passenger/Rails/PHP/MySQL/Ubuntu environment
12+
* Supports adding multiple virtual host (rails) environments to the existing puppet-apache class
13+
* Configures a custom 'webapp' user for your rails apps
14+
* Host as many different rails apps at http://yourdomain/appname
15+
* Supports HTTPS & HTTP
16+
* Generation of local HTTP & HTTPS environments
17+
* Generates custom self-signed SSL certificate for local testing
18+
* Generation of a HTTP -> HTTPS redirect
19+
* Also installs wordpress at http://yourdomain , so you can manage the front section of your site using a CMS
20+
* Includes some bash scripts to upload the configuration files to your server
21+
* No knowledge of puppet required to use this environment
22+
23+
24+
Usage
25+
-----
26+
27+
To get using this, just `git clone` to your local machine, then edit the main configuration file in `manifests/nodes.pp` to fit your needs.
28+
29+
We define a new puppet module, `apache2`, which uses the [Apache module][apache-puppet].
30+
31+
Eg.
32+
33+
# set up apache with SSL
34+
apache2::site { "bxmediaus.com-ssl":
35+
sitedomain => "bxmediaus.com",
36+
ssl => true,
37+
ssl_have_certificates => "false",
38+
rack_envs => $rack,
39+
documentroot => "/home/webapp/bxmediaus.com.wordpress/",
40+
priority => 25,
41+
before => Class['wordpress'],
42+
}
43+
44+
45+
`ssl_have_certificates`: set to false, to generate custom SSL certificates for your domain (if you don't have any). The certificate files are placed in `modules/apache2/files/` and automatically configured for you.
46+
47+
If you have certificates already, set it to true and place your certificates in `modules/apache2/files/`, in the form: `yourdomain.crt`, `yourdomain.key`, etc.
48+
49+
50+
`racks_envs`: this is an array of different rack environments you would like to set up. If the folder doesn't exist, it will be created.
51+
52+
Set the `path` and `dir` attributes for each element.
53+
54+
Eg.
55+
56+
$rack = [
57+
{'path' => '/myclient','dir' => '/home/webapp/bxmediaus.com.myclient/current/public/'},
58+
{'path' => '/admin','dir' => '/home/webapp/bxmediaus.com.admin/current/public/'},
59+
]
60+
61+
62+
The default `nodes.pp` contains all the default settings you need, you only need to change the configuration details.
63+
64+
However, if you'd like to just use a part of our module (for example, the apache2 module), then feel free.
65+
66+
Deploying
67+
-----
68+
69+
Once you have customized the environment, you'll need to save your settings to git. Because our deploy scripts use git. It's also a better way to manage your code.
70+
71+
We recommend making a new branch for your archive, like this:
72+
73+
git checkout -b mysite.com
74+
git commit -a -m 'updated configuration files'
75+
76+
Then, if you make more changes to your environment, just commit the changes again to the archive.
77+
78+
After this, you're ready to deploy. On your local mac/linux machine:
79+
80+
(1) Edit the settings in `config.sh` to point to your server IP & root user (a new user will be created, but puppet needs to run as root).
81+
82+
(2) Execute `ruby_puppet_installer.sh` to install ruby & puppet to your server via SSH.
83+
84+
(3) Execute `deploy.sh` to copy & run the puppet scripts on your server via SSH.
85+
86+
You're done!
87+
88+
Depending on the speed/bandwidth of your server, you should have a rails environment up and running in 10 minutes.
89+
90+
After that, just set your capistrano config files to deploy to the directory you set in the `$rack` configuration (see above), run `cap deploy:cold`, and you're done.
91+
92+
Contributing
93+
------------
94+
95+
Want to contribute? Great!
96+
97+
Just fork our code, make your changes, then let us know and we will incorporate.
98+
99+
1. Fork it.
100+
2. Create a branch (`git checkout -b my_qror`)
101+
3. Commit your changes (`git commit -am "Added Snarkdown"`)
102+
4. Push to the branch (`git push origin my_qror`)
103+
5. Open a [Pull Request][1]
104+
6. Enjoy a refreshing Diet Coke and wait
105+
106+
We encourage you to get in touch and tell us what you think of our code.
107+
108+
We are constantly updating and improving our code. We hope it can be for the benefit of the entire community.
109+
110+
If you want to chat to us, connect to our website: [bxmediaus.com][bxmediaus]
111+
112+
113+
[bxmediaus]: https://bxmediaus.com
114+
[apache-puppet]: https://github.com/puppetlabs/puppetlabs-apache
115+
[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13
116+
[1]: http://github.com/github/markup/pulls
117+

‎config.sh

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
############################
2+
# config.sh
3+
#
4+
# Here, you put your remote environment settings
5+
############################
6+
7+
8+
DEPLOY_USER=root
9+
DEPLOY_SERVER=166.78.157.203

‎deploy.ignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/bin/bash
2+
3+
DEPLOY_USER=root
4+
DEPLOY_SERVER=166.78.157.203
5+
6+
git archive --format=tar master | gzip -9c | ssh $DEPLOY_USER@$DEPLOY_SERVER "tar --directory=/etc/puppet -xvzf - && cd /etc/puppet && librarian-puppet install"
7+
8+
# copy in (config) files outside of git
9+
# http://superuser.com/questions/82445/how-to-upload-a-file-from-the-command-line-with-ftp-or-ssh
10+
scp "user-modules/user/manifests/webapp.pp" $DEPLOY_USER@$DEPLOY_SERVER:/etc/puppet/user-modules/user/manifests/webapp.pp
11+
12+
# now run sudo puppet apply --verbose manifests/site.pp

‎deploy.sh

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/bin/bash
2+
3+
############################
4+
# Deploy puppet scripts to remote server
5+
############################
6+
7+
source config.sh
8+
9+
git archive --format=tar master | gzip -9c | ssh $DEPLOY_USER@$DEPLOY_SERVER "tar --directory=/etc/puppet -xvzf - && cd /etc/puppet && librarian-puppet install"
10+
11+
# copy in (config) files outside of git
12+
# http://superuser.com/questions/82445/how-to-upload-a-file-from-the-command-line-with-ftp-or-ssh
13+
scp "user-modules/user/manifests/webapp.pp" $DEPLOY_USER@$DEPLOY_SERVER:/etc/puppet/user-modules/user/manifests/webapp.pp
14+
15+
# now run sudo puppet apply --verbose manifests/site.pp

‎manifests/nodes.pp

+63-42
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,57 @@
77
include swap
88
include php
99

10-
# install node js
11-
#class {'nodejs':}
10+
# configure whether we use vagrant or not
11+
$is_vagrant = true
12+
13+
# config settings for local/remote setup
14+
if $is_vagrant == 'true' {
15+
16+
# local settings for vagrant (for testing)
17+
apache2::site { "bxmediaus.com-http":
18+
sitedomain => "localhost",
19+
ssl_redirect => true,
20+
}
21+
22+
$ssl_domain = "localhost"
23+
$ssl_have_certificates = false
24+
25+
} else {
26+
27+
apache2::site { "bxmediaus.com-http":
28+
sitedomain => "bxmediaus.com",
29+
ssl_redirect => true,
30+
}
31+
32+
$ssl_domain = "bxmediaus.com"
33+
$ssl_have_certificates = true
34+
35+
}
1236

1337
# Install apache
1438
class {'apache':
1539
mpm_module => prefork,
1640
}
1741

18-
# http , which redirect to ssl
19-
apache2::site { "bxmediaus.com-http":
20-
#sitedomain => "bxmediaus.com",
21-
sitedomain => "localhost",
22-
ssl_redirect => true,
23-
}
24-
2542
# define different rack environments
2643
$rack = [
2744
{'path' => '/trade','dir' => '/home/webapp/bxmediaus.com.wmtrade/current/public/'},
2845
{'path' => '/bicho','dir' => '/home/webapp/bxmediaus.com.bicho/current/public/'},
2946
{'path' => '/p2pexchange','dir' => '/home/webapp/bxmediaus.com.p2pexchange/current/public/'},
3047
{'path' => '/bitfication','dir' => '/home/webapp/bxmediaus.com.bitfication/current/public/'},
3148
]
32-
49+
3350
# ssl
3451
apache2::site { "bxmediaus.com-ssl":
35-
#sitedomain => "bxmediaus.com",
36-
sitedomain => "localhost",
37-
ssl => true,
38-
#ssl_have_certificates => true,
39-
ssl_have_certificates => false,
40-
rack_envs => $rack,
41-
documentroot => "/home/webapp/bxmediaus.com.wordpress/",
42-
priority => 25,
43-
before => Class['wordpress'],
44-
}
52+
sitedomain => $ssl_domain,
53+
ssl => true,
54+
ssl_have_certificates => $ssl_have_certificates,
55+
rack_envs => $rack,
56+
documentroot => "/home/webapp/bxmediaus.com.wordpress/",
57+
priority => 25,
58+
before => Class['wordpress'],
59+
}
60+
4561

4662
# install wordpress?
4763
class { 'wordpress':
@@ -53,28 +69,6 @@
5369
create_db_user => false,
5470
}
5571

56-
# install ftp for wordpress plugins
57-
#class { 'vsftpd':
58-
# anonymous_enable => 'NO',
59-
# write_enable => 'YES',
60-
# ftpd_banner => 'FTP Server',
61-
# chroot_local_user => 'NO'
62-
# #userlist_enable => 'YES',
63-
# #userlist_file
64-
# #userlist_deny => 'NO',
65-
#}
66-
67-
# TO DO: install VPN server http://www.howtogeek.com/51237/setting-up-a-vpn-pptp-server-on-debian/
68-
69-
# wordpress user (for ftp)
70-
#user { "wordpress":
71-
# ensure => present,
72-
# groups => ["wordpress"],
73-
# membership => minimum,
74-
# home => "/home/webapp/bxmediaus.com.wordpress",
75-
# password => '$1$Jp9gahZj$5fsPBPfikpkClvQASFkJ01', #password='default' (generated by `openssl passwd -1`)
76-
# require => Class['wordpress'], Group["wordpress"],
77-
#}
7872

7973
# make owner of dir
8074
exec { "wordpress chown":,
@@ -98,4 +92,31 @@
9892

9993
Class["User"] -> Class["apache2"]
10094
Class["swap"] -> Class["passenger"] # passenger requires larger swap
95+
96+
97+
# TO DO
98+
#
99+
# install ftp for wordpress plugins
100+
#class { 'vsftpd':
101+
# anonymous_enable => 'NO',
102+
# write_enable => 'YES',
103+
# ftpd_banner => 'FTP Server',
104+
# chroot_local_user => 'NO'
105+
# #userlist_enable => 'YES',
106+
# #userlist_file
107+
# #userlist_deny => 'NO',
108+
#}
109+
#
110+
# TO DO: install VPN server http://www.howtogeek.com/51237/setting-up-a-vpn-pptp-server-on-debian/
111+
#
112+
# wordpress user (for ftp)
113+
#user { "wordpress":
114+
# ensure => present,
115+
# groups => ["wordpress"],
116+
# membership => minimum,
117+
# home => "/home/webapp/bxmediaus.com.wordpress",
118+
# password => '$1$Jp9gahZj$5fsPBPfikpkClvQASFkJ01', #password='default' (generated by `openssl passwd -1`)
119+
# require => Class['wordpress'], Group["wordpress"],
120+
#}
121+
101122
}

‎manifests/site.pp

-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,5 @@
22
path => "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
33
}
44

5-
65
import "nodes.pp"
76

‎myfile

-21 KB
Binary file not shown.

‎ruby_puppet_installer.sh

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#!/bin/bash
2+
3+
############################
4+
# Install ruby & puppet
5+
############################
6+
7+
source config.sh
8+
9+
#http://wildlyinaccurate.com/deploying-a-git-repository-to-a-remote-server
10+
11+
ssh $DEPLOY_USER@$DEPLOY_SERVER << 'EOF'
12+
13+
# http://askubuntu.com/questions/41605/trouble-downloading-updates-due-to-hash-sum-mismatch-error
14+
sudo rm -fR /var/lib/apt/lists/*
15+
16+
# download & install ruby
17+
aptitude update -y;
18+
aptitude -y install build-essential zlib1g-dev libssl-dev libreadline-dev git-core curl libyaml-dev libcurl4-dev libsqlite3-dev apache2-dev -y;
19+
curl --remote-name http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p194.tar.gz;
20+
tar zxf ruby-1.9.3-p194.tar.gz;
21+
cd ruby-1.9.3-p194/ ;
22+
./configure;
23+
make;
24+
make install;
25+
26+
# install puppet & librarian
27+
mkdir /etc/puppet;
28+
gem install puppet --no-ri --no-rdoc;
29+
mkdir -p ~/.puppet/var;
30+
gem install librarian-puppet --no-ri --no-rdoc;
31+
32+
# now run ./deploy.sh
33+
34+
EOF

‎test

-3
This file was deleted.

‎user-modules/config/manifests/config.pp

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
class bx::settings {
2+
env_check { vo_lhcb:
3+
file => '/etc/profile.d/zfs-env.sh',
4+
string => "$settings::l_dir",
5+
.......
6+
.......
7+
}
8+
}

‎user-modules/user/manifests/init.pp

+2-14
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,12 @@
55
ensure => "present",
66
}
77

8-
# webapp user
9-
user {
10-
"webapp":
11-
ensure => present,
12-
groups => ["sudo","wordpress"],
13-
membership => minimum,
14-
shell => "/bin/bash",
15-
managehome => true,
16-
password => '$6$6OTK2BzD$hNd26Tvge66LEtyC/adhmLaPUb38W7xrpejY2b5qYID2QhvKGL8EBsZ9OfyRj7n9RXT0UBpAX7auWPuO5wUET1', # Iecieviosei8mohcaKai - do not change- hardcoded to capistrano deploy
17-
require => Group["wordpress"],
18-
}
19-
208
# install ssh key
219
class { "user-sshkey":
2210
user => "webapp",
2311
type => "rsa"
2412
}
2513

26-
27-
2814
}
15+
16+
import "webapp.pp"

‎user-modules/user/manifests/webapp.pp

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
class user {
2+
3+
# webapp user
4+
user {
5+
"webapp":
6+
ensure => present,
7+
groups => ["sudo","wordpress"],
8+
membership => minimum,
9+
shell => "/bin/bash",
10+
managehome => true,
11+
password => '$6$6OTK2BzD$hNd26Tvge66LEtyC/adhmLaPUb38W7xrpejY2b5qYID2QhvKGL8EBsZ9OfyRj7n9RXT0UBpAX7auWPuO5wUET1', # Iecieviosei8mohcaKai - do not change- hardcoded to capistrano deploy
12+
require => Group["wordpress"],
13+
}
14+
15+
}
16+

0 commit comments

Comments
 (0)