Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 61 lines (40 sloc) 1.769 kB
9379966 @indexzero [doc] Update README.md
indexzero authored
1 # haibu-carapace
dbfffd8 @bmeck plugin example made, readme started
bmeck authored
2
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
3 Haibu Drone's Little Shell
9379966 @indexzero [doc] Update README.md
indexzero authored
4
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
5 ## What is Carapace
dbfffd8 @bmeck plugin example made, readme started
bmeck authored
6
dbe57e5 @Marak [docs]: Updating Docs
Marak authored
7 Carapace is an process wrapper for Node.js applications that is part of the [Haibu][1] Network.
47df7c1 @indexzero [fix test doc dist] A couple of small fixes to carapace; updated test…
indexzero authored
8 Carapace also provides a plugin system to simplify deployment and development of applications.
9379966 @indexzero [doc] Update README.md
indexzero authored
9
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
10 ## What can I do with Carapace?
dbfffd8 @bmeck plugin example made, readme started
bmeck authored
11
dbe57e5 @Marak [docs]: Updating Docs
Marak authored
12 By utilizing Carapace you can help automate deployments of applications into a custom environment.
42509fd @Marak [docs]: Updating ReadMe
Marak authored
13 Combining Carapace with the [Forever][3] Daemon can allow you run the application in the environment indefinitely.
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
14
15 ## Carapace CLI Options
16
47df7c1 @indexzero [fix test doc dist] A couple of small fixes to carapace; updated test…
indexzero authored
17 `carapace --plugin [plugin] --[plugin] [options] application [options]`
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
18
19 #### *Plugins*
20 `--plugin [plugin]`
21
22 Plugin to use with the carapace instance
23
24 #### *Plugin Options*
25 `--[plugin] [options]`
26
27 Option to be passed to the [plugin]
28
29 #### *Application & Application's Options*
30 `[application] [application's CLI options]`
31
32 Any options that isn't consumed by the Carapace will automatically be passed to the application
33
34 ## Default Plugins
35 List of known plugins, and options (if any) used by them
36
37 * chdir - directory to change into
38 * heartbeat - time in micro-seconds between 'carapace::heartbeat' events
9379966 @indexzero [doc] Update README.md
indexzero authored
39 * coffee - spawn `.coffee` files
40 * setuid - set the uid of the spawned process
41 * net - automatically listen on a new port if `EADDRINUSE` is thrown
42
43 ## Installation
44
45 ``` bash
46 $ [sudo] npm install carapace
47 ```
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
48
49 ## Run Tests
50 All of the `carapace` tests are written in [vows][4]
51
d7567bd @indexzero [doc] Update README.md
indexzero authored
52 ``` bash
53 $ npm test
54 ```
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
55
56 #### Author: [Nodejitsu Inc.](http://www.nodejitsu.com)
9379966 @indexzero [doc] Update README.md
indexzero authored
57 #### Maintainers: [Charlie Robbins](https://github.com/indexzero), [Bradley Meck](https://github.com/bmeck), [Jameson Lee](https://github.com/drjackal)
12e493a @jamesonjlee [doc] readme updated.
jamesonjlee authored
58
59 [1]:https://github.com/nodejitsu/haibu
60 [3]:https://github.com/indexzero/forever
61 [4]:https://github.com/cloudhead/vows
Something went wrong with that request. Please try again.