1
0
mirror of https://github.com/Llewellynvdm/deploy.sh.git synced 2024-06-03 13:30:46 +00:00

cleaned up a bit and edited README

This commit is contained in:
Jack Engqvist Johansson 2012-04-21 03:24:39 +02:00
parent 8d5b113e7e
commit 15b0c78335

54
README
View File

@ -1,27 +1,51 @@
DEPLOY.SH - README COMFIRM DEPLOY.SH - README
================== ==========================
(C) 2012 Comfirm AB
Deploy your code, files, configurations etc. to multiple servers via ssh. Deploy your code, files, configurations etc. to multiple servers via ssh.
Perfect for the cloud. Written as a shell script (standard bourne shell) and Perfect for the cloud. Written as a shell script (standard bourne shell) and
runs on every unix server. No need for remote install. Just run the runs on every unix server. No need for remote install. Just run the
deploy.sh script on the local machine. deploy.sh script on the local machine.
Authors:
Jack Engqvist Johansson, Comfirm AB
http://comfirm.se
USAGE USAGE
===== =====
./deploy begin Run begin script To deploy, run:
./deploy copy Copy files to /tmp ./deploy --install
./deploy replace Replace the old files
./deploy finish Run the finish script
To deploy run: To update already existing deployment, run:
./deploy install ./deploy --update
To update already existing deployment run: Partial deployment options:
./deploy update ./deploy --begin Run begin script
./deploy --copy Copy files to /tmp
./deploy --replace Replace the old files
./deploy --finish Run the finish script
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.
Note:
This script was designed for cloud computing.
INSTALLATION INSTALLATION
============ ============
Coming soon... * Copy deploy.conf to /etc/deploy.conf
* Create a .deploy file in your project. You can use the sample deploy file
GOOD TO KNOW 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
Coming soon... 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
the deploy.conf automaticly.
* 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.