Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 113 lines (55 sloc) 2.192 kB
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
1
2
3 # noc
4 (**N**odejitsu **O**perations **C**ontroller)
5
6 ## noc is a CLI tool for easily deploying node.js applications on the Nodejitsu platform
7
8
9 ## INSTALLATION
10
11 sudo npm install noc
12
13
14 ## USAGE
15
16 1. Get an account.
17 2. Prepare an package.json for your application OR select an application from the <a href="#marketplace">marketplace</a>
18 3. Boom! Deploy.
19
20
21 ## User API
22
23
24 ### Inviting a new user
25
26 noc user invite [email]
27
28 *sends email to user with invite code*
29
30 ### Creating a new user
31
32 noc user create [username] [password] [email] [pathToSSHkey] [invitecode]
33
34 *invite code is optional. If you don't provide a valid invitecode, you will be provided one via email.*
35
36 ### Confirming an account
37
38 noc user confirm [invite code]
39
40 *confirms a user account based on invite code*
41
42 ### Resetting an account's password
43
44 noc user reset [username]
45
46 *sends a reset password email to username*
47
48
49 ## Application API
50
51 ### Listing applications
52
53 noc app ls
54
55 ### Starting / Stopping / Restarting applications
56
57 noc app [appname] [start|stop|restart]
58
59
60 ## Deployment API
61
62 ### Deploying a package.json from your local machine
63
64 noc deploy /pathTo/myapp/
65
66 */pathTo/myapp/ must point to a folder which contains a valid package.json <a href="#prepare">Read More</a>*
67
68 ### Deploying applications from the Marketplace
69
70 noc market buy [appname]
71
72 *prompts user to specify a domain name*
73
74 ## Marketplace API
75
76 ### Listing Marketplace applications
77
78 noc market ls
79
80 ### Publishing your own application to the Marketplace
81
82 noc market publish /pathTo/myApp
83
84 */pathTo/myapp/ must point to a folder which contains a valid package.json <a href="#prepare">Read More</a>*
85
86 ## PREPARING YOUR APPLICATION FOR DEPLOYMENT
87 <a name="prepare"/>
88 ### Building a valid package.json
89
90 TODO:
91
92 ## Specify your repository type
93
94 TODO:
95
96 ## Specify your starting script
97
98 TODO:
99
100 ## Ensure your npm dependencies are listed correctly
101
102 TODO:
103
104 ## Bundle any dependencies which are not available on npm
105
106 TODO:
107
108 ## THE MARKETPLACE
109
110 The Nodejitsu Marketplace is an store where you can purchase node.js applications. We currently have several free applications and are always accepting new ones!
111
112 TODO:
Something went wrong with that request. Please try again.