Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 201 lines (127 sloc) 8.152 kb
a28ddcc @Marak [docs] Updating travis build image to master branch
Marak authored
1 # jitsu [![Build Status](https://secure.travis-ci.org/nodejitsu/jitsu.png?branch=master)](http://travis-ci.org/nodejitsu/jitsu)
780a590 @Marak [misc] Updating ReadMe
Marak authored
2 *Flawless command line deployment of Node.js apps to the cloud*
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
3
2614d97 @Marak [ux] Reduced color usage. Added assets folder. Moved / updated Screen…
Marak authored
4 <img src="https://github.com/nodejitsu/jitsu/raw/master/assets/jitsu.png"/>
0974136 @Marak [misc] Added new screenshot
Marak authored
5
d2739f2 @Marak [misc] Updating Readme
Marak authored
6 ## Overview
7
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
8 [Jitsu](https://github.com/nodejitsu/jitsu) is a [Command Line Tool (CLI)](http://en.wikipedia.org/wiki/Command-line_interface) for managing and deploying Node.js applications. It's open-source and easy to use. [We've](https://github.com/nodejitsu) designed `jitsu` to be suitable for command line beginners, but still be powerful and extensible enough for production usage.
d2739f2 @Marak [misc] Updating Readme
Marak authored
9
a23f504 @Marak [docs] Updating ReadMe
Marak authored
10 `jitsu` requires `npm`, the [node package manager](http://npmjs.org).
d2739f2 @Marak [misc] Updating Readme
Marak authored
11
a23f504 @Marak [docs] Updating ReadMe
Marak authored
12 ## One-line jitsu install
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
13
69835cd @Marak [docs] Updated ReadMe
Marak authored
14 [sudo] npm install jitsu -g
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
15
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
16 ## Features
17
e4915fe @zemanel Fix typo on README.md
zemanel authored
18 `jitsu` is built on some amazing technologies which we've been actively building with the community since 2009. `jitsu` is fully extendable and extremely modular ( see [Libraries](#Libraries) section ).
d2739f2 @Marak [misc] Updating Readme
Marak authored
19
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
20 - Allows for seamless deployment of your Node.js applications to the cloud
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
21 - Ships with use-full boilerplates and sample applications through [Node Apps](https://github.com/nodeapps) project integration
915b0b7 @Marak [misc] Updating ReadMe
Marak authored
22 - Fully supports `npm` dependency resolution on deployment to [Nodejitsu](http://nodejitsu.com)
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
23 - Full support of [Nodejitu's API](https://github.com/nodejitsu/nodejitsu-api) ( a plethora of node.js goodies )
24 - Integrated multi-level multi-transport logging support via [Winston](https://github.com/flatiron/winston)
25 - Too many to list... seek [further knowledge ](https://github.com/nodejitsu/handbook) or just try it out!
780a590 @Marak [misc] Updating ReadMe
Marak authored
26
a23f504 @Marak [docs] Updating ReadMe
Marak authored
27
28 # One-Line Node App Installation
29
de884e6 @Marak [docs] Minor updates to README
Marak authored
30 **If you don't have an application yet, you can use one of ours!**
a23f504 @Marak [docs] Updating ReadMe
Marak authored
31
32 jitsu install
33
34 # One-Line Node App Deployment
b87d33c @Marak [docs] Updating ReadMe
Marak authored
35
780a590 @Marak [misc] Updating ReadMe
Marak authored
36 jitsu deploy
37
de884e6 @Marak [docs] Minor updates to README
Marak authored
38 *( inside the path of your Node.js application )*
39
b87d33c @Marak [docs] Updating ReadMe
Marak authored
40
780a590 @Marak [misc] Updating ReadMe
Marak authored
41 This will create a new application, package.json, and deploy your path to [Nodejitsu](http://nodejitsu.com). If it's your first deployment, you'll be prompted for some information such as *subdomain* and *start script* but it's really easy and we promise it will only take a few seconds.
42
b87d33c @Marak [docs] Updating ReadMe
Marak authored
43 If you have any issues deploying your node.js application please feel free to open up an issue on the [Github Issues](https://github.com/nodejitsu/jitsu/issues) section of this page, we'll have someone get back to you in a flash!
780a590 @Marak [misc] Updating ReadMe
Marak authored
44
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
45 ## Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored
46
a8b187b @Marak [misc] Updating Readme
Marak authored
47 `jitsu` is mostly self documenting. After installation, run the `jitsu` command from your command line.
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
48
49 If it's your first time using `jitsu`, you will be prompted to login with an existing account or create a new account.
50
2614d97 @Marak [ux] Reduced color usage. Added assets folder. Moved / updated Screen…
Marak authored
51 <img src="https://github.com/nodejitsu/jitsu/raw/master/assets/login.png"/>
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
52
a8b187b @Marak [misc] Updating Readme
Marak authored
53 ## After you've logged in, you can start deploying apps immediately!
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
54
55
ab8d16a @Marak [docs] Cleaning up
Marak authored
56
780a590 @Marak [misc] Updating ReadMe
Marak authored
57 ## Command Line Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored
58
992e62a @Marak Updating Readme
Marak authored
59 `jitsu` is mostly self-documenting. Try any of these commands to get started.
60
780a590 @Marak [misc] Updating ReadMe
Marak authored
61
62 **Usage:**
63
64 jitsu <resource> <action> <param1> <param2> ...
65
66 **Common Commands:**
0dc265e [docs] added docs for the signup and login commands
nicoreed authored
67
68 *To sign up for [Nodejitsu](http://nodejitsu.com)*
69
70 jitsu signup
71
72 *To log into [Nodejitsu](http://nodejitsu.com)*
73
74 jitsu login
75
de884e6 @Marak [docs] Minor updates to README
Marak authored
76 *To install a pre-built application*
77
78 jitsu install
79
37eba04 @Marak [ux] Removed documentation for `apps create` command. Using the creat…
Marak authored
80 *Deploys application in the current path to [Nodejitsu](http://nodejitsu.com)*
780a590 @Marak [misc] Updating ReadMe
Marak authored
81
82 jitsu deploy
83
84 *Lists all applications for the current user*
85
86 jitsu list
87
88 *Additional Commands*
89
90 jitsu apps
91 jitsu snapshots
92 jitsu users
04816e5 [docs] added the logs and database commands to README.md
Nico Reed authored
93 jitsu logs
94 jitsu databases
780a590 @Marak [misc] Updating ReadMe
Marak authored
95 jitsu conf
96 jitsu logout
97
98
99
ab8d16a @Marak [docs] Cleaning up
Marak authored
100 ### Help
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
101
b87d33c @Marak [docs] Updating ReadMe
Marak authored
102 `jitsu` is mostly self documenting. We suggest just trying it out. All commands will yield friendly messages if you specify incorrect parameters. If you find anything difficult to use, please open up a [Github issue](https://github.com/nodejitsu/jitsu/issues) or pull request!
780a590 @Marak [misc] Updating ReadMe
Marak authored
103
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
104 jitsu help
105 jitsu help apps
106 jitsu help snapshots
107 jitsu help users
04816e5 [docs] added the logs and database commands to README.md
Nico Reed authored
108 jitsu help logs
109 jitsu help databases
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
110 jitsu help config
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
111
7e002ad @Marak [misc] Added .jitsuconf section to Readme
Marak authored
112 ## .jitsuconf file
113
b87d33c @Marak [docs] Updating ReadMe
Marak authored
114 All configuration data for your local `jitsu` install is located in the *.jitsuconf* file in your home directory. Directly modifying this file is not really advised. You should be able to make all configuration changes via:
7e002ad @Marak [misc] Added .jitsuconf section to Readme
Marak authored
115
1e4183e @mmalecki [fix docs] Fix indent in code blocks
mmalecki authored
116 jitsu config
cbe727d @dominictarr [doc] add --localconf and --jitsuconf docs to README.md
dominictarr authored
117
118 If you need to have multiple configuration files, use --localconf or --jitsuconf options.
119
c834fdc @blakmatrix [doc] provided some `jitsu config` examples
blakmatrix authored
120 Some Examples:
121
122 jitsu config set colors false # disable colors
123 jitsu config set timeout 480000 # set request timeouts to 8 minutes
124 jitsu config set analyze false # disable package analyzer
125 jitsu config set protocol https # Always use HTTP Secure
126
cbe727d @dominictarr [doc] add --localconf and --jitsuconf docs to README.md
dominictarr authored
127 ##jitsu options
128
1e4183e @mmalecki [fix docs] Fix indent in code blocks
mmalecki authored
129 jitsu [commands] [options]
130
131 --version print jitsu version and exit
132 --localconf search for .jitsuconf file in ./ and then parent directories
133 --jitsuconf [file] specify file to load configuration from
134 --noanalyze skip require-analyzer: do not attempt to dynamicially detect dependencies
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
135
079055a @pksunkara Better documentation for using jitsu behind a proxy, Fix #121
pksunkara authored
136 ##jitsu behind proxy
137
138 If you are behind a proxy and you haven't configured jitsu to use it, `jitsu` will throw an error, `Jitsu requires you to connect to Nodejitsu's stack (api.nodejitsu.com)`.
139 In order to solve this issue, you can configure jitsu to use a proxy by executing the following command.
140
141 jitsu config set proxy http://proxy.domain.com:3128/
142
143 If you need to authenticate yourselves to the proxy, you can try this command.
144
145 jitsu config set proxy http://user:pass@proxy.domain.com:3128/
b87d33c @Marak [docs] Updating ReadMe
Marak authored
146
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored
147 <a name="Libraries"></a>
f2d3ac3 @coderarity [doc] add jitsu hooks documentation
coderarity authored
148
149 ##jitsu hooks
150
151 You can add pre-deploy and post-deploy hooks to jitsu for running build scripts, tagging releases or anything else you want to do. These are hooks that are executed before or after deploying your application on the local machine. They are stored in your package.json:
152
153 {
154 "name": "test-app",
155 "subdomain": "test-app",
156 "scripts": {
157 "predeploy": "echo This will be run before deploying the app",
158 "postdeploy": "echo This will be run after deploying the app",
159 "start": "app.js"
160 },
161 "engines": {
162 "node": "0.6.x"
163 },
164 "version": "0.0.0"
165 }
166
167 Which results in the following output when deploying:
168
169 $ jitsu deploy
170 info: Welcome to Nodejitsu nodejitsu
171 info: It worked if it ends with Nodejitsu ok
172 info: Executing command deploy
173 info: Analyzing your application dependencies in app.js
174 info: Checking app availability test-app
175 info: Creating app test-app
176 This will be run before deploying the app
177 info: Creating snapshot 0.0.0
178 info: Updating app test-app
179 info: Activating snapshot 0.0.0 for test-app
180 info: Starting app test-app
181 info: App test-app is now started
182 info: http://test-app.jit.su on Port 80
183 This will be run after deploying the app
184 info: Nodejitsu ok
185
b87d33c @Marak [docs] Updating ReadMe
Marak authored
186 ## Libraries
187 `jitsu` is built on a few well developed, well maintained Node.js libraries. The [Nodejitsu](http://nodejitsu.com) team and friends have been building and using these projects actively for the past two years. They are the most used Node libraries (see: [http://search.npmjs.org/](http://search.npmjs.org/)) and are actively maintained by Nodejitsu and other core members of the Node.js community. Each library serves a specific function and we highly suggest you check each one out individually if you wish to increase your knowledge of Node.js
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored
188
d4d8eae @Marak [ux] Updated deploy usage
Marak authored
189 - [npm](http://npmjs.org) - Node Package Manager
f1edb58 @dipen Corrected libraries links in README.md
dipen authored
190 - [colors](https://github.com/marak/colors.js) - Terminal Colors module
191 - [optimist](https://github.com/substack/node-optimist) - CLI Options Parsing
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
192 - [request](https://github.com/mikeal/request) - http request module
f08a670 @Marak Updating ReadMe
Marak authored
193 - [async](https://github.com/caolan/async) - Asynchronous Iteration
194 - [vows](http://vowsjs.org) - Asynchronous BDD testing library
f1edb58 @dipen Corrected libraries links in README.md
dipen authored
195 - [winston](https://github.com/flatiron/winston) - Multi-transport logging library
f08a670 @Marak Updating ReadMe
Marak authored
196
5d9044f @Marak [misc] Added Aliases section in ReadMe
Marak authored
197 ### Need more?
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
198 The documentation for `jitsu` and the [Nodejitsu](http://nodejitsu.com) APIs is open-source and a work in-progress. For more information checkout the [Nodejitsu Handbook](https://github.com/nodejitsu/handbook)
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
199
0dc265e [docs] added docs for the signup and login commands
nicoreed authored
200 #### (C) Copyright 2010, [Nodejitsu](http://nodejitsu.com) Inc.
Something went wrong with that request. Please try again.