资源说明：kStrano (KumaStrano) is a Capistrano deployment “recipe” for Kunstmaan specific applications to make our job of deploying a lot easier. It integrates with Airbrake, Jenkins and Campfire.

# Introducing [kStrano][kstrano]

[Capistrano][capistrano] is an open source tool for running scripts on multiple servers. It’s primary use is for easily deploying applications. [kStrano][kstrano] (KumaStrano) is a deployment “recipe” to work with Kunstmaan specific applications to make your job a lot easier.

# Prerequisites

* SSH access to the server you are deploying to
* Must have a working [Ruby][ruby] and [RubyGems][rubygems] installed on your local machine
 * [kStrano][kstrano] has been tested on:
  * OSX Lion using [Ruby][ruby] (1.8.7, 1.9.2), [RubyGems][rubygems] (1.8.10)
  * Ubuntu using [Ruby][ruby] (1.8.7), [RubyGems][rubygems] ()
 * When you still need to install [Ruby][ruby], take a look at [Ruby Version Manager][rvm] or [rbenv][rbenv], which makes installing ruby super easy!
  * [Tutorial on how to install rvm on ubuntu][rvmtut]

# Installing [kStrano][kstrano]

Before you install make sure you have no older versions of [kStrano][kstrano] or [Capifony][capifony]:

```bash
gem uninstall kstrano
```

You can install kStrano using rubyGems:

```bash
gem install kstrano
gem cleanup railsless-deply, capifony, capistrano
```

Or you can download the source and install it manually:

```bash
gem build kstrano.gemspec
gem install kstrano-.gem
```

# Configuring your project

```bash
cd to/your/project/path
kumafy .
```

You can also do a force install, which will update all the files:

```bash
cd to/your/project/path
kumafy . --force
```

# Available [kStrano][kstrano] commands

* cap kuma:fix:cron, this will run the fixcron command on the server from [kDeploy][kdeploy].
* cap kuma:fix:perms, this will run the fixperms command on the server from [kDeploy][kdeploy].
* cap kuma:fpm:reload, this will reload fpm on the server.
* cap kuma:fpm:restart, this will restart fpm on the server.
* cap kuma:fpm:graceful_restart, this will restart fpm on the server gracefully.
* cap kuma:apc:clear, this will clear the apc cache.
* cap kuma:changelog, this will show the log of what changed compared to the deployed version
* cap kuma:sync, this will sync the database and rsync the uploaded files from online to local

* cap files:move:to_local, this will rsync the uploaded files from online to local

# PHP recipe

The PHP recipe is based on [Capifony][capifony], and it adds a few things to make it work with our hosting platform at Kunstmaan.

by default the configuration files are made for Symfony version > 2.1, and they use composer. To make it work with a version without composer change

```ruby
set :use_composer, true
set :update_vendors, false
```

to

```ruby
set :use_composer, false
set :vendors_mode, "install"
set :update_vendors, true
```

in your deploy.rb

## Minimal setup

- Add param to your github repo
- Run ./param encode and add app/config/parameters.aes to your github repo
- Commit the changes
- Run ```cap deploy:setup```

From now on you should be able to run ```cap:deploy``` to deploy the project...

## Configuration

kStrano specific configuration options

```ruby
set :force_schema, false     # when true, schema:update will be run (see gem deploy:schema:update)
set :force_migrations, false # when true, migrations will be run (see gem deploy:migrations)

set :bundler_install, true   # when true, bundler will run an install
set :npm_install, true       # when true, npm install will be run after composer install
set :bower_install, true     # when true, bower install will be run after npm install
set :grunt_build, true      # when true, grunt build will be run after bower install
set :gulp_build, false        # when true, gulp build will be run after bower install
```

These options are on by default, you can overwrite these in your deploy.rb or by running your cap deploy with -s (ex. cap deploy -s force_schema=true)

The following defaults of [Capifony][capifony] are set in kStrano:

```ruby
set :copy_vendors, true                 # when true, vendors will be copied from a previous release

set :dump_assetic_assets, true          # when true, use the assetic bundle
set :interactive_mode, false            # when false, it will never ask for confirmations (migrations task for instance)
set :clear_controllers, true            # when true, removes the app_*.php files from web/

set (:symfony_env_prod) {"#{env}"}      # the symfony environment variable is set to what's configured in env

set :uploaded_files_path, 'web/uploads' # the path where your files are uploaded
```

For further configuration options see [Capifony][capifony].

## Custom commands for PHP next to the one capifony makes available:

* cap deploy:migrations, this will deploy and execute the pending migrations
* cap deploy:schema:update, this will deploy and update the schema
* cap deploy:clean, this will deploy without copying the vendors
* cap deploy:prefer:source, this will deploy without copying the vendors and using composer option --prefer-source

