Skip to content
Browse files

added docs page

  • Loading branch information...
1 parent 8619927 commit 1048e48738b98858b7eb3e2344021f8c0b15faad @chrismatthieu chrismatthieu committed Dec 15, 2011
Showing with 141 additions and 15 deletions.
  1. +1 −0 about.html
  2. +126 −4 api.html
  3. +7 −5 developer.html
  4. +7 −6 index.html
View
1 about.html
@@ -62,6 +62,7 @@
</div>
<br/>
<h1>Nodesters Behind Nodester</h1>
+ <p>Meet the Nodester Core Team! They are hacking at the speed of light using Node.JS to provide you with stable, enterprise Node.JS hosting options.</p>
<div class="row">
<div class="span3">
<img src="https://secure.gravatar.com/avatar/9f4580e51445f5b48eaeba23613c2393?s=140&d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png">
View
130 api.html
@@ -24,6 +24,9 @@
<link rel="apple-touch-icon" href="images/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
+ <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
+ <script src="http://twitter.github.com/bootstrap/1.4.0/bootstrap-tabs.js"></script>
+
</head>
<body>
@@ -46,12 +49,131 @@
<div class="container">
+ <div class="row">
- <div class="span16"><br/>
- <h1>Docs</h1>
- <p>place holder...</p>
- </div>
+ <div class="span16"><br/>
+ <h1>Nodester Docs</h1>
+ <p>Our entire platform is built on a set of REST APIs. A subset of these APIs are implemented in our CLI (command line interface).
+ We are also working on a web admin panel based on these APIs which will eventually allow you to provision, monitor, and control
+ Node.JS applications running on the Nodester platform without going to the command line.
+ </p>
+
+ <ul class="tabs" data-tabs="tabs">
+ <li class="active"><a href="#cli">Command Line Interface (CLI)</a></li>
+ <li><a href="#rest">REST API</a></li>
+ </ul>
+
+ <div id="my-tab-content" class="tab-content">
+ <div class="active tab-pane" id="cli">
+ <p>
+ Our command line interface allows you to manage your user account and applications with simple commands. Before you can begin using
+ these commands, you need to install the Nodester CLI using NPM.
+ </p>
+ <p>
+ <b>npm install nodester-cli -g</b>
+ </p>
+ <br/>
+ <table class="bordered-table zebra-striped">
+ <tr><td><b>coupon</b></td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester coupon &lt;email address&gt;</td></tr>
+ <tr><td><b>user</b></td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester user create &lt;username&gt; &lt;password&gt; &lt;email address&gt; &lt;file containing ssh public key&gt; &lt;coupon code&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester user setup &lt;username&gt; &lt;password&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester user setkey &lt;file containing ssh public key&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester user setpass sendtoken</td></tr>
+ <tr><td>&nbsp;</td><td>nodester user setpass &lt;token&gt; &lt;new_password&gt;</td></tr>
+ <tr><td><b>apps</b></td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester apps list</td></tr>
+ <tr><td><b>app</b></td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester app create &lt;appname&gt; &lt;initial js file&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester app info &lt;appname&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester app logs &lt;appname&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester app start &lt;appname&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester app restart &lt;appname&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester app stop &lt;appname&gt;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester app gitreset &lt;appname&gt;</td></tr>
+ <tr><td><b>status</b></td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td>nodester status</td></tr>
+ </table>
+ <p>
+ If you would like to contribute to our open source Nodester CLI on <a href="https://github.com/nodester/nodester-cli">GitHub</a>, please send us pull requests :)
+ </p>
+
+ </div>
+ <div class="tab-pane" id="rest">
+ <p>
+ Our REST API is very powerful.
+ </p>
+ <p>
+ <b>Base URL is http://api.nodester.com</b>
+ </p>
+ <br/>
+ <table class="bordered-table zebra-striped">
+ <tr><td><b>coupon</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled success">POST</a></td><td><b>/coupon</b> - Creates coupon request for early access (pass in email)<br/>
+ <code>curl -X POST -d "email=your_address@gmail.com" http://nodester.com/coupon</code></td></tr>
+ <tr><td><b>user</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled success">POST</a></td><td><b>/user</b> - Creates user account (pass in user and password and email and id_rsa.pub string) <i>Ensure that all + in the ssh key are substituted for their %2B counter parts, else your key will break. Run this on your command line to copy your RSA string and swap out the plus signs: "cat ~/.ssh/id_rsa.pub | sed s/'+'/'%2B'/g | pbcopy"</i><br/>
+ <code>curl -X POST -d "coupon=mycoupon&user=testuser&password=123&email=chris@nodester.com&rsakey=ssh-rsa AAAAB3NzaC1yc..." http://nodester.com/user</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled">PUT</a></td><td><b>/user</b> - Updates user account (pass in password and/or RSA key - "cat ~/.ssh/id_rsa.pub | sed s/'+'/'%2B'/g | pbcopy")<br/>
+ <code>curl -X PUT -u "testuser:123" -d "password=test" http://api.nodester.com/user</code><br/>
+ <code>curl -X PUT -u "testuser:123" -d "rsakey=1234567" http://api.nodester.com/user</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled danger">DELETE</a></td><td><b>/user</b> - Deletes user account (requires basic auth)<br/>
+ <code>curl -X DELETE -u "testuser:123" http://api.nodester.com/user</code></td></tr>
+ <tr><td><b>apps</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled primary">GET</a></td><td><b>/apps</b> - Returns a list of all apps created by a user account (requires basic auth)<br/>
+ <code>curl -X GET -u "testuser:123" http://nodester.com/apps</code></td></tr>
+ <tr><td>&nbsp;</td><td><b>app</b></td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled success">POST</a></td><td><b>/app</b> - Creates nodejs app for hosting (requires basic auth and returns the port address required for use along with a git repo to push to)<br/>
+ <code>curl -X POST -u "testuser:123" -d "appname=a&start=hello.js" http://api.nodester.com/app</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled">PUT</a></td><td><b>/app</b> - Updates starting app name (requires basic auth, appname, and starting page and returns the port address required for use along with a git repo to push to and running status of the app)<br/>
+ <code>curl -X PUT -u "testuser:123" -d "appname=a&start=hello1.js" http://api.nodester.com/app</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled">PUT</a></td><td><b>/app</b> - Start and stop your hosted nodejs app (requires basic auth, appname, and running=true|false and returns the port address required for use along with a git repo to push to)<br/>
+ <code>curl -X PUT -u "testuser:123" -d "appname=a&running=true" http://api.nodester.com/app</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled danger">DELETE</a></td><td><b>/app </b>- Deletes nodejs app (requires basic auth and appname)<br/>
+ <code>curl -X DELETE -u "testuser:123" -d "appname=test" http://api.nodester.com/app</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled primary">GET</a></td><td><b>/app/&lt;appname&gt;</b> - get nodejs app info (requires basic auth and appname)<br/>
+ <code>curl -u "testuser:123" http://api.nodester.com/app/appname</code></td></tr>
+ <tr><td><b>applogs</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled primary">GET</a></td><td><b>/applogs/&lt;appname&gt;</b> - Gets nodejs app logs (requires basic auth and appname)<br/>
+ <code>curl -u "testuser:123" http://api.nodester.com/applogs/appname</code></td></tr>
+ <tr><td><b>env</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled">PUT</a></td><td><b>/env</b> - Create/update environment key/value pair (requires basic auth, appname, and environment key and value)<br/>
+ <code>curl -X PUT -u "testuser:123" -d "appname=a&key=color&value=blue" http://api.nodester.com/env</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled danger">DELETE</a></td><td><b>/env</b> - Deletes environment key/value pair (requires basic auth, appname, and environment key)<br/>
+ <code>curl -X DELETE -u "testuser:123" -d "appname=test&key=color" http://api.nodester.com/env</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled primary">GET</a></td><td><b>/env</b> - Gets environment info (requires basic auth, appname, and environment key)<br/>
+ <code>curl -u "testuser:123" -d "appname=test&key=color" http://api.nodester.com/env</code></td></tr>
+ <tr><td><b>status</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled primary">GET</a></td><td><b>/status</b> - Returns platform status and number of apps hosted and running<br/>
+ <code>curl http://nodester.com/status</code></td></tr>
+ <tr><td>&nbsp;</td><td><b>npm</b></td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled success">POST</a></td><td><b>/npm</b> - Allows you to manage the NPM packages for an application.<br/>
+ <code>curl -X POST -u "testuser:123" -d "appname=a&action=install&package=express" http://api.nodester.com/npm</code><br/>
+ <code>curl -X POST -u "testuser:123" -d "appname=a&action=update&package=express" http://api.nodester.com/npm</code><br/>
+ <code>curl -X POST -u "testuser:123" -d "appname=a&action=uninstall&package=express" http://api.nodester.com/npm</code></td></tr>
+ <tr><td><b>appdomains</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled success">POST</a></td><td><b>/appdomains</b> - Creates app domain for hosting example.com (requires basic auth)<br/>
+ <code>curl -X POST -u "testuser:123" -d "appname=test&domain=example.com" http://api.nodester.com/appdomains</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled danger">DELETE</a></td><td><b>/appdomains</b> - Deletes app domain for hosting example.com (requires basic auth)<br/>
+ <code<curl -X DELETE -u "testuser:123" -d "appname=test&domain=example.com" http://api.nodester.com/appdomains</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled primary">GET</a></td><td><b>/appdomains</b> - Gets list of your domains (requires basic auth)<br/>
+ <code>curl -u "testuser:123" http://api.nodester.com/appdomains</code></td></tr>
+ <tr><td><b>reset_password</b></td><td>&nbsp;</td><td>&nbsp;</td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled success">POST</a></td><td><b>/reset_password</b> - Sends a e-mail with a token to reset your user password<br/>
+ <code>curl -X POST -d "user=your_username" http://nodester.com/reset_password</code></td></tr>
+ <tr><td>&nbsp;</td><td><a class="btn disabled">PUT</a></td><td><b>/reset_password/&lt;token&gt;</b> - Updates your password using the provided token<br/>
+ <code>curl -X PUT -d "password=your_new_password" http://nodester.com/reset_password/&lt;token&gt;</code></td></tr>
+ </table>
+
+
+ </div>
+ </div>
+
+ </div>
+ </div>
+
<footer>
<p>&copy;
<script type="text/javascript">
View
12 developer.html
@@ -47,16 +47,18 @@
</div>
<div class="container">
-
<div class="span16"><br/>
<h1>Welcome Nodesters!</h1>
<p>Nodester is a free and open source Node.JS hosting PaaS. Our Web Admin Panel is coming soon. Until then, here are a few tricks to get you started.</p>
+ <p>
+ <iframe width="853" height="480" src="http://www.youtube.com/embed/1OdmF26_vmc" frameborder="0" allowfullscreen></iframe>
+ </p>
<br/>
<h2><img src="rocket-md-right.png" width="30"> Requesting a Coupon Code to Register</h2>
<p>curl -X POST -d "email=your_address@gmail.com" http://nodester.com/coupon<br/><br/>
<div id="reqbutton" class="btn">OR CHEAT</div>
<div id="reqform" style="display: none"><br/>
- <form action="/coupon" method="post">
+ <form action="/coupon" method="post" class="form-stacked">
<p><label for="email">Email Adderss:</label>
<input type="text" name="email" id="email" value="" /><input type="submit" name="send" class="formbutton" value="Send" />
</form>
@@ -69,7 +71,7 @@
curl -X POST -d "coupon=mycoupon&user=testuser&password=123&email=chris@nodester.com&rsakey=ssh-rsa AAAAB3NzaC1yc..." http://nodester.com/user<br><br/>
<div id="regbutton" class="btn">OR CHEAT</div>
<div id="regform" style="display: none"><br/>
- <form action="/user" method="post">
+ <form action="/user" method="post" class="form-stacked">
<p><label for="name">Coupon:</label>
<input type="password" name="coupon" id="coupon" value="" /><br />
<label for="name">Username:</label>
@@ -92,15 +94,15 @@
<p>
npm install nodester-cli -g <br/>
nodester user setup &lt;username&gt; &lt;password&gt; <br/>
- nodester user setkey
+ <!-- nodester user setkey -->
</p><br/>
<h2><img src="rocket-md-right.png" width="30"> Launch Your Node.JS Application!</h2>
<p>You are ready to deploy your test Hello World app with 2 commands.</p>
<p>
nodester app create &lt;appname&gt;<br/>
nodester app init &lt;appname&gt; <br/>
- Visit http://&lt;appname&gt;.nodester.com!
+ http://&lt;appname&gt;.nodester.com
</p>
</div>
View
13 index.html
@@ -51,8 +51,8 @@
<!-- Main hero unit for a primary marketing message or call to action -->
<div class="hero-unit">
<h1>OpenSource Node.JS PaaS</h1><br/>
-<img src="nodesterbw_transparent.png" align="right" width="250">
-<!-- <img src="rocket-md.png" align="right" width="250"> -->
+<!-- <img src="nodesterbw_transparent.png" align="right" width="250"> -->
+<img src="rocket-md.png" align="right" width="250">
<p>Deploy your Node.JS applications to Nodester.com for FREE or deploy your apps to your own private cloud instance of Nodester running in your own datacenter or on Amazon EC2, Rackspace, or GoGrid!
</p><br/><p>
@@ -82,7 +82,7 @@
<!-- Example row of columns -->
<div class="row">
<div class="span-one-third">
- <h2><img src="rocket-md-right.png" width="30">Preparing Launch</h2>
+ <h2><img src="rocket-md-right.png" width="30">Systems Check</h2>
<p>Request your free Nodester Node.JS hosting coupon.</p>
<!-- <p><a class="btn" href="#">View details &raquo;</a></p> -->
</div>
@@ -92,7 +92,7 @@
<!-- <p><a class="btn" href="#">View details &raquo;</a></p> -->
</div>
<div class="span-one-third">
- <h2><img src="rocket-md-right.png" width="30">Launch App</h2>
+ <h2><img src="rocket-md-right.png" width="30">3-2-1 Launch!</h2>
<p>You are ready to deploy your test Hello World app with 2 commands.</p>
<!-- <p><a class="btn" href="#">View details &raquo;</a></p> -->
</div>
@@ -135,7 +135,8 @@
nodester app create &lt;appname&gt;<br/>
nodester app info &lt;appname&gt;<br/>
- git remote add nodester the_url_returned_by_our_api and git push nodester master
+ git remote add nodester &lt;the_url_returned_by_our_api&gt; <br/>
+ git push nodester master
</p><br/>
</blockquote>
<p>
@@ -163,7 +164,7 @@
</blockquote>
<blockquote>Visit your app at http://&lt;appname&gt;.nodester.com</blockquote>
- <p>Don't worry :) You only need to start the application once. Subsequent git pushes will automatically pick up your changes and restart.</p>
+ <p>Note: You only need to start the application once. Subsequent git pushes will automatically pick up your changes and restart.</p>
</div>

0 comments on commit 1048e48

Please sign in to comment.
Something went wrong with that request. Please try again.