rails-ahoy 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15150490cf4390e027366a57ec291ae9fddb68f3
-  data.tar.gz: e8ae99b14ea88810a80f17b347a8254088ba54df
+  metadata.gz: faafba237f26ce756cdc2110a568c9b8f08dd3be
+  data.tar.gz: 5a7466efa90fb1ba813b85b5d60e38711e8f506f
 SHA512:
-  metadata.gz: 8d52ecdfda4820a29bf4a20baaea534fde309fe55373c77970c0965b225d513cd2acea7011dea77dcb2fea754eb41debceb1933cae0d607b5e5efeedd4d65181
-  data.tar.gz: 5a204413785959d4280aba05f3688d0952e9544e30e5e7c04162b9b7d66a19eb0253253389127cfad7b655d547d0de4fb3d5d15422c84c271d4ca61e97b84913
+  metadata.gz: 7842899265c3eaa0384efaca34c21e9a4d66025102920648f0bd57b6fb15a859b8553deef370948e1f59826f8e401f943b35d3bb2bde3d815cfd4b55f104bd42
+  data.tar.gz: 2e5795d4f3c60976fc6a3653437a406fc1abb62a9334ad219875742c72984466268fcd8fb2ace5c48b8a0b7f5841bfbdcd644cff53047ed25545257536b732ce

data/README.md

@@ -1,30 +1,120 @@
-# Ahoy
+``` html
 
-TODO: Write a gem description
+     ___           ___           ___            ___    
+    /  /\         /__/\         /  /\          /__/|   
+   /  /++\        \  \+\       /  /++\        |  |+|   
+  /  /+/\+\        \__\+\     /  /+/\+\       |  |+|   
+ /  /+/~/++\   ___ /  /++\   /  /+/  \+\      |  |+|   
+/__/+/ /+/\+\ /__/\  /+/\+\ /__/+/ \__\+\  ___|__|+|   
+\  \+\/+/__\/ \  \+\/+/__\/ \  \+\ /  /+/ /__/+++++\   
+ \  \++/       \  \++/       \  \+\  /+/  \__\~~~~++\  
+  \  \+\        \  \+\        \  \+\/+/         \  \+\ 
+   \  \+\        \  \+\        \  \++/           \  \+\
+    \__\/         \__\/         \__\/             \__\/
+
+      Ahoy = Puma + NGINX + Mina + Vagrant + Ansible
+```
+
+---
+
+#### Ahoy will generate everything you need to deploy your Rails application
+
+* Ansible scripts to provision your server with Nginx, Ruby, PostgreSQL, and recommended security settings (ssh hardening, firewall, fail2ban, etc.)
+* Mina scripts to deploy your Rails application
+* Puma application server configuration files
+* An optional Vagrantfile with settings
+* An *.env* directory that will use YAML to store your environment variables securely
 
-## Installation
 
-Add this line to your application's Gemfile:
+**IMPORTANT:** Ahoy currently expects that your Rails application is using PostgreSQL. Depending on demand, there may be future support for MySQL.
+
+## Installation and usage
+
+**RECOMMENDATION:** You might want to first try this using a fresh Rails application so you can see how it effects your files before running this in your existing code base.
+
+### Step 1
+
+Add the gem to your Gemfile and bundle
 
 ```ruby
-gem 'ahoy'
+gem 'rails-ahoy'
 ```
 
-And then execute:
+    $ bundle install
+
+### Step 2
+
+Execute the following terminal command to launch Ahoy's interactive guide
+
+    $ rails generate ahoy:init
+
+Continue to next step AFTER you complete the interactive guide
+
+### Step 3
+
+If you don't have a production *secret_key_base*, generate one using:
+
+    $ rake secret
+
+This will produce something that looks like:
+
+    $ f67395912d0ddd0de80a734822e73b327d007809123...
+
+Now just copy and paste it into the following file:
+
+    $ <YOUR RAILS APP>/.env/production_env.yml
+
+**IMPORTANT:** At this point make sure to commit your changes and push them up to your repo!
+
+### Step 4
+
+**IMPORTANT:** For this step, you will need a freshly installed Ubuntu box with root ssh privileges. If you're not sure how to do this, contact your web hosting administrator.
+
+From within your Rails app...
+
+    $ cd config/ansible
+    $ ./production.sh
+
+Executing `production.sh` will launch the provisioning process and setup your box so it can run Rails using Nginx as the web server, Puma as your application server, and PostgreSQL as your database.
+
+**NOTE:** This process may take a while (15 mins or so), so sit back and relax.
+
+### Step 5
+
+**ASSUMPTION:** This step assumes that your code is hosted in a Github repo.
+
+Once the provisioning process is complete, log into your box with the server user (ex: deployer)
+
+    $ ssh deployer@<YOUR SERVER IP>
+
+Once in, get your server user's public key
+
+    $ cat ~/.ssh/id_rsa.pub
+
+This will print out something like this:
+
+	sh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDOv2hw90hySH+41A6NVjp6GXhBS/PUVmTot...
+
+Copy the public key and paste it into your Rails application Github repo settings to allow SSH access.
+
+### Step 6
+
+Go back to the root of your Rails application and execute the following command:
+
+    $ mina production setup
 
-    $ bundle
+Then...
 
-Or install it yourself as:
+    $ mina production deploy
 
-    $ gem install ahoy
+### Congratulations!
 
-## Usage
+If everything worked as it should have, your Rails application should be up and running on the Web. Enjoy!
 
-TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/ahoy/fork )
+1. Fork it ( https://github.com/[my-github-username]/rails-ahoy/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/lib/generators/ahoy/templates/ansible_templates/playbooks/_production.yml

@@ -1,5 +1,5 @@
 ---
-# production playbook
+# Production playbook
 #==========================================================
 - hosts: root
   sudo: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-ahoy
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Nathan Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,6 @@ files:
 - lib/generators/ahoy/templates/ansible_templates/playbooks/_production.yml
 - lib/generators/ahoy/templates/ansible_templates/playbooks/_vagrant.yml
 - lib/generators/ahoy/templates/ansible_templates/playbooks/group_vars/_all.yml
-- lib/generators/ahoy/templates/ansible_templates/playbooks/group_vars/_production.yml
 - lib/generators/ahoy/templates/env_templates/_development_env.yml
 - lib/generators/ahoy/templates/env_templates/_production_env.yml
 - lib/generators/ahoy/templates/env_templates/_test_env.yml

data/lib/generators/ahoy/templates/ansible_templates/playbooks/group_vars/_production.yml

@@ -1,11 +0,0 @@
----
-server:
-  user: <%= Ahoy::VariableStore.variables['server_user'] %>
-  ssh_port: <%= Ahoy::VariableStore.variables['server_ssh_port'] %>
-app:
-  root: <%= Ahoy::VariableStore.variables['app_name'] %>
-  secret_key_base: ea25c34b9d9443935394356303a408d19d5613ccdb77de0bc98c5ac57dcb5d19b53f03f13fd402926778b8f6fe6be81b67d9f206d16f5fe3145b9049a6fee582
-database:
-  name: <%= Ahoy::VariableStore.variables['database_name'] %>
-  user: <%= Ahoy::VariableStore.variables['database_user'] %>
-  password: <%= Ahoy::VariableStore.variables['database_password'] %>