deploy.sh/README

64 lines
1.8 KiB
Plaintext
Raw Normal View History

2012-04-21 01:24:39 +00:00
COMFIRM DEPLOY.SH - README
==========================
(C) 2012 Comfirm AB
2012-04-20 19:57:06 +00:00
Deploy your code, files, configurations etc. to multiple servers via ssh.
2012-04-21 01:42:43 +00:00
Perfect for the cloud. Written as a shell script (sh, standard bourne shell) and
2012-04-20 19:57:06 +00:00
runs on every unix server. No need for remote install. Just run the
deploy.sh script on the local machine.
2012-04-21 01:24:39 +00:00
Authors:
Jack Engqvist Johansson, Comfirm AB
http://comfirm.se
2012-04-21 01:38:52 +00:00
License:
BSD 3-Clause
See the LICENSE file
2012-04-20 19:57:06 +00:00
USAGE
=====
2012-04-21 01:24:39 +00:00
To deploy, run:
./deploy --install
2012-04-20 19:57:06 +00:00
2012-04-21 01:24:39 +00:00
To update already existing deployment, run:
./deploy --update
2012-04-20 19:57:06 +00:00
2012-04-21 01:38:52 +00:00
It will run copy, replace and update-s2...
2012-04-21 01:24:39 +00:00
Partial deployment options:
./deploy --begin Run begin script
./deploy --copy Copy files to /tmp
./deploy --replace Replace the old files
./deploy --finish Run the finish script
2012-04-21 01:38:52 +00:00
./deploy --update-s2 Run the update script, only
2012-04-20 19:57:06 +00:00
2012-04-21 01:24:39 +00:00
WHAT YOU NEED
=============
* The same username to all servers.
* An ssh keyfile without passphrase.
* The ssh key should be the same for all servers.
* [optional] Root access or sudo without password.
2012-04-21 01:42:43 +00:00
* sh or bash.
2012-04-21 01:24:39 +00:00
Note:
This script was designed for cloud computing.
2012-04-20 19:57:06 +00:00
2012-04-21 01:24:39 +00:00
INSTALLATION
2012-04-20 19:57:06 +00:00
============
2012-04-21 01:24:39 +00:00
* Copy deploy.conf to /etc/deploy.conf
* Create a .deploy file in your project. You can use the sample deploy file
shipped with this release. Just make sure to rename it.
* Put the deploy.sh in a handy place like /usr/local/sbin/deploy.sh and make it
executable. If you want you can even put it in your project location.
TIPS & TRIX
===========
* To make it even easier you can let any heartbeat software update
2012-04-21 01:42:43 +00:00
the deploy.conf automatically.
2012-04-21 01:24:39 +00:00
* Write your .deploy file with if statements etc. to make it easy to rerun it
everytime there's new servers or if the old ones need any updates.
2012-04-21 01:42:43 +00:00
2012-04-21 01:47:52 +00:00
Don't be afraid to fork it and send a pull request. Any improvement are welcome.
2012-04-21 01:42:43 +00:00