Skip to content
This repository has been archived by the owner on Mar 14, 2023. It is now read-only.

Expanded on the documentation #80

Merged
merged 2 commits into from
Jun 24, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,39 @@ shipit.log('hello %s', 'world');
- [OpenSSH](http://www.openssh.com/) 5+
- [rsync](https://rsync.samba.org/) 3+

### Customising environments

You can overwrite all default variables defined as part of the `default` object.

```js
module.exports = function (shipit) {
shipit.initConfig({
staging: {
servers: 'staging.myproject.com',
workspace: '/home/vagrant/website'
branch: 'dev'
},
production: {
servers: [{
host: 'app1.myproject.com',
user: 'john',
}, {
host: 'app2.myproject.com',
user: 'rob',
}],
branch: 'production',
workspace: '/var/www/website'
}
});

...
shipit.task('pwd', function () {
return shipit.remote('pwd');
});
...
};
```

## Known Plugins

### Official
Expand Down