## Placing the site in Maintenance mode
To place the site in maintenance mode, we first need to edit the htaccess file to redirect users to the maintenance page.
Place the following snippet in your htaccess file.

```bash
ErrorDocument 503 /maintenance.html
RewriteBase /
RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png|js)$
RewriteCond %{DOCUMENT_ROOT}/maintenance.html -f
RewriteCond %{ENV:REDIRECT_STATUS} !=503
RewriteCond %{REMOTE_ADDR} !^#Place the allowed ip addresses here (e.g. 127\.0\.0\.1)
RewriteRule ^.*$ - [R=503,L]
```

This will present the maintenance page to the user if the maintenance.html file is present and the user's IP is not allowed.
To place the site in maintenance mode, issue the next command.
This command will create a maintenance.html file in your data/releases/*/web directory

```bash
cap deploy:web:disable
```

In order to place the site out of maintenance mode, issue the next command. This command will remove the created
maintenance.html file that was created by the previous command.

```bash
cap deploy:web:enable
```

# Play recipe

The play recipe is a very simple recipe which is based on [railsless-deploy][railslessdeploy] and adds tasks to package the app, start and stop the server.

If you want newrelic support, make sure you put the jar in newrelic/newrelic.jar.

## Available commands

* cap play:start, this will start the play server
* cap play:stop, this will stop the current play server

# Drupal recipe

# Magento recipe

### Customizing the maintenance.html
The standard maintenance.html page just states that the site is in maintenance and will be back shortly.
In order to have a custom maintenance page, you need to set the maintenance_template_path in your deploy.rb.

```bash
set :maintenance_template_path, "location of your custom template"
```

Now you will see your own custom maintenance page. Note that the deploy:web:disable command copies the content from the template to the maintenance.html file.
So you can not use relative paths in your custom template if you want to show images, custom css etc.

# Changelog

* 30/07/2014 (version 1.3.0)
 * Add gulp support

* 19/06/2014 (version 1.2.0)
 * Add bundler support

* 01/08/2013 (version 1.1.5)
 * revert changes from 23/07/2013

* 23/07/2013 (version 1.1.4)
 * command added kuma:fpm:graceful_restart
 * commands removed kuma:apc:prepare, kuma:apc:clear

* 22/07/2013 (version 1.1.3)
 * bower support disabled by default, added to your deploy.rb on 'kumafy .'

* 10/07/2013 (version 1.1.0)
 * updated to work with [Capifony][capifony] 2.2.10
 * multiple recipes available for now play, symfony2
 * fix for clearing the APC cache
 * bower support

* 13/02/2013 (version 0.0.30)
 * updated to work with [Capifony][capifony] 2.2.7


* 24/08/2012 (version 0.0.21)
 * by default it works with Symfony version > 2.1 now, and it uses composer
 * [kCapifony][kcapifony] isn't needed anymore, from now on it works directly with [Capifony][capifony]
 * updated to work with the new version of [Capifony][capifony]
 * removed vendors from the shared folder to the release folder, and copy it with each deploy
 * clean up the gem no jenkins, campfire and airbrake support anymore
 * added extra commands like fpmreload, fpmrestart, apcclear
 * updated the default config files like: deploy.rb, staging.rb, production.rb, build.xml, etc.
 * fix to make the forward_agent working
 * small fixes


[![Analytics](https://ga-beacon.appspot.com/UA-3160735-7/Kunstmaan/kStrano)](https://github.com/igrigorik/ga-beacon)


[kstrano]: https://github.com/Kunstmaan/kStrano "kStrano"
[capistrano]: https://github.com/capistrano/capistrano "Capistrano"
[ruby]: http://www.ruby-lang.org/ "Ruby"
[rbenv]: https://github.com/sstephenson/rbenv "Rbenv"
[rubygems]: http://rubygems.org/ "RubyGems"
[capistranoext]: https://github.com/jamis/capistrano-ext "Capistrano Extensions"
[rvm]: http://beginrescueend.com/ "Ruby Version Manager"
[rvmtut]: http://rubysource.com/installing-ruby-with-rvm-on-ubuntu/ "Ruby Version Manager Ubuntu tutorial"
[symfony]: http://symfony.com/ "Symfony"
[capifony]: https://github.com/everzet/capifony "Capifony"
[kcapifony]: https://github.com/Kunstmaan/kCapifony "kCapifony"
[kdeploy]: https://github.com/Kunstmaan/kDeploy "kDeploy"
[kbot]: https://github.com/Kunstmaan/kBot "kBot"
[railslessdeploy]: https://github.com/leehambley/railsless-deploy "railsless-deploy"

联系我们：verysource_com

CopyRight © 2008-2022 verySource.Com All Rights reserved.　京ICP备17048824号-1　京公网安备：11010502034788