Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

First commit of new skeleton. Structure almost complete, still need t…

…o fill in a lot of content
  • Loading branch information...
commit b0499abd89ee6066d629efc00cfb1b2bb468986d 1 parent e87d3c6
Marak Marak authored
BIN  .DS_Store
View
Binary file not shown
10 Makefile
View
@@ -1,6 +1,10 @@
+# Makefile originally from the 'Mastering Node' book written TJ Holowaychuk
+# https://github.com/visionmedia/masteringnode
+#
+
PDF_FLAGS = --fontsize 9.0 \
--linkstyle plain \
- --linkcolor green \
+ --linkcolor blue \
--embedfonts \
--footer "c 1" \
--no-toc
@@ -43,9 +47,9 @@ book.mobi:
book.epub:
@echo "\n... generating $@"
ebook-convert book.html book.epub \
- --title "Mastering Node" \
+ --title "Nodejitsu Handbook" \
--no-default-epub-cover \
- --authors "TJ Holowaychuk" \
+ --authors "Marak Squires" \
--language en \
--cover pages/cover.jpg
450 book.html
View
@@ -0,0 +1,450 @@
+<html>
+ <head>
+ <title>Nodejitsu Handbook</title>
+ <style>
+ body {
+ font: 14px/1.4 Arial, sans-serif;
+ padding: 50px 180px;
+ }
+ h1 {
+ padding-left: 5px;
+ border-bottom: 3px solid #eee;
+ }
+ pre {
+ margin: 15px 0;
+ padding: 15px;
+ border: 1px solid #eee;
+ }
+ a {
+ color: #000000;
+ }
+
+ a:hover {
+ color: blue;
+ }
+
+ </style>
+ </head>
+ <body><div class='mp'>
+<h1>The Nodejitsu Handbook</h1>
+<p><em>A gentle introduction to the art of Nodejitsu</em></p>
+
+<p>Welcome to the Nodejitsu handbook. This document will help familiarize you with Nodejitsu while also providing detailed information about specific platform features. This is a living document which you can submit patches to @ <a href="http://github.com/nodejitsu/handbook" data-bare-link="true">http://github.com/nodejitsu/handbook</a>.</p>
+
+<h2 id="What-Is-Nodejitsu-">What Is Nodejitsu?</h2>
+
+<p><a href="http://nodejitsu.com/">Nodejitsu</a> is a Platform as A Service for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js applications into the cloud with a myriad of additional features. Nodejitsu's platform provides a robust suite of functionality to assist in the development, management, and deployment of Node.js applications.</p>
+
+<h2 id="How-Can-I-Get-Started-">How Can I Get Started?</h2>
+
+<p>So you wish to learn the ways of Nodejitsu? Excellent! Reading this sentence is the first step! Below, you will find the Table Of Contents which provides an overview of the systems which comprise Nodejitsu. We suggest starting at <a href="#Deploying_Applications" data-bare-link="true">Deploying Applications</a>. You can also always visit our website at <a href="http://nodejitsu.com" data-bare-link="true">http://nodejitsu.com</a>. Good Luck!</p>
+
+</div>
+<div class='mp'>
+<h1>Table of Contents</h1>
+<ul>
+<li><a href="1_Introduction.md">Introduction</a></li>
+<li><a href="Deploying_Applications.md">Deploying Applications</a>
+
+<ul>
+<li><a href="">Deploying from the Samurai web admin</a></li>
+<li><a href="">Deploying from Jitsu, The Nodejitsu Command Line Tool</a></li>
+<li><a href="">Deploying from the API</a></li>
+</ul>
+</li>
+<li><a href="Using_The_Jitsu_Client.md">Using the Jitsu Client</a>
+
+<ul>
+<li><a href="">Installation</a></li>
+<li><a href="">Usage</a></li>
+</ul>
+</li>
+<li><a href="Using_The_API.md">Using the API</a>
+
+<ul>
+<li><a href="#Applications" data-bare-link="true">Applications</a></li>
+<li><a href="#Snapshots" data-bare-link="true">Snapshots</a></li>
+<li><a href="#User" data-bare-link="true">Users</a></li>
+<li><a href="#Database" data-bare-link="true">Databases</a></li>
+<li><a href="#Marketplace" data-bare-link="true">Marketplace</a></li>
+<li><a href="#Logging" data-bare-link="true">Logging</a></li>
+</ul>
+</li>
+<li><a href="Setting_Up_Databases.md">Databases</a>
+
+<ul>
+<li>Creating new Databases
+
+<ul>
+<li><a href="">CouchDB</a></li>
+<li><a href="">Redis</a></li>
+<li><a href="">MongoDB</a></li>
+</ul>
+</li>
+<li>Connecting existing Databases</li>
+</ul>
+</li>
+<li><a href="The_Marketplace.md">The MarketPlace</a>
+
+<ul>
+<li>Deploying a Marketplace Application</li>
+<li>Getting your Application on the Marketplace</li>
+</ul>
+</li>
+<li><a href="Add_Ons.md">Add-Ons</a>
+
+<ul>
+<li>MailChimp</li>
+<li>Cloud9</li>
+<li>Adding your service as an add-on</li>
+</ul>
+</li>
+<li><a href="Open_source_Projects.md">Nodejitsu's Open-source Projects</a>
+
+<ul>
+<li>Why open-source?</li>
+<li>Where to find</li>
+<li>How to contribute</li>
+</ul>
+</li>
+</ul>
+
+
+</div>
+<div class='mp'>
+<h1><p><a name="Deploying_Applications"></a></p>
+
+Deploying Applications</h1>
+<p>TODO: add overview</p>
+
+<ul>
+<li><a href="#Samurai" data-bare-link="true">Deploying from the Samurai web admin</a></li>
+<li><a href="#Jitsu" data-bare-link="true">Deploying from Jitsu, The Nodejitsu Command Line Tool</a></li>
+<li><a href="#API" data-bare-link="true">Deploying from the API</a></li>
+</ul>
+
+
+<p><a name="Samurai"></a></p>
+
+<h2 id="Deploying-from-the-Samurai-web-admin">Deploying from the Samurai web admin</h2>
+
+<p>The Samurai web admin is an easy to use web-site where you can manage and deploy your node.js applications. Simply visit www.nodejitsu.com and sign-in. You'll be taken directly to the Samurai web admin interface.</p>
+
+<p><a name="Jitsu"></a></p>
+
+<h2 id="Deploying-from-Jitsu-The-Nodejitsu-Command-Line-Tool">Deploying from Jitsu, The Nodejitsu Command Line Tool</h2>
+
+<p>If you prefer CLI ( Command Line Interface ) tools over web-sites you can download Jitsu, The Nodejitsu CLI tool. Jitsu is friendly to non-technical users, but it does cover our entire <a href="API" data-bare-link="true">API</a> and it's fully open-source for the more advanced node.js user.</p>
+
+<h3 id="Additional-Jitsu-resources">Additional Jitsu resources</h3>
+
+<p><a name="API"></a></p>
+
+<h2 id="Deploying-from-the-API">Deploying from the API</h2>
+
+<p>If you are an advanced user, you might want to automate your deployment using scripts instead of manually deploying your application using Samurai or Jitsu. Nodejitsu provides a high-level JSON API which will allow you to deploy applications, as well as many other features.</p>
+
+<pre><code> // curl code for deploying a new app
+</code></pre>
+
+<p>You can see a detailed specification of the API here: LINKTO: api docs</p>
+
+</div>
+<div class='mp'>
+<h1>Setting Up A Database For Your Application</h1>
+<p>Nodejitsu has several Node.js friendly databases ready to be used by your application. If you have already have a database running, Nodejitsu can connect to your pre-existing database. If you require a new database, Nodejitsu can provide you FREE 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 with our partners such as Redis2Go, CouchOne, and MongoHQ.</p>
+
+<ul>
+<li>Creating new Databases
+
+<ul>
+<li><a href="">CouchDB</a></li>
+<li><a href="">Redis</a></li>
+<li><a href="">MongoDB</a></li>
+</ul>
+</li>
+<li>Connecting existing Databases</li>
+</ul>
+
+
+<h2 id="Creating-new-Databases">Creating new Databases</h2>
+
+<p>If you require database hosting, you can create a new database instance of any of our supported databases using Samaruai, Jitsu, or our API.</p>
+
+<h3 id="CouchDB">CouchDB</h3>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h3 id="Redis">Redis</h3>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h3 id="MongoDB">MongoDB</h3>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h2 id="Existing-Databases">Existing Databases</h2>
+
+<p>If you already have an externally hosted Database, Nodejitsu is capable of connecting to it. We've got Database hosting if you need it, but we fully support externally hosted Databases.</p>
+
+<h2 id="Connecting-Applications-to-Databases">Connecting Applications to Databases</h2>
+
+<p>If you want to connect a Database to your Node.js application, Nodejitsu provides you with sample code for each Database type as well as the ability to specify database connection strings in your application's package.json</p>
+
+</div>
+<div class='mp'>
+<h1>Using The Jitsu Client</h1>
+<p>Jitsu is a Command Line Tool (CLI) for interacting with the Nodejitsu platform. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line, you can still pretty much do everything Jitsu can do through our web interface, Samurai.</p>
+
+<ul>
+<li><a href="">Installation</a></li>
+<li><a href="">Usage</a></li>
+</ul>
+
+
+<h2 id="Installation">Installation</h2>
+
+<pre><code> TODO: add section
+</code></pre>
+
+<h2 id="Usage">Usage</h2>
+
+<pre><code> TODO: add section
+</code></pre>
+
+</div>
+<div class='mp'>
+<h1>Using The API</h1>
+<p>Nodejitsu provides a web API for users who want to interact with the Nodejitsu platform programatically. This API is built to be RESTful and communicates via JSON.</p>
+
+<ul>
+<li><a href="#Applications" data-bare-link="true">Applications</a></li>
+<li><a href="#Snapshots" data-bare-link="true">Snapshots</a></li>
+<li><a href="#User" data-bare-link="true">Users</a></li>
+<li><a href="#Database" data-bare-link="true">Databases</a></li>
+<li><a href="#Marketplace" data-bare-link="true">Marketplace</a></li>
+<li><a href="#Logging" data-bare-link="true">Logging</a></li>
+</ul>
+
+
+<h2 id="Authentication">Authentication</h2>
+
+<p>Most of the calls to the API will require that you authenticate using your Nodejitsu account. Currently, we support Basic Authentication.</p>
+
+<pre><code> TODO: Here is an example of using basic auth with curl
+</code></pre>
+
+<p>If you do not have an account it is possible to create one using the User API, Jitsu, or just by visiting <a href="http://nodejitsu.com" data-bare-link="true">http://nodejitsu.com</a></p>
+
+<p><a name="Applications"></a></p>
+
+<h2 id="Applications">Applications</h2>
+
+<h4 id="Get-all-applications-for-a-User">Get all applications for a User</h4>
+
+<pre><code> GET /apps/:user-id
+</code></pre>
+
+<h4 id="Create-a-new-Application">Create a new Application</h4>
+
+<pre><code> POST /apps/:user-id
+ { package.json }
+</code></pre>
+
+<h4 id="Start-an-Application">Start an Application</h4>
+
+<pre><code> POST /apps/:user-name/:app-name/restart
+</code></pre>
+
+<h4 id="Stop-an-Application">Stop an Application</h4>
+
+<pre><code> POST /apps/:user-name/:app-name/start
+</code></pre>
+
+<h4 id="Restart-an-Application">Restart an Application</h4>
+
+<pre><code> POST /apps/:user-name/:app-name/stop
+</code></pre>
+
+<h4 id="Update-an-Application">Update an Application</h4>
+
+<pre><code> PUT /apps/:user-id
+ { package.json }
+</code></pre>
+
+<h4 id="Delete-an-Application">Delete an Application</h4>
+
+<pre><code> DELETE /apps/:user-name/:app-name/remove
+</code></pre>
+
+<p><a name="Snapshots"></a></p>
+
+<h2 id="Snapshots">Snapshots</h2>
+
+<p>Snapshots are an easy way to capture the current state of your application. Once a Snapshot of your application is created you can roll back and activate that Snapshot at any time.</p>
+
+<h4 id="Make-an-existing-snapshot-the-active-app">Make an existing snapshot the active app</h4>
+
+<pre><code>PUT /apps/:user-name/:app-name/snapshots/:id/active
+</code></pre>
+
+<h4 id="Activate-Deploy-a-snapshot">Activate / Deploy a snapshot</h4>
+
+<pre><code>POST /apps/:user-name/:snapshots/:id
+</code></pre>
+
+<h4 id="Show-a-catalog-of-all-Snapshot-for-an-Application">Show a catalog of all Snapshot for an Application</h4>
+
+<pre><code>GET /apps/:user-name/:app-name/snapshots
+</code></pre>
+
+<h4 id="Show-the-contents-of-a-Snapshot">Show the contents of a Snapshot</h4>
+
+<pre><code>GET /apps/:user-name/:app-name/snapshots/:id
+</code></pre>
+
+<p><a name="Users"></a></p>
+
+<h2 id="Users">Users</h2>
+
+<h4 id="Signup-a-new-User">Signup a new User</h4>
+
+<pre><code> TODO:
+</code></pre>
+
+<h4 id="Confirm-a-User-account">Confirm a User account</h4>
+
+<pre><code> TODO:
+</code></pre>
+
+<h4 id="Update-User">Update User</h4>
+
+<pre><code> TODO:
+</code></pre>
+
+<p><a name="Databases"></a></p>
+
+<h2 id="Databases">Databases</h2>
+
+<h4 id="Create-a-new-Database">Create a new Database</h4>
+
+<pre><code> POST /databases/:user-name/:id
+
+ {
+ type: "Couch || Redis || Mongo"
+ }
+</code></pre>
+
+<h4 id="Get-information-about-a-Database">Get information about a Database</h4>
+
+<pre><code>GET /databases/:user-name/:id
+</code></pre>
+
+<h4 id="Delete-a-Database">Delete a Database</h4>
+
+<pre><code>DELETE /databases/:user-name/:id
+</code></pre>
+
+<p><a name="Marketplace"></a></p>
+
+<h2 id="Marketplace">Marketplace</h2>
+
+<h4 id="Get-all-Marketplace-Applications">Get all Marketplace Applications</h4>
+
+<pre><code>GET /marketplace
+</code></pre>
+
+<h4 id="Get-a-specific-Marketplace-Application">Get a specific Marketplace Application</h4>
+
+<pre><code>GET /databases/:user-name/:id
+</code></pre>
+
+<p><a name="Logging"></a></p>
+
+<h2 id="Logging">Logging</h2>
+
+<h4 id="Get-all-logs-for-a-user">Get all logs for a user</h4>
+
+<pre><code> GET /logs/:user-name/
+</code></pre>
+
+<h4 id="Get-logs-for-a-specific-application">Get logs for a specific application</h4>
+
+<pre><code> GET /logs/:user-name/:app-name
+</code></pre>
+
+</div>
+<div class='mp'>
+<h1>The Marketplace</h1>
+<p>The Marketplace is an online store where you can browse ready to go Node.js Applications and clone and deploy your own copy in seconds. The Marketplace is a great place to start if you are new to Node.js development or want to share your existing Node.js Application with the world.</p>
+
+<ul>
+<li>Deploying a Marketplace Application</li>
+<li>Getting your Application on the Marketplace</li>
+</ul>
+
+
+<h2 id="Deploying-a-Marketplace-Application">Deploying a Marketplace Application</h2>
+
+<p>You can deploy a ready to go application from the Marketplace is seconds and begin customize it for your needs immediately. Marketplace Applications can be configured through Samurai, Jitsu, or the API.</p>
+
+<h2 id="Getting-your-Application-on-the-Marketplace">Getting your Application on the Marketplace</h2>
+
+<pre><code>TODO: add section
+</code></pre>
+
+</div>
+<div class='mp'>
+<h1>Add-Ons</h1>
+<p>TODO: add section</p>
+
+<ul>
+<li>MailChimp</li>
+<li>Add-Ons</li>
+</ul>
+
+
+<h2 id="Deploying-a-Marketplace-Application">Deploying a Marketplace Application</h2>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h2 id="Getting-your-Application-on-the-Marketplace">Getting your Application on the Marketplace</h2>
+
+<pre><code>TODO: add section
+</code></pre>
+
+</div>
+<div class='mp'>
+<h1>Open-source Projects</h1>
+<p>TODO: add section</p>
+
+<ul>
+<li>Why open-source?</li>
+<li>Where to find</li>
+<li>How to contribute</li>
+</ul>
+
+
+<h2 id="Why-open-source">Why open-source</h2>
+
+<p>A lot of Nodejitsu's technology stack is released as open-source software. We choose to do this for many reasons. Aside from being able to give back to the very awesome Node.js community, releasing pieces of our stack as open-source allows other developers and users to review and improve our software. We've already received invaluable contributions to our platform from developers who would have never seen our code if we had not open-sourced it.</p>
+
+<p>Releasing as open-source increases the quality of our software.</p>
+
+<h2 id="Where-to-find">Where to find</h2>
+
+<p>Nodejitsu hosts it's open-source projects on <a href="http://github.com">Github.com</a>. Github is website for sharing and collobrating on source code. You can get source code without creating an account, and if you want to create an account it's free. You'll need a <a href="http://gitscm.org/">Git</a> client if you wish to check out any of our code repositories.</p>
+
+<p>You can visit our open-source project directory at: <a href="http://github.com/nodejitsu" data-bare-link="true">http://github.com/nodejitsu</a></p>
+
+<h2 id="How-to-contribute">How to contribute</h2>
+
+<p>Anyone can contribute to any Nodejitsu open-source projects at anytime. <a href="http://github.com/nodejitsu">Github</a> has the facilities for managing patches, issues, code comments, version control, etc. If you aren't ready to submit code or have questions you can create a Github issue or even just send an email to the Node.js mailing list. We'll make sure one our Ninja's gets back to you soon.</p>
+
+</div>
+ </body>
+</html>
BIN  book.pdf
View
Binary file not shown
21 chapters/Add_Ons.html
View
@@ -0,0 +1,21 @@
+<div class='mp'>
+<h1>Add-Ons</h1>
+<p>TODO: add section</p>
+
+<ul>
+<li>MailChimp</li>
+<li>Add-Ons</li>
+</ul>
+
+
+<h2 id="Deploying-a-Marketplace-Application">Deploying a Marketplace Application</h2>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h2 id="Getting-your-Application-on-the-Marketplace">Getting your Application on the Marketplace</h2>
+
+<pre><code>TODO: add section
+</code></pre>
+
+</div>
39 chapters/Deploying_Applications.html
View
@@ -0,0 +1,39 @@
+<div class='mp'>
+<h1><p><a name="Deploying_Applications"></a></p>
+
+Deploying Applications</h1>
+<p>TODO: add overview</p>
+
+<ul>
+<li><a href="#Samurai" data-bare-link="true">Deploying from the Samurai web admin</a></li>
+<li><a href="#Jitsu" data-bare-link="true">Deploying from Jitsu, The Nodejitsu Command Line Tool</a></li>
+<li><a href="#API" data-bare-link="true">Deploying from the API</a></li>
+</ul>
+
+
+<p><a name="Samurai"></a></p>
+
+<h2 id="Deploying-from-the-Samurai-web-admin">Deploying from the Samurai web admin</h2>
+
+<p>The Samurai web admin is an easy to use web-site where you can manage and deploy your node.js applications. Simply visit www.nodejitsu.com and sign-in. You'll be taken directly to the Samurai web admin interface.</p>
+
+<p><a name="Jitsu"></a></p>
+
+<h2 id="Deploying-from-Jitsu-The-Nodejitsu-Command-Line-Tool">Deploying from Jitsu, The Nodejitsu Command Line Tool</h2>
+
+<p>If you prefer CLI ( Command Line Interface ) tools over web-sites you can download Jitsu, The Nodejitsu CLI tool. Jitsu is friendly to non-technical users, but it does cover our entire <a href="API" data-bare-link="true">API</a> and it's fully open-source for the more advanced node.js user.</p>
+
+<h3 id="Additional-Jitsu-resources">Additional Jitsu resources</h3>
+
+<p><a name="API"></a></p>
+
+<h2 id="Deploying-from-the-API">Deploying from the API</h2>
+
+<p>If you are an advanced user, you might want to automate your deployment using scripts instead of manually deploying your application using Samurai or Jitsu. Nodejitsu provides a high-level JSON API which will allow you to deploy applications, as well as many other features.</p>
+
+<pre><code> // curl code for deploying a new app
+</code></pre>
+
+<p>You can see a detailed specification of the API here: LINKTO: api docs</p>
+
+</div>
7 chapters/Deploying_Applications.md
View
@@ -1,3 +1,4 @@
+<a name="Deploying_Applications"></a>
# Deploying Applications
TODO: add overview
@@ -6,13 +7,13 @@ TODO: add overview
- [Deploying from Jitsu, The Nodejitsu Command Line Tool](#Jitsu)
- [Deploying from the API](#API)
-<a name="Samurai"/>
+<a name="Samurai"></a>
## Deploying from the Samurai web admin
The Samurai web admin is an easy to use web-site where you can manage and deploy your node.js applications. Simply visit www.nodejitsu.com and sign-in. You'll be taken directly to the Samurai web admin interface.
-<a name="Jitsu"/>
+<a name="Jitsu"></a>
## Deploying from Jitsu, The Nodejitsu Command Line Tool
@@ -20,7 +21,7 @@ If you prefer CLI ( Command Line Interface ) tools over web-sites you can downlo
### Additional Jitsu resources
-<a name="API"/>
+<a name="API"></a>
## Deploying from the API
15 chapters/Introduction.md
View
@@ -1,15 +0,0 @@
-
-# Introduction
-
-Welcome to the Nodejitsu handbook. This document will help familiarize you with Nodejitsu while also providing detailed information about specific platform features. This is a living document which you are free to submit patches to @ [http://github.com/nodejitsu/handbook]([http://github.com/nodejitsu/handbook).
-
-- What Is Nodejitsu?
-- How Can I Get Started?
-
-## What Is Nodejitsu?
-
-[Nodejitsu](http://nodejitsu.com/) is a Platform as A Service for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js applications into the cloud. Nodejitsu's platform provides a robust suite of functionality to assist in the development, management, and deployment of Node.js applications.
-
-## How Can I Get Started?
-
-So you wish to learn the ways of Nodejitsu? Excellent! The first step is checking out the [Table of Contents](0_Table_Of_Contents.md). Here you will find a overview of the systems which comprise Nodejitsu. We suggest starting at [Deploying Applications](2_Deploying_Applications.md). You can also always visit our website at [http://nodejitsu.com](http://nodejitsu.com).
28 chapters/Open_Source_Projects.html
View
@@ -0,0 +1,28 @@
+<div class='mp'>
+<h1>Open-source Projects</h1>
+<p>TODO: add section</p>
+
+<ul>
+<li>Why open-source?</li>
+<li>Where to find</li>
+<li>How to contribute</li>
+</ul>
+
+
+<h2 id="Why-open-source">Why open-source</h2>
+
+<p>A lot of Nodejitsu's technology stack is released as open-source software. We choose to do this for many reasons. Aside from being able to give back to the very awesome Node.js community, releasing pieces of our stack as open-source allows other developers and users to review and improve our software. We've already received invaluable contributions to our platform from developers who would have never seen our code if we had not open-sourced it.</p>
+
+<p>Releasing as open-source increases the quality of our software.</p>
+
+<h2 id="Where-to-find">Where to find</h2>
+
+<p>Nodejitsu hosts it's open-source projects on <a href="http://github.com">Github.com</a>. Github is website for sharing and collobrating on source code. You can get source code without creating an account, and if you want to create an account it's free. You'll need a <a href="http://gitscm.org/">Git</a> client if you wish to check out any of our code repositories.</p>
+
+<p>You can visit our open-source project directory at: <a href="http://github.com/nodejitsu" data-bare-link="true">http://github.com/nodejitsu</a></p>
+
+<h2 id="How-to-contribute">How to contribute</h2>
+
+<p>Anyone can contribute to any Nodejitsu open-source projects at anytime. <a href="http://github.com/nodejitsu">Github</a> has the facilities for managing patches, issues, code comments, version control, etc. If you aren't ready to submit code or have questions you can create a Github issue or even just send an email to the Node.js mailing list. We'll make sure one our Ninja's gets back to you soon.</p>
+
+</div>
45 chapters/Setting_Up_Databases.html
View
@@ -0,0 +1,45 @@
+<div class='mp'>
+<h1>Setting Up A Database For Your Application</h1>
+<p>Nodejitsu has several Node.js friendly databases ready to be used by your application. If you have already have a database running, Nodejitsu can connect to your pre-existing database. If you require a new database, Nodejitsu can provide you FREE 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 with our partners such as Redis2Go, CouchOne, and MongoHQ.</p>
+
+<ul>
+<li>Creating new Databases
+
+<ul>
+<li><a href="">CouchDB</a></li>
+<li><a href="">Redis</a></li>
+<li><a href="">MongoDB</a></li>
+</ul>
+</li>
+<li>Connecting existing Databases</li>
+</ul>
+
+
+<h2 id="Creating-new-Databases">Creating new Databases</h2>
+
+<p>If you require database hosting, you can create a new database instance of any of our supported databases using Samaruai, Jitsu, or our API.</p>
+
+<h3 id="CouchDB">CouchDB</h3>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h3 id="Redis">Redis</h3>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h3 id="MongoDB">MongoDB</h3>
+
+<pre><code>TODO: add section
+</code></pre>
+
+<h2 id="Existing-Databases">Existing Databases</h2>
+
+<p>If you already have an externally hosted Database, Nodejitsu is capable of connecting to it. We've got Database hosting if you need it, but we fully support externally hosted Databases.</p>
+
+<h2 id="Connecting-Applications-to-Databases">Connecting Applications to Databases</h2>
+
+<p>If you want to connect a Database to your Node.js application, Nodejitsu provides you with sample code for each Database type as well as the ability to specify database connection strings in your application's package.json</p>
+
+</div>
71 chapters/Table_Of_Contents.html
View
@@ -0,0 +1,71 @@
+<div class='mp'>
+<h1>Table of Contents</h1>
+<ul>
+<li><a href="1_Introduction.md">Introduction</a></li>
+<li><a href="Deploying_Applications.md">Deploying Applications</a>
+
+<ul>
+<li><a href="">Deploying from the Samurai web admin</a></li>
+<li><a href="">Deploying from Jitsu, The Nodejitsu Command Line Tool</a></li>
+<li><a href="">Deploying from the API</a></li>
+</ul>
+</li>
+<li><a href="Using_The_Jitsu_Client.md">Using the Jitsu Client</a>
+
+<ul>
+<li><a href="">Installation</a></li>
+<li><a href="">Usage</a></li>
+</ul>
+</li>
+<li><a href="Using_The_API.md">Using the API</a>
+
+<ul>
+<li><a href="#Applications" data-bare-link="true">Applications</a></li>
+<li><a href="#Snapshots" data-bare-link="true">Snapshots</a></li>
+<li><a href="#User" data-bare-link="true">Users</a></li>
+<li><a href="#Database" data-bare-link="true">Databases</a></li>
+<li><a href="#Marketplace" data-bare-link="true">Marketplace</a></li>
+<li><a href="#Logging" data-bare-link="true">Logging</a></li>
+</ul>
+</li>
+<li><a href="Setting_Up_Databases.md">Databases</a>
+
+<ul>
+<li>Creating new Databases
+
+<ul>
+<li><a href="">CouchDB</a></li>
+<li><a href="">Redis</a></li>
+<li><a href="">MongoDB</a></li>
+</ul>
+</li>
+<li>Connecting existing Databases</li>
+</ul>
+</li>
+<li><a href="The_Marketplace.md">The MarketPlace</a>
+
+<ul>
+<li>Deploying a Marketplace Application</li>
+<li>Getting your Application on the Marketplace</li>
+</ul>
+</li>
+<li><a href="Add_Ons.md">Add-Ons</a>
+
+<ul>
+<li>MailChimp</li>
+<li>Cloud9</li>
+<li>Adding your service as an add-on</li>
+</ul>
+</li>
+<li><a href="Open_source_Projects.md">Nodejitsu's Open-source Projects</a>
+
+<ul>
+<li>Why open-source?</li>
+<li>Where to find</li>
+<li>How to contribute</li>
+</ul>
+</li>
+</ul>
+
+
+</div>
22 chapters/Table_Of_Contents.md
View
@@ -1,41 +1,35 @@
-# The Nodejitsu Handbook
-
-*A gentle introduction to the art of Nodejitsu*
-
-### Table of Contents
+# Table of Contents
- [Introduction](1_Introduction.md)
- - [What Is Nodejitsu?]()
- - [How Can I Get Started?]()
-- [Deploying Applications](2_Deploying_Applications.md)
+- [Deploying Applications](Deploying_Applications.md)
- [Deploying from the Samurai web admin]()
- [Deploying from Jitsu, The Nodejitsu Command Line Tool]()
- [Deploying from the API]()
-- [Using the Jitsu Client](4_Using_The_Jitsu_Client.md)
+- [Using the Jitsu Client](Using_The_Jitsu_Client.md)
- [Installation]()
- [Usage]()
-- [Using the API](5_Using_The_API.md)
+- [Using the API](Using_The_API.md)
- [Applications](#Applications)
- [Snapshots](#Snapshots)
- [Users](#User)
- [Databases](#Database)
- [Marketplace](#Marketplace)
- [Logging](#Logging)
-- [Databases](3_Setting_Up_Databases.md)
+- [Databases](Setting_Up_Databases.md)
- Creating new Databases
- [CouchDB]()
- [Redis]()
- [MongoDB]()
- Connecting existing Databases
-- [The MarketPlace](6_The_Marketplace.md)
+- [The MarketPlace](The_Marketplace.md)
- Deploying a Marketplace Application
- Getting your Application on the Marketplace
-- [Add-Ons](7_Add_Ons.md)
+- [Add-Ons](Add_Ons.md)
- MailChimp
- Cloud9
- Adding your service as an add-on
-- [Nodejitsu's Open-source Projects](8_Open_source_Projects.md)
+- [Nodejitsu's Open-source Projects](Open_source_Projects.md)
- Why open-source?
- Where to find
- How to contribute
20 chapters/The_Marketplace.html
View
@@ -0,0 +1,20 @@
+<div class='mp'>
+<h1>The Marketplace</h1>
+<p>The Marketplace is an online store where you can browse ready to go Node.js Applications and clone and deploy your own copy in seconds. The Marketplace is a great place to start if you are new to Node.js development or want to share your existing Node.js Application with the world.</p>
+
+<ul>
+<li>Deploying a Marketplace Application</li>
+<li>Getting your Application on the Marketplace</li>
+</ul>
+
+
+<h2 id="Deploying-a-Marketplace-Application">Deploying a Marketplace Application</h2>
+
+<p>You can deploy a ready to go application from the Marketplace is seconds and begin customize it for your needs immediately. Marketplace Applications can be configured through Samurai, Jitsu, or the API.</p>
+
+<h2 id="Getting-your-Application-on-the-Marketplace">Getting your Application on the Marketplace</h2>
+
+<pre><code>TODO: add section
+</code></pre>
+
+</div>
161 chapters/Using_The_API.html
View
@@ -0,0 +1,161 @@
+<div class='mp'>
+<h1>Using The API</h1>
+<p>Nodejitsu provides a web API for users who want to interact with the Nodejitsu platform programatically. This API is built to be RESTful and communicates via JSON.</p>
+
+<ul>
+<li><a href="#Applications" data-bare-link="true">Applications</a></li>
+<li><a href="#Snapshots" data-bare-link="true">Snapshots</a></li>
+<li><a href="#User" data-bare-link="true">Users</a></li>
+<li><a href="#Database" data-bare-link="true">Databases</a></li>
+<li><a href="#Marketplace" data-bare-link="true">Marketplace</a></li>
+<li><a href="#Logging" data-bare-link="true">Logging</a></li>
+</ul>
+
+
+<h2 id="Authentication">Authentication</h2>
+
+<p>Most of the calls to the API will require that you authenticate using your Nodejitsu account. Currently, we support Basic Authentication.</p>
+
+<pre><code> TODO: Here is an example of using basic auth with curl
+</code></pre>
+
+<p>If you do not have an account it is possible to create one using the User API, Jitsu, or just by visiting <a href="http://nodejitsu.com" data-bare-link="true">http://nodejitsu.com</a></p>
+
+<p><a name="Applications"></a></p>
+
+<h2 id="Applications">Applications</h2>
+
+<h4 id="Get-all-applications-for-a-User">Get all applications for a User</h4>
+
+<pre><code> GET /apps/:user-id
+</code></pre>
+
+<h4 id="Create-a-new-Application">Create a new Application</h4>
+
+<pre><code> POST /apps/:user-id
+ { package.json }
+</code></pre>
+
+<h4 id="Start-an-Application">Start an Application</h4>
+
+<pre><code> POST /apps/:user-name/:app-name/restart
+</code></pre>
+
+<h4 id="Stop-an-Application">Stop an Application</h4>
+
+<pre><code> POST /apps/:user-name/:app-name/start
+</code></pre>
+
+<h4 id="Restart-an-Application">Restart an Application</h4>
+
+<pre><code> POST /apps/:user-name/:app-name/stop
+</code></pre>
+
+<h4 id="Update-an-Application">Update an Application</h4>
+
+<pre><code> PUT /apps/:user-id
+ { package.json }
+</code></pre>
+
+<h4 id="Delete-an-Application">Delete an Application</h4>
+
+<pre><code> DELETE /apps/:user-name/:app-name/remove
+</code></pre>
+
+<p><a name="Snapshots"></a></p>
+
+<h2 id="Snapshots">Snapshots</h2>
+
+<p>Snapshots are an easy way to capture the current state of your application. Once a Snapshot of your application is created you can roll back and activate that Snapshot at any time.</p>
+
+<h4 id="Make-an-existing-snapshot-the-active-app">Make an existing snapshot the active app</h4>
+
+<pre><code>PUT /apps/:user-name/:app-name/snapshots/:id/active
+</code></pre>
+
+<h4 id="Activate-Deploy-a-snapshot">Activate / Deploy a snapshot</h4>
+
+<pre><code>POST /apps/:user-name/:snapshots/:id
+</code></pre>
+
+<h4 id="Show-a-catalog-of-all-Snapshot-for-an-Application">Show a catalog of all Snapshot for an Application</h4>
+
+<pre><code>GET /apps/:user-name/:app-name/snapshots
+</code></pre>
+
+<h4 id="Show-the-contents-of-a-Snapshot">Show the contents of a Snapshot</h4>
+
+<pre><code>GET /apps/:user-name/:app-name/snapshots/:id
+</code></pre>
+
+<p><a name="Users"></a></p>
+
+<h2 id="Users">Users</h2>
+
+<h4 id="Signup-a-new-User">Signup a new User</h4>
+
+<pre><code> TODO:
+</code></pre>
+
+<h4 id="Confirm-a-User-account">Confirm a User account</h4>
+
+<pre><code> TODO:
+</code></pre>
+
+<h4 id="Update-User">Update User</h4>
+
+<pre><code> TODO:
+</code></pre>
+
+<p><a name="Databases"></a></p>
+
+<h2 id="Databases">Databases</h2>
+
+<h4 id="Create-a-new-Database">Create a new Database</h4>
+
+<pre><code> POST /databases/:user-name/:id
+
+ {
+ type: "Couch || Redis || Mongo"
+ }
+</code></pre>
+
+<h4 id="Get-information-about-a-Database">Get information about a Database</h4>
+
+<pre><code>GET /databases/:user-name/:id
+</code></pre>
+
+<h4 id="Delete-a-Database">Delete a Database</h4>
+
+<pre><code>DELETE /databases/:user-name/:id
+</code></pre>
+
+<p><a name="Marketplace"></a></p>
+
+<h2 id="Marketplace">Marketplace</h2>
+
+<h4 id="Get-all-Marketplace-Applications">Get all Marketplace Applications</h4>
+
+<pre><code>GET /marketplace
+</code></pre>
+
+<h4 id="Get-a-specific-Marketplace-Application">Get a specific Marketplace Application</h4>
+
+<pre><code>GET /databases/:user-name/:id
+</code></pre>
+
+<p><a name="Logging"></a></p>
+
+<h2 id="Logging">Logging</h2>
+
+<h4 id="Get-all-logs-for-a-user">Get all logs for a user</h4>
+
+<pre><code> GET /logs/:user-name/
+</code></pre>
+
+<h4 id="Get-logs-for-a-specific-application">Get logs for a specific application</h4>
+
+<pre><code> GET /logs/:user-name/:app-name
+</code></pre>
+
+</div>
12 chapters/Using_The_API.md
View
@@ -17,7 +17,7 @@ Most of the calls to the API will require that you authenticate using your Nodej
If you do not have an account it is possible to create one using the User API, Jitsu, or just by visiting [http://nodejitsu.com](http://nodejitsu.com)
-<a name="Applications"/>
+<a name="Applications"></a>
## Applications
#### Get all applications for a User
@@ -50,7 +50,7 @@ If you do not have an account it is possible to create one using the User API, J
DELETE /apps/:user-name/:app-name/remove
-<a name="Snapshots"/>
+<a name="Snapshots"></a>
## Snapshots
@@ -68,7 +68,7 @@ Snapshots are an easy way to capture the current state of your application. Once
#### Show the contents of a Snapshot
GET /apps/:user-name/:app-name/snapshots/:id
-<a name="Users"/>
+<a name="Users"></a>
## Users
@@ -84,7 +84,7 @@ Snapshots are an easy way to capture the current state of your application. Once
TODO:
-<a name="Databases"/>
+<a name="Databases"></a>
## Databases
@@ -104,7 +104,7 @@ Snapshots are an easy way to capture the current state of your application. Once
DELETE /databases/:user-name/:id
-<a name="Marketplace"/>
+<a name="Marketplace"></a>
## Marketplace
@@ -116,7 +116,7 @@ Snapshots are an easy way to capture the current state of your application. Once
GET /databases/:user-name/:id
-<a name="Logging"/>
+<a name="Logging"></a>
## Logging
21 chapters/Using_The_Jitsu_Client.html
View
@@ -0,0 +1,21 @@
+<div class='mp'>
+<h1>Using The Jitsu Client</h1>
+<p>Jitsu is a Command Line Tool (CLI) for interacting with the Nodejitsu platform. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line, you can still pretty much do everything Jitsu can do through our web interface, Samurai.</p>
+
+<ul>
+<li><a href="">Installation</a></li>
+<li><a href="">Usage</a></li>
+</ul>
+
+
+<h2 id="Installation">Installation</h2>
+
+<pre><code> TODO: add section
+</code></pre>
+
+<h2 id="Usage">Usage</h2>
+
+<pre><code> TODO: add section
+</code></pre>
+
+</div>
BIN  pages/cover.jpg
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 pages/head.html
View
@@ -1,9 +1,9 @@
<html>
<head>
- <title>Mastering Node</title>
+ <title>Nodejitsu Handbook</title>
<style>
body {
- font: 14px/1.4 "Lucida Grande", "Helvetica Neue", Arial, sans-serif;
+ font: 14px/1.4 Arial, sans-serif;
padding: 50px 180px;
}
h1 {
@@ -16,8 +16,13 @@
border: 1px solid #eee;
}
a {
- color: #00aaff;
+ color: #000000;
}
+
+ a:hover {
+ color: blue;
+ }
+
</style>
</head>
<body>
14 pages/index.html
View
@@ -1,5 +1,15 @@
<div class='mp'>
-<h1>Mastering Node</h1>
-<p><a href="http://nodejs.org/">Node</a> is an exciting new platform developed by <em>Ryan Dahl</em>, allowing JavaScript developers to create extremely high performance servers by leveraging <a href="http://code.google.com/p/v8/">Google's V8</a> JavaScript engine, and asynchronous I/O. In <em>Mastering Node</em> we will discover how to write high concurrency web servers, utilizing the CommonJS module system, node's core libraries, third party modules, high level web development and more.</p>
+<h1>The Nodejitsu Handbook</h1>
+<p><em>A gentle introduction to the art of Nodejitsu</em></p>
+
+<p>Welcome to the Nodejitsu handbook. This document will help familiarize you with Nodejitsu while also providing detailed information about specific platform features. This is a living document which you can submit patches to @ <a href="http://github.com/nodejitsu/handbook" data-bare-link="true">http://github.com/nodejitsu/handbook</a>.</p>
+
+<h2 id="What-Is-Nodejitsu-">What Is Nodejitsu?</h2>
+
+<p><a href="http://nodejitsu.com/">Nodejitsu</a> is a Platform as A Service for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js applications into the cloud with a myriad of additional features. Nodejitsu's platform provides a robust suite of functionality to assist in the development, management, and deployment of Node.js applications.</p>
+
+<h2 id="How-Can-I-Get-Started-">How Can I Get Started?</h2>
+
+<p>So you wish to learn the ways of Nodejitsu? Excellent! Reading this sentence is the first step! Below, you will find the Table Of Contents which provides an overview of the systems which comprise Nodejitsu. We suggest starting at <a href="#Deploying_Applications" data-bare-link="true">Deploying Applications</a>. You can also always visit our website at <a href="http://nodejitsu.com" data-bare-link="true">http://nodejitsu.com</a>. Good Luck!</p>
</div>
13 pages/index.md
View
@@ -1,15 +1,16 @@
-# Introduction
+# The Nodejitsu Handbook
-Welcome to the Nodejitsu handbook. This document will help familiarize you with Nodejitsu while also providing detailed information about specific platform features. This is a living document which you are free to submit patches to @ [http://github.com/nodejitsu/handbook]([http://github.com/nodejitsu/handbook).
+*A gentle introduction to the art of Nodejitsu*
-- What Is Nodejitsu?
-- How Can I Get Started?
+Welcome to the Nodejitsu handbook. This document will help familiarize you with Nodejitsu while also providing detailed information about specific platform features. This is a living document which you can submit patches to @ [http://github.com/nodejitsu/handbook](http://github.com/nodejitsu/handbook).
## What Is Nodejitsu?
-[Nodejitsu](http://nodejitsu.com/) is a Platform as A Service for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js applications into the cloud. Nodejitsu's platform provides a robust suite of functionality to assist in the development, management, and deployment of Node.js applications.
+[Nodejitsu](http://nodejitsu.com/) is a Platform as A Service for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js applications into the cloud with a myriad of additional features. Nodejitsu's platform provides a robust suite of functionality to assist in the development, management, and deployment of Node.js applications.
## How Can I Get Started?
-So you wish to learn the ways of Nodejitsu? Excellent! The first step is checking out the [Table of Contents](0_Table_Of_Contents.md). Here you will find a overview of the systems which comprise Nodejitsu. We suggest starting at [Deploying Applications](2_Deploying_Applications.md). You can also always visit our website at [http://nodejitsu.com](http://nodejitsu.com).
+So you wish to learn the ways of Nodejitsu? Excellent! Reading this sentence is the first step! Below, you will find the Table Of Contents which provides an overview of the systems which comprise Nodejitsu. We suggest starting at [Deploying Applications](#Deploying_Applications). You can also always visit our website at [http://nodejitsu.com](http://nodejitsu.com). Good Luck!
+
+
Please sign in to comment.
Something went wrong with that request. Please try again.