Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[dist] Regenerate site

  • Loading branch information...
commit 16f7e80ff9319bdc9cb3397c713ed740160efc2d 1 parent 217e7b4
@indexzero indexzero authored
View
85 public/a-quickstart/faq.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,18 +109,16 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">a-quickstart/faq</h1>
+ <h1 class="title">FAQ</h1>
</div>
- <div class="content"><h1>Frequently Asked Questions</h1>
-<p><a name='faq'></a>
-
+ <div class="content"><p><hr>
+<strong>For more information about pricing, see <a href="http://nodejitsu.com/paas/faq.html">the pricing FAQ</a>.</strong>
</p>
-<p><strong>For more information about pricing, see <a href="http://nodejitsu.com/paas/faq.html">the pricing FAQ</a>.</strong>
+<hr>
-</p>
<h2>&quot;How do I reset my password?&quot;</h2>
<p>One way is to use jitsu. Simply type:
@@ -127,14 +127,20 @@ <h1 class="title">a-quickstart/faq</h1>
<p>where <code>:username</code> is your username. Alternately, go to <a href="http://develop.nodejitsu.com/">http://develop.nodejitsu.com/</a> and click the &quot;forgot password&quot; link, where you will be prompted for your username. Either process will send you an email with further instructions.
</p>
+<p><hr>
+</p>
<h2>&quot;Is there a cheatsheet somewhere?&quot;</h2>
<p>There sure is! Check out <a href="http://cheatsheet.nodejitsu.com">http://cheatsheet.nodejitsu.com</a>.
</p>
+<p><hr>
+</p>
<h2>&quot;How are programs kept alive? Do I need to use Forever?&quot;</h2>
<p>Nodejitsu&#39;s cloud services watch your programs for you! You shouldn&#39;t have to do anything special to keep your apps running, much less use Forever.
</p>
+<p><hr>
+</p>
<h2>&quot;How can I make my app use a port other than port 80?&quot;</h2>
<p>Connecting to other servers using arbitrary ports requires no special considerations. However, <em>listening</em> for outside connections is currently limited to port 80 on the Nodejitsu platform because we require http host headers for domain name resolution of subdomains. Consequentially, each subdomain may only host one listening service.
@@ -142,6 +148,8 @@ <h1 class="title">a-quickstart/faq</h1>
<p>The ability to host TCP applications on nodejitsu and listen on non-80 ports is on our roadmap but has no associated timeline.
</p>
+<p><hr>
+</p>
<h2>&quot;How do I make Koding work with jitsu?&quot;</h2>
<p>By default, Koding will not install packages globally, due to a permission error. You can fix this by setting the
npm prefix to a location that you have permissions to access, like your home directory. To do this, simply run:
@@ -156,19 +164,21 @@ <h1 class="title">a-quickstart/faq</h1>
<p><code>npm i jitsu -g</code>
</p>
+<p><hr>
+</p>
<h2>&quot;Can I use jitsu with Cloud9 IDE (<a href="http://c9.io">http://c9.io</a>)?&quot;</h2>
<p>Yes! Follow these steps to install jitsu.
</p>
<ol>
-<li><p>Install the latest npm globally: <code>npm install -g npm</code></p>
-</li>
-<li><p>Install the latest jitsu locally: <code>npm install jitsu</code></p>
-</li>
+<li>Install the latest npm globally: <code>npm install -g npm</code></li>
+<li>Install the latest jitsu locally: <code>npm install jitsu</code></li>
</ol>
<p>Now you can use jitsu as usual. If you get error, try <code>npm rm -g jitsu &amp;&amp; npm cache clean</code>.
</p>
+<p><hr>
+</p>
<h2>&quot;How can I turn off the require-analyzer in jitsu? I want to manage my own dependencies!&quot;</h2>
<p>There are three ways to disable the require-analyzer:
@@ -178,16 +188,22 @@ <h1 class="title">a-quickstart/faq</h1>
<li>Add <code>&quot;analyze&quot;: false</code> to your package.json to disable it on a per-app basis.</li>
<li>Set &quot;analyze&quot; to <code>false</code> in your <code>~/.jitsuconf</code> to disable it on a global level.</li>
</ul>
+<p><hr>
+</p>
<h2>&quot;How Do I add my GitHub repository as a dependency?&quot;</h2>
<p>Use the following format: <code>https://github.com/:user/:repo/tarball/:branch</code>
</p>
+<p><hr>
+</p>
<h2>&quot;Why won&#39;t this C++ addon compile?&quot;</h2>
<p>Many <a href="http://nodejs.org/docs/latest/api/addons.html">C++ addons</a> require libraries that are not included in Nodejitsu&#39;s infrastructure by default. For example, <a href="https://github.com/learnboost/node-canvas">node-canvas</a> requires <a href="http://cairographics.org/">cairo</a>. Nodejitsu has cairo and many other such libraries, but may not have some more obscure ones.
</p>
+<p><hr>
+</p>
<h2>&quot;How do I specify which files not to bundle? How do I know what files are getting bundled?&quot;</h2>
-<p>Jitsu uses npm to bundle files, meaning that jitsu bundles files in exactly the same manner than npm bundles published modules. You can read about this in <a href="http://npmjs.org/doc/developers.html">npm&#39;s documentation</a>.
+<p><code>jitsu</code> uses npm to bundle files, meaning that jitsu bundles files in exactly the same manner than npm bundles published modules. You can read about this in <a href="http://npmjs.org/doc/developers.html">npm&#39;s documentation</a>.
</p>
<p>In more detail: npm uses a file called <code>.npmignore</code>, which should contain a list of files and folders to ignore for the purpose of bundling. If this file does not exist, npm will use git&#39;s ignore file, called <code>.gitignore</code>, instead. This means that, if you want to bundle files that are ignored by git, you should create an <code>.npmignore</code> even if it&#39;s blank.
@@ -196,11 +212,14 @@ <h1 class="title">a-quickstart/faq</h1>
<p>Finally, jitsu has the ability to bundle your app without deploying with the <code>jitsu package create</code> command. You can use this to make sure that the resulting .tgz file is as you expect.
</p>
+<p><hr>
+</p>
<h2>&quot;How do I fix <code>Error: package.json error: can&#39;t find starting script</code>?&quot;</h2>
<p>Nodejitsu requires a starting script in the package.json to know which script to run to start your application. You need to make sure that the scripts.start field in your package.json points to the correct starting script.
</p>
<p>A common issue is using &quot;node app&quot; as the value of scripts.start in your package.json. This won&#39;t work on Nodejitsu because the file extension is not specified. You&#39;ll need to do something along the lines of &quot;node app.js&quot;.
+
</p>
</div>
</div></article>
View
151 public/a-quickstart/hello-world.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,86 +109,63 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">a-quickstart/hello-world</h1>
+ <h1 class="title">Hello World: A Tutorial</h1>
</div>
- <div class="content"><h1>Hello World: A Tutorial</h1>
-<p><a name="hiworld"></a>
+ <div class="content"><p>In this tutorial, you will write a simple &quot;hello world&quot; web application in Node.js, and then deploy it using jitsu, Nodejitsu&#39;s command line interface. Before you get started, you should have <a href="https://github.com/joyent/node/wiki">node.js</a> installed.
</p>
-<p>In this tutorial, you will write a simple &quot;hello world&quot; web application in
-Node.js, and then deploy it using jitsu, Nodejitsu&#39;s command line interface.
-
-</p>
-<p>Before you get started, you should have
-<a href="https://github.com/joyent/node/wiki">node.js</a> installed. If you are using
-a node.js version older than v0.6.0 (not recommended) you will also need to
-separately install
-<a href="https://github.com/isaacs/npm/#readme">Node Package Manager</a> (npm).
-
+<p><hr>
</p>
<h2>Write A Server</h2>
-<p>Let&#39;s start with a very basic Node.js http server. Create a folder called
-<code>myapp/</code> and then create a file inside the folder called <code>server.js</code>. Inside
-this file, write the following code:
-
+<p>Let&#39;s start with a very basic Node.js http server. Create a folder called <code>myapp/</code> and then create a file inside the folder called <code>server.js</code>. Inside this file, write the following code:
</p>
-<pre><code>// requires node&#39;s http module
-var http = require(&#39;http&#39;);
+<pre><code class="lang-js"> <span class="comment">// requires node's http module</span>
+ <span class="keyword">var</span> http = require(<span class="string">'http'</span>);
-// creates a new httpServer instance
-http.createServer(function (req, res) {
- // this is the callback, or request handler for the httpServer
+ <span class="comment">// creates a new httpServer instance</span>
+ http.createServer(<span class="function"><span class="keyword">function</span> <span class="params">(req, res)</span> {</span>
+ <span class="comment">// this is the callback, or request handler for the httpServer</span>
- // respond to the browser, write some headers so the
- // browser knows what type of content we are sending
- res.writeHead(200, {&#39;Content-Type&#39;: &#39;text/html&#39;});
+ <span class="comment">// respond to the browser, write some headers so the </span>
+ <span class="comment">// browser knows what type of content we are sending</span>
+ res.writeHead(<span class="number">200</span>, {<span class="string">'Content-Type'</span>: <span class="string">'text/html'</span>});
- // write some content to the browser that your user will see
- res.write(&#39;&lt;h1&gt;hello, i know nodejitsu.&lt;/h1&gt;&#39;);
+ <span class="comment">// write some content to the browser that your user will see</span>
+ res.write(<span class="string">'&lt;h1&gt;hello, i know nodejitsu.&lt;/h1&gt;'</span>);
- // close the response
- res.end();
-}).listen(8080); // the server will listen on port 8080</code></pre>
-<p>That&#39;s all the code you&#39;ll need for starters. Save your server and get ready to
-deploy!
+ <span class="comment">// close the response</span>
+ res.end();
+ }).listen(<span class="number">8080</span>); <span class="comment">// the server will listen on port 8080</span></code></pre>
+<p>That&#39;s all the code you&#39;ll need for starters. Save your server and get ready todeploy!
</p>
-<h2>Deploy with Jitsu</h2>
-<p>In this tutorial, we will use <a href="http://github.com/nodejitsu/jitsu">jitsu</a> to deploy
-our &quot;hello world&quot; application. Jitsu is a
-<a href="http://en.wikipedia.org/wiki/Command-line_interface">Command Line Interface</a>
-for using Nodejitsu&#39;s platform. We&#39;ve designed jitsu to be
-suitable for command line beginners, but still be powerful and extensible
-enough for production usage. If you aren&#39;t a fan of the command line or don&#39;t
-have terminal access you can still do app deployments through the
-<a href="https://webops.nodejitsu.com/">Nodejitsu Web Application</a>.
+<p><hr>
+</p>
+<h2>Deploy with <code>jitsu</code></h2>
+<p>In this tutorial, we will use <a href="http://github.com/nodejitsu/jitsu">jitsu</a> to deploy our &quot;hello world&quot; application. <code>jitsu</code> is a
+<a href="http://en.wikipedia.org/wiki/Command-line_interface">Command Line Interface</a> for using Nodejitsu&#39;s platform. We&#39;ve designed jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage.
</p>
-<p>If this is your first time deploying an application and you are eager to get
-started, we recommend using jitsu: it has a one line installer, it&#39;s
-self-documenting, and with it you&#39;ll be able to deploy your app in seconds.
-Plus, it&#39;s what&#39;s in the tutorial.
+<p>If this is your first time deploying an application and you are eager to get started, we recommend using jitsu: it has a one line installer, it&#39;s self-documenting, and with it you&#39;ll be able to deploy your app in seconds. Plus, it&#39;s what&#39;s in the tutorial.
</p>
-<h2>Installation</h2>
+<h3>Installation</h3>
<p>In order to install jitsu, open a terminal and type:
</p>
-<pre><code> [sudo] npm install jitsu -g</code></pre>
-<p>This command will install jitsu on your system; the <code>-g</code> makes npm install it
-globally, rather than as a local module.
+<pre><code> [sudo] npm install jitsu -g
+`</code></pre>
+<p>This command will install jitsu on your system; the <code>-g</code> makes npm install it globally, rather than as a local module.
</p>
<p><img src="https://github.com/nodejitsu/jitsu/raw/master/assets/jitsu.png" alt="">
</p>
-<p>After installation, run the <code>jitsu</code> command from your command line. Since it&#39;s
-your first time using jitsu, you will be prompted to log in with an existing
-account or to create a new account.
+<p>After installation, run the <code>jitsu</code> command from your command line. Since it&#39;s your first time using jitsu, you will be prompted to log in with an existing account or to create a new account.
</p>
<p><img src="https://github.com/nodejitsu/jitsu/raw/master/assets/login.png" alt="">
@@ -195,27 +174,19 @@ <h1 class="title">a-quickstart/hello-world</h1>
<p><strong>Once you&#39;ve logged in, you can deploy your app immediately.</strong>
</p>
-<h2>One Line Deployment</h2>
+<h3>One Line Deployment</h3>
<p>Open a terminal:
</p>
-<pre><code>cd /home/me/myapp
-jitsu deploy</code></pre>
-<p>This will create a new application snapshot, generate and/or update project
-metadata, and deploy the project in the current path to
-<a href="http://nodejitsu.com">Nodejitsu</a>. If it&#39;s your first deployment, you&#39;ll be
-prompted for some information such as <em><u>your app&#39;s name</u></em>, its
-<em><u>nodejitsu subdomain</u></em>, and its <em><u>start script</u></em>. It&#39;s really easy and we promise it will
-only take a few seconds.
-
+<pre><code> cd /home/me/myapp
+ jitsu deploy</code></pre>
+<p>This will create a new application snapshot, generate and/or update project metadata, and deploy the project in the current path to <a href="http://nodejitsu.com">Nodejitsu</a>. If it&#39;s your first deployment, you&#39;ll be prompted for some information such as <em><u>your app&#39;s name</u></em>, its <em><u>nodejitsu subdomain</u></em>, and its <em><u>start script</u></em>. It&#39;s really easy and we promise it will only take a few seconds.
</p>
-<pre><code>prompt: subdomain (myapp): myapp
-prompt: scripts.start (server.js):
-prompt: version (0.0.0): </code></pre>
-<p>Now just open up your favorite browser, and go to
-<code>myapp.nodejitsu.com</code>. If everything has been set up correctly, then
-you, too, are on the path of nodejitsu!
+<pre><code> prompt: subdomain (myapp): myapp
+ prompt: scripts.start (server.js):
+ prompt: version (0.0.0):</code></pre>
+<p>Now just open up your favorite browser, and go to <code>myapp.nodejitsu.com</code>. If everything has been set up correctly, then you too, are on the path of nodejitsu!
</p>
</div>
View
48 public/a-quickstart/index.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,10 +109,10 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">a-quickstart</h1>
+ <h1 class="title">Quickstart</h1>
</div>
<div class="content"></div>
</div></article>
View
54 public/api/index.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,16 +109,12 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">api</h1>
+ <h1 class="title">JSON API</h1>
</div>
- <div class="content"><h1>JSON API</h1>
-<p><a name='api'></a>
-
-</p>
-<p>Nodejitsu provides a web API for developers who want to interact with the Nodejitsu platform programatically. This API is built to be <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">RESTful</a> and communicates via <a href="http://en.wikipedia.org/wiki/JSON">JSON</a>. The API is the most low-level way of interacting with the Nodejitsu platform. For most deployment scenarios you should use our command line tool, <a href="http://github.com/nodejitsu/jitsu">jitsu</a>, the <a href="https://webops.jit.su">online administrative interface</a>, or use our <a href="https://webhooks.nodejitsu.com">WebHook API</a> when integrating with third party services.
+ <div class="content"><p>Nodejitsu provides a web API for developers who want to interact with the Nodejitsu platform programatically. This API is built to be <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">RESTful</a> and communicates via <a href="http://en.wikipedia.org/wiki/JSON">JSON</a>. The API is the most low-level way of interacting with the Nodejitsu platform. For most deployment scenarios you should use our command line tool, <a href="http://github.com/nodejitsu/jitsu">jitsu</a>, the <a href="https://webops.jit.su">online administrative interface</a>, or use our <a href="https://webhooks.nodejitsu.com">WebHook API</a> when integrating with third party services.
</p>
<h2>API Clients</h2>
View
41 public/api/webhooks.html
@@ -41,65 +41,69 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/features" class="title">Platform Features</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/webops" class="title">Using Webops</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
+ <a href="/api/webhooks" class="title">Github Integration</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/appendix/package" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,13 +111,12 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">api/webhooks</h1>
+ <h1 class="title">Github Integration</h1>
</div>
- <div class="content"><h1>Nodejitsu Web-hook API</h1>
-<p>Access the <code>Admin</code> section on your open source node.js Github repository. Click <code>Service Hooks</code> and then <code>Nodejitsu</code>. You will be presented with a form with four fields:
+ <div class="content"><p>Access the <code>Admin</code> section on your open source node.js Github repository. Click <code>Service Hooks</code> and then <code>Nodejitsu</code>. You will be presented with a form with four fields:
</p>
<ul>
@@ -598,7 +601,9 @@ <h1 class="title">api/webhooks</h1>
<td>401</td>
<td>We tried to authenticate with github but it failed</td>
</tr>
-</table></div>
+</table>
+
+</div>
</div></article>
</div>
<!-- content -->
View
111 public/appendix/haibu.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,69 +109,58 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">appendix/haibu</h1>
+ <h1 class="title">Run it yourself With Haibu</h1>
</div>
- <div class="content"><h1>Create Your Own Cloud With Haibu</h1>
-<p><a name='haibu'></a>
+ <div class="content"><p>Haibu is an open-source tool for spawning and managing several node.js applications on a single server. It&#39;s an integral part of Nodejitsu&#39;s production stack and is fully supported by a dedicated team of core node.js developers.
</p>
-<p>Haibu is an open-source tool for spawning and managing several node.js
-applications on a single server. It&#39;s an integral part of Nodejitsu&#39;s
-production stack and is fully supported by a dedicated team of core node.js
-developers.
+<p>By installing haibu, a user creates a development environment for themselves that mirrors the functionality of Nodejitsu&#39;s cloud platform! Any project that can be deployed on Nodejitsu can be ran by haibu.
</p>
-<p>By installing haibu, a user creates a development environment for themselves
-that mirrors the functionality of Nodejitsu&#39;s cloud platform! Any project that
-can be deployed on Nodejitsu can be ran by haibu.
+<p>Haibu, which is Japanese for &quot;hive&quot;, wraps node.js applications in a &quot;carapace&quot; and converts them into managed &quot;drones&quot;. This approach allows haibu to directly interact with node.js applications and add all sorts of additional functionality. Haibu also contains a plugin system, so you can easily add even more functionality.
</p>
-<p>Haibu, which is Japanese for &quot;hive&quot;, wraps node.js applications in a &quot;carapace&quot;
-and converts them into managed &quot;drones&quot;. This approach allows haibu to directly
-interact with node.js applications and add all sorts of additional
-functionality. Haibu also contains a plugin system, so you can easily add even
-more functionality.
+<p>Haibu builds on this concept of &quot;drones&quot; and exposes a robust and granular API for interacting with your node.js applications. At a low level, haibu&#39;s API is exposed as a RESTFul HTTP webservice. Any system that supports basic HTTP requests can communicate with a haibu server. If you are working in Node.js, haibu comes with a high-level Node.js API client.
</p>
-<p>Haibu builds on this concept of &quot;drones&quot; and exposes a robust and granular API
-for interacting with your node.js applications. At a low level, haibu&#39;s API is
-exposed as a RESTFul HTTP webservice. Any system that supports basic HTTP
-requests can communicate with a haibu server. If you are working in Node.js,
-haibu comes with a high-level Node.js API client.
-
+<p><hr>
</p>
<h2>Installation</h2>
-<pre><code>[sudo] npm install haibu -g</code></pre>
+<pre><code> [sudo] npm install haibu -g</code></pre>
<p>This will install haibu globally. You can also grab the source <a href="https://github.com/nodejitsu/haibu">directly from git</a>.
</p>
+<p><hr>
+</p>
<h2>Usage</h2>
<p>To start haibu, all you have to do is run <code>haibu</code>:
</p>
-<pre><code>$ haibu
- __ __
- / /_ ______ __ / /_ __ __
- / __ \ / __ / / / / __ \ / / / /
- / / / / / /_/ / / / / /_/ / / /_/ /
- /_/ /_/ \__,_/ /_/ /_/\___/ \__,_/
-
- This is Open Source Software available under
- the MIT License.
-
- © 2010 Nodejitsu Inc.
- All Rights Reserved - www.nodejitsu.com
- haibu started @ 10.0.1.4 on port 9002 as api-server
- using plugins: config, exceptions, directories, log, http</code></pre>
-<p>Haibu is an http server that exposes a REST api on port 9002. You can either
-access this API client with a regular HTTP client, or use our <a href="https://github.com/nodejitsu/haibu-api/tree/master/node.js">haibu-api</a> module. Unfortunately, jitsu does not work with haibu&#39;s HTTP API, only the nodejitsu API.
+<pre><code> $ haibu
+ __ __
+ / /_ ______ __ / /_ __ __
+ / __ \ / __ / / / / __ \ / / / /
+ / / / / / /_/ / / / / /_/ / / /_/ /
+ /_/ /_/ \__,_/ /_/ /_/\___/ \__,_/
+
+ This is Open Source Software available under
+ the MIT License.
+
+ © 2010 Nodejitsu Inc.
+ All Rights Reserved - www.nodejitsu.com
+ haibu started @ 10.0.1.4 on port 9002 as api-server
+ using plugins: config, exceptions, directories, log, http</code></pre>
+<p>Haibu is an http server that exposes a REST api on port 9002. You can either access this API client with a regular HTTP client, or use our <a href="https://github.com/nodejitsu/haibu-api/tree/master/node.js">haibu-api</a> module. Unfortunately, jitsu does not work with haibu&#39;s HTTP API, only the nodejitsu API.
</p>
+<p><hr>
+</p>
<h2>Additional Documentation</h2>
<p>For more documentation, visit haibu&#39;s <a href="https://github.com/nodejitsu/haibu">github page</a>.
+
</p>
</div>
</div></article>
View
133 public/appendix/index.html
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<html class="no-js" lang="en">
+
+<head>
+ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+ <meta charset="utf-8">
+
+ <title>The Nodejitsu Handbook</title>
+
+ <meta name="description" content="The Nodejitsu Handbook - A gentle introduction to the art of Nodejitsu" />
+ <meta name="author" content="Nodejitsu Inc" />
+ <meta name="viewport" content="width=device-width" />
+
+ <link rel="stylesheet" href="/css/base.dev.css">
+ <link rel="stylesheet" href="http://yandex.st/highlightjs/7.3/styles/github.min.css">
+ <link rel="icon" type="image/png" href="img/favicon.png">
+
+ <script src="http://yandex.st/highlightjs/7.3/highlight.min.js"></script>
+ <script>
+ hljs.tabReplace = ' ';
+ hljs.initHighlightingOnLoad();
+ </script>
+
+</head>
+
+<body class="container">
+
+ <nav role="navigation" class="navigation">
+ <div class="row">
+ <ul>
+ <li><a href="http://nodejitsu.com/" class="sprite logo hide-text">Nodejitsu Inc.</a></li>
+ </ul>
+ </div>
+ </nav>
+
+ <div class="row">
+
+ <aside class="tableofcontents threecol" role="complementary">
+ <h2>Table of contents</h2>
+ <div id="toc">
+<ul class="vertical-tabs">
+ <li class="tree">
+ <div class="page-details">
+ <a href="/a-quickstart" class="title">Quickstart</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
+ </div>
+ </li>
+</ul><ul class="vertical-tabs">
+ <li class="tree">
+ <div class="page-details">
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
+ </div>
+ </li>
+</ul><ul class="vertical-tabs">
+ <li class="tree">
+ <div class="page-details">
+ <a href="/support" class="title">Need Support?</a>
+ </div>
+ </li>
+</ul><ul class="vertical-tabs">
+ <li class="tree">
+ <div class="page-details">
+ <a href="/api" class="title">JSON API</a>
+ </div>
+ </li>
+</ul><ul class="vertical-tabs">
+ <li class="tree">
+ <div class="page-details">
+ <a href="/appendix" class="title">Appendix</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/appendix/resources" class="title">More Resources</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
+ </div>
+ </li>
+</ul></div>
+ </aside>
+ <div class="full-height threecol"></div>
+
+
+ <div class="content eightcol" role="main">
+ <article id="content" class="tab-content intro"><div>
+ <div class="page-details">
+ <h1 class="title">Appendix</h1>
+ </div>
+ <div class="content"></div>
+</div></article>
+ </div>
+ <!-- content -->
+ </div>
+ <!-- row -->
+
+ <footer role="contentinfo" class="copyright">
+ <p>&copy; 2010-2012 Nodejitsu Inc.</p>
+ <a href="http://legal.nodejitsu.com/privacy" class="last">Privacy policy</a>
+ <a href="http://legal.nodejitsu.com/terms-of-service">Terms of Service</a>
+ </footer>
+
+ <script src="../public/js/ui.js"></script>
+
+</body>
+</html>
View
56 public/appendix/open-source.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,14 +109,12 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">appendix/open-source</h1>
+ <h1 class="title">Open Source Projects</h1>
</div>
- <div class="content"><h1>Open Source Projects</h1>
-<p><a name='opensource'></a>
-
+ <div class="content"><p><hr>
</p>
<h2>Why Open Source</h2>
<p>Most of Nodejitsu&#39;s technology stack is released as open source software. We
@@ -125,6 +125,8 @@ <h1 class="title">appendix/open-source</h1>
if we had not open-sourced it.
</p>
+<p><hr>
+</p>
<h2>Where To Find Our Projects</h2>
<p>Nodejitsu hosts its open-source projects on <a href="https://github.com">Github</a>:
@@ -142,6 +144,8 @@ <h1 class="title">appendix/open-source</h1>
code repositories.
</p>
+<p><hr>
+</p>
<h2>How To Contribute</h2>
<p>Anyone can contribute to any of our open-source projects at any time.
Our <a href="https://github.com/nodejitsu">github site</a> has the facilities for managing
View
107 public/appendix/package.json.html → public/appendix/package-json.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,62 +109,65 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">appendix/package</h1>
+ <h1 class="title">Understanding package.json</h1>
</div>
- <div class="content"><h1>Appendix: package.json</h1>
-<p><a name='apx:package'></a>
-
+ <div class="content"><p><hr>
+<strong><a href="http://package.json.jit.su">package.json.jit.su</a> is an interactive package.json properties explorer! Highly recommended.</strong>
</p>
-<p><strong><a href="http://package.json.jit.su">package.json.jit.su</a> is an interactive package.json properties explorer! Highly recommended.</strong>
+<hr>
-</p>
<h2>Understanding the package.json format</h2>
<p>A package.json file describes your application, its dependencies, and other various application metadata. For a detailed spec on creating a package.json you can check out Isaac&#39;s fine documentation <a href="https://github.com/isaacs/npm/blob/master/doc/developers.md#readme">here</a>.
</p>
+<p><hr>
+</p>
<h2>Preparing a package.json for your application</h2>
<p>Nodejitsu requires that you create a valid <a href="#package_json">package.json</a> for your application. The package.json will determine certain important pieces of information about your application which are required for deployment. Since sometimes it can get confusing when constructing your package.json file, we provide wizards in our CLI tool and on our website for creating one.
</p>
<p>Here is an example of what your package.json might look like:
-
</p>
-<pre><code>{
- &quot;name&quot;: &quot;hellonode&quot;,
- &quot;subdomain&quot;: &quot;hellonode&quot;,
- &quot;scripts&quot;: {
- &quot;start&quot;: &quot;node server.js&quot;
- },
- &quot;version&quot;: &quot;0.0.0&quot;
-}</code></pre>
+<pre><code class="lang-js"> {
+ <span class="string">"name"</span>: <span class="string">"hellonode"</span>,
+ <span class="string">"subdomain"</span>: <span class="string">"hellonode"</span>,
+ <span class="string">"scripts"</span>: {
+ <span class="string">"start"</span>: <span class="string">"node server.js"</span>
+ },
+ <span class="string">"version"</span>: <span class="string">"0.0.0"</span>
+ }</code></pre>
<p>Notice the &quot;scripts&quot; property? This is where you&#39;ll store information about specific scripts in your application. The &quot;start&quot; property indicates the script that will get called when your application is started. Usage is compatible with <code>npm start</code>.
</p>
+<p><hr>
+</p>
<h2>Specifying dependencies in your package.json</h2>
<p>If your application requires additional dependencies or third-party libraries, Nodejitsu fully supports npm module dependency resolution. All you have to do is list your dependencies the exact same way you would if you were packaging a module for npm. Here is an example of the same package.json with a few dependencies.
-
</p>
-<pre><code>{
- &quot;name&quot;: &quot;hellonode&quot;,
- &quot;subdomain&quot;: &quot;hellonode&quot;,
- &quot;scripts&quot;: {
- &quot;start&quot;: &quot;server.js&quot;
- },
- &quot;dependencies&quot;: {
- &quot;async&quot;: &quot;0.1.x&quot;,
- &quot;colors&quot;: &quot;0.5.x&quot;,
- &quot;request&quot;: &quot;1.9.x&quot;
- },
- &quot;version&quot;: &quot;0.0.0&quot;
-}</code></pre>
+<pre><code class="lang-js"> {
+ <span class="string">"name"</span>: <span class="string">"hellonode"</span>,
+ <span class="string">"subdomain"</span>: <span class="string">"hellonode"</span>,
+ <span class="string">"scripts"</span>: {
+ <span class="string">"start"</span>: <span class="string">"server.js"</span>
+ },
+ <span class="string">"dependencies"</span>: {
+ <span class="string">"async"</span>: <span class="string">"0.1.x"</span>,
+ <span class="string">"colors"</span>: <span class="string">"0.5.x"</span>,
+ <span class="string">"request"</span>: <span class="string">"1.9.x"</span>
+ },
+ <span class="string">"version"</span>: <span class="string">"0.0.0"</span>
+ }
+`</code></pre>
<p>Your dependencies will be resolved when your application deploys to Nodejitsu.
</p>
+<p><hr>
+</p>
<h2>Nodejitsu-Specific package.json Properties</h2>
<p>A few package.json properties have special behavior on the Nodejitsu platform:
View
54 public/appendix/resources.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,16 +109,12 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">appendix/resources</h1>
+ <h1 class="title">More Resources</h1>
</div>
- <div class="content"><h1>Appendix: Resources</h1>
-<p><a name='apx:resources'></a>
-
-</p>
-<p>New to Node.js? <strong>Don&#39;t be scared!</strong> There are plenty of resources out there
+ <div class="content"><p>New to Node.js? <strong>Don&#39;t be scared!</strong> There are plenty of resources out there
for beginners. Here are just a few:
</p>
View
11 public/css/base.dev.css
@@ -974,7 +974,7 @@ pre > code {
pre {
border: 1px solid #e0ded3;
- background-color: #f0efe8;
+ background-color: ghostWhite;
border-radius: 4px;
margin: 20px 10px 30px 0;
padding: 10px;
@@ -983,7 +983,7 @@ pre {
}
code {
- background-color: #f0efe8;
+ background-color: ghostWhite;
color: rgba(0,0,0, 1);
font-family: Consolas, "Liberation Mono", Courier, monospace;
white-space: pre;
@@ -1007,3 +1007,10 @@ code .number { color: red }
code .comment { color: grey }
+/*********************************************
+ * TABLES
+ *********************************************/
+table tr th,table tr td{border:1px solid #CCC;text-align:left;margin:0;padding:6px 13px;}
+table tr th{font-weight:bold;}
+table{border-collapse:collapse;border-spacing:0;}
+table tr:nth-child(2n){background-color:#F8F8F8;}
View
246 public/a-quickstart/features.html → public/features/index.html
@@ -41,65 +41,67 @@
<ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/a-quickstart" class="title">a-quickstart</a>
+ <a href="/a-quickstart" class="title">Quickstart</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/faq" class="title">a-quickstart/faq</a>
+ <a href="/a-quickstart/faq" class="title">FAQ</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/a-quickstart/features" class="title">a-quickstart/features</a>
- </div>
- </li><li class="tree">
- <div class="page-details">
- <a href="/a-quickstart/hello-world" class="title">a-quickstart/hello-world</a>
+ <a href="/a-quickstart/hello-world" class="title">Hello World: A Tutorial</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/jitsu" class="title">jitsu</a>
+ <a href="/features" class="title">Platform Features</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webhooks" class="title">Continuous Deployment</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/webops" class="title">Using Webops</a>
+ </div>
+ </li><li class="tree">
+ <div class="page-details">
+ <a href="/features/jitsu" class="title">Using the jitsu CLI</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/webops" class="title">webops</a>
+ <a href="/support" class="title">Need Support?</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/support" class="title">support</a>
+ <a href="/api" class="title">JSON API</a>
</div>
</li>
</ul><ul class="vertical-tabs">
<li class="tree">
<div class="page-details">
- <a href="/api" class="title">api</a>
+ <a href="/appendix" class="title">Appendix</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/api/webhooks" class="title">api/webhooks</a>
- </div>
- </li>
-</ul><ul class="vertical-tabs">
- <li class="tree">
- <div class="page-details">
- <a href="/appendix/haibu" class="title">appendix/haibu</a>
+ <a href="/appendix/resources" class="title">More Resources</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/open-source" class="title">appendix/open-source</a>
+ <a href="/appendix/open-source" class="title">Open Source Projects</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/package" class="title">appendix/package</a>
+ <a href="/appendix/haibu" class="title">Run it yourself With Haibu</a>
</div>
</li><li class="tree">
<div class="page-details">
- <a href="/appendix/resources" class="title">appendix/resources</a>
+ <a href="/appendix/package-json" class="title">Understanding package.json</a>
</div>
</li>
</ul></div>
@@ -107,74 +109,81 @@
<div class="full-height threecol"></div>
- <div class="content sevencol" role="main">
+ <div class="content eightcol" role="main">
<article id="content" class="tab-content intro"><div>
<div class="page-details">
- <h1 class="title">a-quickstart/features</h1>
+ <h1 class="title">Platform Features</h1>
</div>
- <div class="content"><h1>Features of the Nodejitsu Platform</h1>
-<p><a name='features'></a>
-
-</p>
-<p>The Nodejitsu platform makes writing and deploying web applications a snap!
-In addition to simple yet powerful tools for deployment, the Nodejitsu platform
-also has snapshot management, database hosting and connectivity, and more!
+ <div class="content"><p>The Nodejitsu platform makes writing and deploying web applications a snap! In addition to simple yet powerful tools for deployment, the Nodejitsu platform also has snapshot management, database hosting and connectivity, and more!
</p>
<p>There are three main tools for deploying and managing applications to Nodejitsu:
</p>
<ul>
-<li><a href="#jitsu">Jitsu</a>, The Nodejitsu command line tool </li>
-<li>The Nodejitsu <a href="#web_admin">Web Application</a>, An easy to use web interface for
-managing your applications</li>
+<li><a href="#jitsu"><code>jitsu</code></a>, the Nodejitsu command line tool </li>
+<li>The Webops <a href="#web_admin">Web Application</a>, an easy to use web interface for managing your applications</li>
<li>Nodejitsu&#39;s JSON <a href="#json_api">API</a></li>
</ul>
<p>Each of these tools allow developers to access the same functionality.
</p>
+<hr>
+
+<ul>
+<li><a href="#feature/drones">Application Scalability with Drones</a></li>
+<li><a href="#feature/zero-downtime">Zero-downtime Deploys</a></li>
+<li><a href="#feature/multi-node">Multi-Version Node Support</a></li>
+<li><a href="#feature/snapshots">Versioning with Snapshots</a></li>
+<li><a href="#feature/databases">Databases</a></li>
+<li><a href="#feature/envvars">Environment Variables</a></li>
+<li><a href="#feature/ssl">Piggy-back SSL</a></li>
+<li><a href="#feature/custom-domains">Custom Domains</a></li>
+</ul>
+<p><hr>
+<a name="feature/drones"></a>
+</p>
<h2>Application Scalability with Drones</h2>
<p>Each deployed application runs as a <a href="https://github.com/nodejitsu/haibu-carapace">drone</a> on a <a href="https://github.com/nodejitsu/haibu">haibu</a> application server. Because of this architecture, one app can be served by <em>any amount of drones on arbitrary machines</em>, giving you many options for scaling your application.
</p>
+<p><hr>
+<a name="feature/zero-downtime"></a>
+</p>
<h2>Zero Downtime Deploys</h2>
<p>When deploying a new application, nodejitsu keeps hosting your old app version until the new deploy is confirmed to be running. This means your applications never go down, even if you have a bad deploy.
</p>
+<p><hr>
+<a name="feature/multi-node"></a>
+</p>
<h2>Multi-Version Node Support</h2>
-<p>Nodejitsu allows users to choose which version of node they want their
-application to run on. In order to set your node version, specify it in your
-<code>package.json</code>&#39;s &quot;engines&quot; field. For example:
-
-
-</p>
-<pre><code>{
- &quot;author&quot;: &quot;Nodejitsu &lt;josh@nodejitsu.com&gt;&quot;,
- &quot;version&quot;: &quot;0.1.0&quot;,
- &quot;scripts&quot;: {
- &quot;start&quot;: &quot;node bin/server&quot;
- },
- &quot;analyze&quot;: false,
- &quot;name&quot;: &quot;helloworld&quot;,
- &quot;engines&quot;: {
- &quot;node&quot;: &quot;v0.6.x&quot;
- }
-}</code></pre>
+<p>Nodejitsu allows users to choose which version of node they want their application to run on. In order to set your node version, specify it in your <code>package.json</code>&#39;s &quot;engines&quot; field. For example:
+
+</p>
+<pre><code class="lang-js"> {
+ <span class="string">"author"</span>: <span class="string">"Nodejitsu &lt;josh@nodejitsu.com&gt;"</span>,
+ <span class="string">"version"</span>: <span class="string">"0.1.0"</span>,
+ <span class="string">"scripts"</span>: {
+ <span class="string">"start"</span>: <span class="string">"node bin/server"</span>
+ },
+ <span class="string">"analyze"</span>: <span class="literal">false</span>,
+ <span class="string">"name"</span>: <span class="string">"helloworld"</span>,
+ <span class="string">"engines"</span>: {
+ <span class="string">"node"</span>: <span class="string">"v0.6.x"</span>
+ }
+ }</code></pre>
<p>If no node engine is specified, jitsu will prompt for it automatically. Currently Nodejitsu runs node <code>0.6.x</code> and <code>0.8.x</code>.
</p>
-<h2>Snapshots</h2>
-<p><a name='features/snapshots'></a>
-
+<p><hr>
+<a name="feature/snapshots"></a>
</p>
-<p>Every time you deploy to Nodejitsu, we automatically take a
-<a href="http://en.wikipedia.org/wiki/Snapshot_\(computer_storage\">snapshot</a>) of your
-application. Using any of our tools, you can view and manage snapshots, or even
-roll back to an old snapshot when disaster strikes in your production
-environment. <em>During a deploy, nodejitsu will create a new snapshot automatically.</em>
+<h2>Snapshots</h2>
+<p>Every time you deploy to Nodejitsu, we automatically take a <a href="http://en.wikipedia.org/wiki/Snapshot_\(computer_storage\">snapshot</a>) of your application. Using any of our tools, you can view and manage snapshots, or even roll back to an old snapshot when disaster strikes in your production environment. <em>During a deploy, nodejitsu will create a new snapshot automatically.</em>
</p>
-<p>Jitsu commands for snapshot management include:
+<p><code>jitsu</code> commands for snapshot management include:
</p>
<ul>
@@ -182,65 +191,48 @@ <h1 class="title">a-quickstart/features</h1>
<li><code>jitsu snapshots activate &lt;app-name&gt;</code> allows you to choose which snapshot your drones are running.</li>
<li><code>jitsu snapshots fetch &lt;app-name&gt;</code> will download a specified snapshot of your application to your computer.</li>
</ul>
-<h2>Databases</h2>
-<p><a name='features/databases'></a>
-
+<p><hr>
+<a name='features/databases'></a>
</p>
-<p>Applications on Nodejitsu are ready to be connected to any database. If you
-already have a database running, Nodejitsu can connect to your pre-existing
-database. If you require a new database, Nodejitsu can provide you <em>free</em>
-instances of several different types of databases. These free instances are
-great for development purposes or hobby sites. If you require a high traffic
-or production database we provide an easy upgrade path to industrial strength
-database hosting.
+<h2>Databases</h2>
+<p>Applications on Nodejitsu are ready to be connected to any database. If you already have a database running, Nodejitsu can connect to your pre-existing database. If you require a new database, Nodejitsu can provide you <em>free</em> instances of several different types of databases. These free instances are great for development purposes or h