capistrano-atlas 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fdb1cb92c6e823effad36625a49db5dccb2ea5b
+  data.tar.gz: 3858ea7c0f6e411411fe880d502428686cafc8a5
+SHA512:
+  metadata.gz: e6b7c06a79714867e4c37e7fe2aa83756793b2f47467eea82f6d2d9afd25c629e58921882c0b532466a8f89b25afab8e082c6cb6af680819dc2e3691e66b4c9b
+  data.tar.gz: f4a9a75485061d6f79045384de70b2e020577b29ac7af225028637627eacbd1fb37ebc753366070ea30d0d26898d65a44363e83a8689da1f114468b7089c053f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [Unreleased][]
+
+* Your contribution here!
+
+## [0.0.1][] (2017-11-01)
+
+* Fork, and starting to change things for Puma and Let's Encrypt support in production.
+
+
+
+[Unreleased]: https://github.com/mattbrictson/capistrano-atlas/compare/v0.32.0...HEAD
+[0.32.0]: https://github.com/mattbrictson/capistrano-atlas/compare/v0.31.0...v0.32.0
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-atlas.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 John McDowall & Matt Brictson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,215 @@
+# capistrano-atlas
+
+[![Gem Version](https://badge.fury.io/rb/capistrano-atlas.svg)](http://badge.fury.io/rb/capistrano-atlas)
+
+**This is a fork of `capistrano-mb` by the excellent Matt Brictson and FiftyFive. I've changed things to use Puma and Let's Encrypt in production.**
+
+Capistrano is great for deploying Rails applications, but what about all the prerequisites, like Nginx and PostgreSQL? Do you have a firewall configured on your VPS? Have you installed the latest OS security updates? Is HTTPS working right?
+
+The capistrano-atlas gem adds a `cap <stage> provision` task to Capistrano that takes care of all that. Out of the box, `provision` will:
+
+* Install the latest `postgresql`, `node.js`, and `nginx` apt packages
+* Install all libraries needed to build Ruby
+* Lock down your VPS using `ufw` (a simple front-end to iptables)
+* Set up `logrotated` for your Rails logs
+* Schedule an automatic daily backup of your Rails database
+* Generate a self-signed SSL certificate if you need one
+* Set up ngnix with the latest SSL practices and integrate it with Puma for your Rails app
+* Create the `deployer` user and install an SSH public key
+* Install `rbenv` and use `ruby-build` to compile the version of Ruby required by your app (by inspecting your `.ruby-version` file)
+* And more!
+
+The gem is named "capistrano-atlas" because it does the heavy lifting of setting up a VPS to be ready for modern Rails 5.1+ applications.
+
+You'll notice that capistrano-atlas is opinionated and strictly uses the following stack:
+
+* Ubuntu 14.04 LTS
+* PostgreSQL
+* Puma
+* Nginx
+* rbenv
+* dotenv
+
+In addition, capistrano-atlas changes many of Capistrano's defaults, including the deployment location, Bundler behavior, and SSH keep-alive settings. (See [defaults.rake][] for details.)
+
+Not quite to your liking? Consider forking the project to meet your needs.
+
+
+## Quick start
+
+Please note that this project requires **Capistrano 3.x**, which is a complete rewrite of Capistrano 2.x. The two major versions are not compatible.
+
+### 1. Purchase an Ubuntu 14.04 VPS
+
+To use capistrano-atlas, you'll need a clean Ubuntu server to deploy to. The only special requirement is that your public SSH key must be installed on the server for the `root` user.
+
+Test that you can SSH to the server as `root` without being prompted for a password. If that works, capistrano-atlas can take care of the rest. You're ready to proceed!
+
+### 2. .ruby-version
+
+capistrano-atlas needs to know the version of Ruby that your app requires, so that it can install Ruby during the provisioning process. Place a `.ruby-version` file in the root of your project containing the desired version, like this:
+
+```
+2.2.3
+```
+
+*If you are using `rbenv`, just run `rbenv local 2.2.3` and it will create this file for you.*
+
+### 3. Gemfile
+
+capistrano-atlas makes certain assumptions about your Rails app, namely that it uses [dotenv][] to manage Rails secrets via environment variables, and that it runs on top of PostgreSQL and [Puma][]. Make sure they are specified in the Gemfile:
+
+```ruby
+gem "dotenv-rails", ">= 2.0.0"
+gem "pg", "~> 0.18"
+gem "Puma"
+```
+
+Then for the capistrano-atlas tools themselves, add these gems to the development group:
+
+```ruby
+group :development do
+  gem "capistrano-bundler", :require => false
+  gem "capistrano-rails", :require => false
+  gem "capistrano", "~> 3.4.0", :require => false
+  gem "capistrano-atlas", :require => false
+end
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+### 4. cap install
+
+If your project doesn't yet have a `Capfile`, run `cap install` with the list of desired stages (environments). For simplicity, this installation guide will assume a single production stage:
+
+```
+cap install STAGES=production
+```
+
+### 5. Capfile
+
+Add these lines to the **bottom** of your app's `Capfile` (order is important!):
+
+```ruby
+require "capistrano/bundler"
+require "capistrano/rails"
+require "capistrano/atlas"
+```
+
+### 6. deploy.rb
+
+Modify `config/deploy.rb` to set the specifics of your Rails app. At the minimum, you'll need to set these two options:
+
+```ruby
+set :application, "my_app_name"
+set :repo_url, "git@github.com:username/repository.git"
+```
+
+### 7. production.rb
+
+Modify `config/deploy/production.rb` to specify the IP address of your production server. In this example, I have a single 1GB VPS (e.g. at DigitalOcean) that plays all the roles:
+
+```ruby
+server "my.production.ip",
+       :user => "deployer",
+       :roles => %w(app backup cron db web)
+```
+
+*Note that you must include the `backup` and `cron` roles if you want to make use of capistrano-atlas's database backups and crontab features.*
+
+### 8. secrets.yml
+
+By default, Rails 4.2 apps have a `config/secrets.yml` file that specifies the Rails secret key. capistrano-atlas configures dotenv to provide this secret in a `RAILS_SECRET_KEY_BASE` environment variable. You'll therefore need to modify `secrets.yml` as follows:
+
+```ruby
+production:
+  secret_key_base: <%= ENV["RAILS_SECRET_KEY_BASE"] %>
+```
+
+### 9. Provision and deploy!
+
+Run capistrano-atlas's `provision:14_04` task (named for Ubuntu 14.04). This will ask you a few questions, install Ruby, PostgreSQL, Nginx, etc., and set everything up. The entire process takes about 10 minutes (mostly due to compiling Ruby from source).
+
+```
+bundle exec cap production provision:14_04
+```
+
+Once that's done, your app is now ready to deploy!
+
+```
+bundle exec cap production deploy
+```
+
+## Advanced usage
+
+### Choosing which recipes to auto-run
+
+Most of the capistrano-atlas recipes are designed to run automatically as part of `cap <stage> provision`, for installing and setting up various bits of the Rails infrastructure, like nginx, Puma, and postgres. Some recipes also contribute to the `cap <stage> deploy` process.
+
+*This auto-run behavior is fully under your control.*  In your `deploy.rb`, set `:atlas_recipes` to an array of the desired recipes. If you don't want a recipe to execute as part of `deploy`/`provision`, simply omit it from the list.
+
+The following list will suffice for most out-of-the-box Rails apps. The order of the list is not important.
+
+```ruby
+set :atlas_recipes, %w(
+  aptitude
+  crontab
+  dotenv
+  logrotate
+  migrate
+  nginx
+  postgresql
+  rbenv
+  seed
+  ssl
+  ufw
+  Puma
+  user
+  version
+)
+```
+
+Even if you don't include a recipe in the auto-run list, you can still invoke the tasks of those recipes manually at your discretion. Run `bundle exec cap -T` to see the full list of tasks.
+
+### Configuration
+
+Many of the recipes have default settings that can be overridden. Use your
+`deploy.rb` file to specify these overrides. Or, you can override per stage.
+Here is an example override:
+
+    set :atlas_Puma_workers, 8
+
+For the full list of settings and their default values, refer to [defaults.rake][].
+
+
+## Further reading
+
+Check out my [rails-template][] project, which generates Rails applications with capistrano-atlas pre-configured and ready to go.
+
+
+## History
+
+This gem used to be called capistrano-fiftyfive, because it was initially built by [55 Minutes](http://55minutes.com) to automate its Rails deployments. I have since taken over ownership of the gem and renamed it to capistrano-atlas to avoid any confusion.
+
+If you are upgrading from `capistrano-fiftyfive`, refer to the [CHANGELOG entry for v0.22.0](CHANGELOG.md#0220-2015-06-22) for migration instructions.
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request
+
+
+[Postmark]:https://postmarkapp.com
+[cast337]:http://railscasts.com/episodes/337-capistrano-recipes
+[cast373]:http://railscasts.com/episodes/373-zero-downtime-deployment
+[defaults.rake]:lib/capistrano/tasks/defaults.rake
+[rails-template]:https://github.com/mattbrictson/rails-template/
+[dotenv]:https://github.com/bkeepers/dotenv
+[Puma]:http://Puma.bogomips.org/

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "chandler/tasks"
+
+# Add chandler as a prerequisite for `rake release`
+#task "release:rubygem_push" => "chandler:push"

data/capistrano-atlas.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/atlas/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-atlas"
+  spec.version       = Capistrano::Atlas::VERSION
+  spec.author        = "John McDowall"
+  spec.email         = "john@kantan.io"
+  spec.description   = \
+    "Does all the heavy lifting for production-ready provisioning "\
+    "and deployment for the full Rails 5.1 stack. Installs and "\
+    "configures Ruby, Nginx, Puma, PostgreSQL, dotenv, Let's Encrypt and "\
+    "more onto Ubuntu 14.04 LTS using Capistrano. "
+    
+  spec.summary       = "Additional Capistrano 3 recipes"
+  spec.homepage      = "https://github.com/johnmcdowall/capistrano-atlas"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", ">= 3.3.5"
+  spec.add_dependency "sshkit", ">= 1.6.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "chandler"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/atlas.rb

@@ -0,0 +1,27 @@
+require "digest"
+require "monitor"
+require "capistrano/atlas/version"
+require "capistrano/atlas/compatibility"
+require "capistrano/atlas/dsl"
+require "capistrano/atlas/recipe"
+include Capistrano::Atlas::DSL
+
+load File.expand_path("../tasks/provision.rake", __FILE__)
+load File.expand_path("../tasks/defaults.rake", __FILE__)
+load File.expand_path("../tasks/user.rake", __FILE__)
+load File.expand_path("../tasks/aptitude.rake", __FILE__)
+load File.expand_path("../tasks/ufw.rake", __FILE__)
+load File.expand_path("../tasks/ssl.rake", __FILE__)
+load File.expand_path("../tasks/dotenv.rake", __FILE__)
+load File.expand_path("../tasks/postgresql.rake", __FILE__)
+load File.expand_path("../tasks/nginx.rake", __FILE__)
+load File.expand_path("../tasks/crontab.rake", __FILE__)
+load File.expand_path("../tasks/logrotate.rake", __FILE__)
+load File.expand_path("../tasks/rbenv.rake", __FILE__)
+load File.expand_path("../tasks/maintenance.rake", __FILE__)
+load File.expand_path("../tasks/migrate.rake", __FILE__)
+load File.expand_path("../tasks/seed.rake", __FILE__)
+load File.expand_path("../tasks/version.rake", __FILE__)
+load File.expand_path("../tasks/rake.rake", __FILE__)
+load File.expand_path("../tasks/sidekiq.rake", __FILE__)
+load File.expand_path("../tasks/bundler.rake", __FILE__)

data/lib/capistrano/atlas/compatibility.rb

@@ -0,0 +1,37 @@
+module Capistrano
+  module Atlas
+    module Compatibility
+      def self.check
+        check_capistrano_and_rake_are_loaded
+        check_blacklisted_capistrano_version
+      end
+
+      def self.check_capistrano_and_rake_are_loaded
+        return if defined?(Capistrano::VERSION) && defined?(Rake)
+
+        warn "capistrano/atlas must be loaded by Capistrano in order "\
+             "to work.\nRequire this gem by using Capistrano's Capfile, "\
+             "as described here:\n"\
+             "https://github.com/mattbrictson/capistrano-atlas#installation"
+      end
+
+      def self.check_blacklisted_capistrano_version
+        return unless defined?(Capistrano::VERSION)
+        return unless Capistrano::VERSION == "3.2.0"
+
+        warn "Capistrano 3.2.0 has a critical bug that prevents "\
+             "capistrano-atlas from working as intended:\n"\
+             "https://github.com/capistrano/capistrano/issues/1004"
+      end
+
+      # We can't really rely on anything being loaded at this point, so define
+      # our own basic colorizing helper.
+      def self.warn(message)
+        return $stderr.puts("WARNING: #{message}") unless $stderr.tty?
+        $stderr.puts("\e[0;31;49mWARNING: #{message}\e[0m")
+      end
+    end
+  end
+end
+
+Capistrano::Atlas::Compatibility.check

data/lib/capistrano/atlas/dsl.rb

@@ -0,0 +1,157 @@
+module Capistrano
+  module Atlas
+    module DSL
+
+      # Invoke the given task. If a task with that name is not defined,
+      # silently skip it.
+      #
+      def invoke_if_defined(task)
+        invoke(task) if Rake::Task.task_defined?(task)
+      end
+
+      # Used internally by capistrano-atlas to register tasks such that
+      # those tasks are executed conditionally based on the presence of the
+      # recipe name in fetch(:atlas_recipes).
+      #
+      #   atlas_recipe :aptitude do
+      #     during :provision, %w(task1 task2 ...)
+      #   end
+      #
+      def atlas_recipe(recipe_name, &block)
+        Recipe.new(recipe_name).instance_exec(&block)
+      end
+
+      def compatibility_warning(warning)
+        Capistrano::Atlas::Compatibility.warn(warning)
+      end
+
+      # Helper for calling fetch(:application) and making the value safe for
+      # using in filenames, usernames, etc. Replaces non-word characters with
+      # underscores.
+      #
+      def application_basename
+        fetch(:application).to_s.gsub(/[^a-zA-Z0-9_]/, "_")
+      end
+
+      # Prints a question and returns truthy if the user answers "y" or "yes".
+      def agree(yes_or_no_question)
+        $stdout.print(yes_or_no_question)
+        $stdin.gets.to_s =~ /^y(es)?/i
+      end
+
+      # Like capistrano's built-in on(), but connects to the server as root.
+      # To use a user other than root, set :atlas_privileged_user or
+      # specify :privileged_user as a server property.
+      #
+      #   task :reboot do
+      #     privileged_on roles(:all) do
+      #       execute :shutdown, "-r", "now"
+      #     end
+      #   end
+      #
+      def privileged_on(*args, &block)
+        on(*args) do |host|
+          if host.nil?
+            instance_exec(nil, nil, &block)
+          else
+            original_user = host.user
+
+            begin
+              host.user = host.properties.privileged_user ||
+                          fetch(:atlas_privileged_user)
+              instance_exec(host, original_user, &block)
+            ensure
+              host.user = original_user
+            end
+          end
+        end
+      end
+
+      # Uploads the given string or file-like object to the current host
+      # context. Intended to be used within an on() or privileged_on() block.
+      # Accepts :owner and :mode options that affect the permissions of the
+      # remote file.
+      #
+      def put(string_or_io, remote_path, opts={})
+        sudo_exec = ->(*cmd) {
+          cmd = [:sudo] + cmd if opts[:sudo]
+          execute *cmd
+        }
+
+        tmp_path = "/tmp/#{SecureRandom.uuid}"
+
+        owner = opts[:owner]
+        mode = opts[:mode]
+
+        source = if string_or_io.respond_to?(:read)
+          string_or_io
+        else
+          StringIO.new(string_or_io.to_s)
+        end
+
+        sudo_exec.call :mkdir, "-p", File.dirname(remote_path)
+
+        upload!(source, tmp_path)
+
+        sudo_exec.call(:mv, "-f", tmp_path, remote_path)
+        sudo_exec.call(:chown, owner, remote_path) if owner
+        sudo_exec.call(:chmod, mode, remote_path) if mode
+      end
+
+
+      # Read the specified file from the local system, interpret it as ERb,
+      # and upload it to the current host context. Intended to be used with an
+      # on() or privileged_on() block. Accepts :owner, :mode, and :binding
+      # options.
+      #
+      # Templates with relative paths are first searched for in
+      # lib/capistrano/atlas/templates in the current project. This gives
+      # applications a chance to override. If an override is not found, the
+      # default template within the capistrano-atlas gem is used.
+      #
+      #   task :create_database_yml do
+      #     on roles(:app, :db) do
+      #       within(shared_path) do
+      #         template fetch(:database_yml_template_path),
+      #                  "config/database.yml",
+      #                  :mode => "600"
+      #       end
+      #     end
+      #   end
+      #
+      def template(local_path, remote_path, opts={})
+        binding = opts[:binding] || binding
+
+        unless local_path.start_with?("/")
+          override_path = File.join("lib/capistrano/atlas/templates", local_path)
+
+          unless File.exist?(override_path)
+            override_path = File.join(
+              "lib/capistrano/atlas/templates",
+              local_path
+            )
+            if File.exist?(override_path)
+              compatibility_warning(
+                "Please move #{override_path} from lib/capistrano/atlas "\
+                "to lib/capistrano/atlas to ensure future compatibility with "\
+                "capistrano-atlas."
+              )
+            end
+          end
+
+          local_path = if File.exist?(override_path)
+            override_path
+          else
+            File.expand_path(File.join("../templates", local_path), __FILE__)
+          end
+        end
+
+        erb = File.read(local_path)
+        rendered_template = ERB.new(erb).result(binding)
+
+        put(rendered_template, remote_path, opts)
+      end
+    end
+  end
+end
+