Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A quick Sprinkle for your server
Ruby
branch: master

README.md

README

This repository contains a Sprinkle implementation that is designed to be easy to use and customize.

You can either it as a base for your own Sprinkle stack, or just as an example to help you get started.

The supplied recipe and packages enable you to configure an Ubuntu system as a Web server. It's simple to modify them, or to add your own.

Read the section on Customizing Spritz for details about the structure, and how to change the system for your own needs.

Usage

Fork this repository on GitHub. Then create a local clone and branch:

git clone git@github.com:your-github-account/spritz.git
git remote add upstream git://github.com/stuartellis/spritz.git
git checkout -b your-branch 

Use Bundler to install the dependencies:

bundle install

Check that the target system meets these requirements:

  • You need a user account that can run administrative commands with sudo
  • This account must be accessible with SSH
  • RECOMMENDED: For security, this account should use SSH key-based authentication

Sprinkle does not require any other software on the target system.

To run the default recipe on the target system:

sprinkle -s install.rb <target_address> <email_address> <remote_account>

For example:

sprinkle -s install.rb myserver.mydomain.com me@mydomain.com deploy

This connects to the target with SSH, logs in as the user deploy, and immediately applies the recipe.

To run a different recipe on the target system:

sprinkle -s install.rb <target_address> <email_address> <remote_account> <recipe_name>

To see the options for Sprinkle:

sprinkle --help

Customizing Spritz

You may easily modify or replace any of the three parts of this system:

  • The command-line script install.rb
  • The recipes in recipes/
  • The package definitions in packages/

The supplied install.rb is designed for the simplest case - to read settings from the command-line and execute the recipe on a single remote server with Capistrano.

If you have more complex needs, treat this script as an example, and use your own instead.

You may use standard Ruby syntax in any of these files. The packages themselves use the Sprinkle DSL. Refer to the resources below for help and examples.

Resources

Articles

Other Sprinkle Stacks

This Sprinkle stack owes a lot to:

Contact

Email:

stuart@stuartellis.eu

License

(The MIT License)

Copyright 2013, Stuart Ellis

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.

Something went wrong with that request. Please try again.