-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathget-started.html
243 lines (203 loc) · 12 KB
/
get-started.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE html>
<html >
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OpenCPU User Manual</title>
<meta name="description" content="OpenCPU: Producing and Reproducing Results">
<meta name="generator" content="bookdown 0.4.1 and GitBook 2.6.7">
<meta property="og:title" content="OpenCPU User Manual" />
<meta property="og:type" content="book" />
<meta property="og:description" content="OpenCPU: Producing and Reproducing Results" />
<meta name="github-repo" content="opencpu/opencpu.github.io" />
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="OpenCPU User Manual" />
<meta name="twitter:description" content="OpenCPU: Producing and Reproducing Results" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="prev" href="index.html">
<link rel="next" href="the-api.html">
<script src="libs/jquery-2.2.3/jquery.min.js"></script>
<link href="libs/gitbook-2.6.7/css/style.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-bookdown.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-highlight.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-search.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-fontsettings.css" rel="stylesheet" />
<style type="text/css">
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
</style>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body>
<div class="book without-animation with-summary font-size-2 font-family-1" data-basepath=".">
<div class="book-summary">
<nav role="navigation">
<ul class="summary">
<li><a href="./">OpenCPU User Manual</a></li>
<li class="divider"></li>
<li class="chapter" data-level="1" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i><b>1</b> Welcome</a><ul>
<li class="chapter" data-level="1.1" data-path="index.html"><a href="index.html#why-opencpu"><i class="fa fa-check"></i><b>1.1</b> Why OpenCPU</a></li>
<li class="chapter" data-level="1.2" data-path="index.html"><a href="index.html#how-it-works"><i class="fa fa-check"></i><b>1.2</b> How it works</a></li>
<li class="chapter" data-level="1.3" data-path="index.html"><a href="index.html#pieces"><i class="fa fa-check"></i><b>1.3</b> Pieces</a></li>
<li class="chapter" data-level="1.4" data-path="index.html"><a href="index.html#information-and-support"><i class="fa fa-check"></i><b>1.4</b> Information and support</a></li>
</ul></li>
<li class="chapter" data-level="2" data-path="get-started.html"><a href="get-started.html"><i class="fa fa-check"></i><b>2</b> Get started</a><ul>
<li class="chapter" data-level="2.1" data-path="get-started.html"><a href="get-started.html#hello-world"><i class="fa fa-check"></i><b>2.1</b> Hello world</a></li>
<li class="chapter" data-level="2.2" data-path="get-started.html"><a href="get-started.html#what-are-apps"><i class="fa fa-check"></i><b>2.2</b> What are apps</a></li>
<li class="chapter" data-level="2.3" data-path="get-started.html"><a href="get-started.html#deployment"><i class="fa fa-check"></i><b>2.3</b> Deployment</a></li>
</ul></li>
<li class="chapter" data-level="3" data-path="the-api.html"><a href="the-api.html"><i class="fa fa-check"></i><b>3</b> The API</a><ul>
<li class="chapter" data-level="3.1" data-path="the-api.html"><a href="the-api.html#functions"><i class="fa fa-check"></i><b>3.1</b> Functions</a></li>
<li class="chapter" data-level="3.2" data-path="the-api.html"><a href="the-api.html#data-formats"><i class="fa fa-check"></i><b>3.2</b> Data Formats</a><ul>
<li class="chapter" data-level="3.2.1" data-path="the-api.html"><a href="the-api.html#json"><i class="fa fa-check"></i><b>3.2.1</b> json</a></li>
<li class="chapter" data-level="3.2.2" data-path="the-api.html"><a href="the-api.html#protocol-buffers"><i class="fa fa-check"></i><b>3.2.2</b> Protocol Buffers</a></li>
<li class="chapter" data-level="3.2.3" data-path="the-api.html"><a href="the-api.html#other-types"><i class="fa fa-check"></i><b>3.2.3</b> Other types</a></li>
</ul></li>
</ul></li>
<li class="chapter" data-level="4" data-path="apps.html"><a href="apps.html"><i class="fa fa-check"></i><b>4</b> Apps</a><ul>
<li class="chapter" data-level="4.1" data-path="apps.html"><a href="apps.html#functions-1"><i class="fa fa-check"></i><b>4.1</b> Functions</a></li>
<li class="chapter" data-level="4.2" data-path="apps.html"><a href="apps.html#files"><i class="fa fa-check"></i><b>4.2</b> Files</a></li>
<li class="chapter" data-level="4.3" data-path="apps.html"><a href="apps.html#javascript"><i class="fa fa-check"></i><b>4.3</b> JavaScript</a></li>
</ul></li>
<li class="chapter" data-level="5" data-path="developing-apps.html"><a href="developing-apps.html"><i class="fa fa-check"></i><b>5</b> Developing Apps</a></li>
<li class="chapter" data-level="6" data-path="opencpu-server.html"><a href="opencpu-server.html"><i class="fa fa-check"></i><b>6</b> OpenCPU Server</a><ul>
<li class="chapter" data-level="6.1" data-path="opencpu-server.html"><a href="opencpu-server.html#installation"><i class="fa fa-check"></i><b>6.1</b> Installation</a><ul>
<li class="chapter" data-level="6.1.1" data-path="opencpu-server.html"><a href="opencpu-server.html#ubuntu-16.04"><i class="fa fa-check"></i><b>6.1.1</b> Ubuntu 16.04</a></li>
<li class="chapter" data-level="6.1.2" data-path="opencpu-server.html"><a href="opencpu-server.html#debian"><i class="fa fa-check"></i><b>6.1.2</b> Debian</a></li>
<li class="chapter" data-level="6.1.3" data-path="opencpu-server.html"><a href="opencpu-server.html#fedora-centos"><i class="fa fa-check"></i><b>6.1.3</b> Fedora / CentOS</a></li>
<li class="chapter" data-level="6.1.4" data-path="opencpu-server.html"><a href="opencpu-server.html#docker"><i class="fa fa-check"></i><b>6.1.4</b> Docker</a></li>
</ul></li>
<li class="chapter" data-level="6.2" data-path="opencpu-server.html"><a href="opencpu-server.html#configuring"><i class="fa fa-check"></i><b>6.2</b> Configuring</a><ul>
<li class="chapter" data-level="6.2.1" data-path="opencpu-server.html"><a href="opencpu-server.html#installing-packages"><i class="fa fa-check"></i><b>6.2.1</b> Installing packages</a></li>
<li class="chapter" data-level="6.2.2" data-path="opencpu-server.html"><a href="opencpu-server.html#installing-apps"><i class="fa fa-check"></i><b>6.2.2</b> Installing apps</a></li>
<li class="chapter" data-level="6.2.3" data-path="opencpu-server.html"><a href="opencpu-server.html#custom-settings"><i class="fa fa-check"></i><b>6.2.3</b> Custom settings</a></li>
<li class="chapter" data-level="6.2.4" data-path="opencpu-server.html"><a href="opencpu-server.html#performance-tuning"><i class="fa fa-check"></i><b>6.2.4</b> Performance Tuning</a></li>
</ul></li>
<li class="chapter" data-level="6.3" data-path="opencpu-server.html"><a href="opencpu-server.html#build-from-source"><i class="fa fa-check"></i><b>6.3</b> Build from Source</a></li>
</ul></li>
<li class="chapter" data-level="7" data-path="docker-1.html"><a href="docker-1.html"><i class="fa fa-check"></i><b>7</b> Docker</a></li>
<li class="divider"></li>
<li><a href="https://github.com/opencpu/opencpu.github.io" target="blank">(c) Jeroen Ooms, 2017</a></li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i><a href="./">OpenCPU User Manual</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<section class="normal" id="section-">
<div id="get-started" class="section level1">
<h1><span class="header-section-number">Chapter 2</span> Get started</h1>
<p>Steps to develop apps:</p>
<ol style="list-style-type: decimal">
<li>Create R package with your stuff</li>
<li>Expose via OpenCPU single user server</li>
<li>Deploy via public server or docker or elsewhere</li>
</ol>
<div id="hello-world" class="section level2">
<h2><span class="header-section-number">2.1</span> Hello world</h2>
<ol style="list-style-type: decimal">
<li>Start a single-user server</li>
<li>Run some apps</li>
<li>Poke around with <code>curl</code> or the test page.</li>
<li>Get some objects in formats, do rpc, post data. Reuse objects from session.</li>
</ol>
</div>
<div id="what-are-apps" class="section level2">
<h2><span class="header-section-number">2.2</span> What are apps</h2>
</div>
<div id="deployment" class="section level2">
<h2><span class="header-section-number">2.3</span> Deployment</h2>
<p>Either:</p>
<ol style="list-style-type: decimal">
<li>Deploy on public server</li>
<li>Run your own</li>
</ol>
</div>
</div>
</section>
</div>
</div>
</div>
<a href="index.html" class="navigation navigation-prev " aria-label="Previous page"><i class="fa fa-angle-left"></i></a>
<a href="the-api.html" class="navigation navigation-next " aria-label="Next page"><i class="fa fa-angle-right"></i></a>
</div>
</div>
<script src="libs/gitbook-2.6.7/js/app.min.js"></script>
<script src="libs/gitbook-2.6.7/js/lunr.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-search.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-sharing.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-fontsettings.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-bookdown.js"></script>
<script src="libs/gitbook-2.6.7/js/jquery.highlight.js"></script>
<script>
gitbook.require(["gitbook"], function(gitbook) {
gitbook.start({
"sharing": {
"github": false,
"facebook": true,
"twitter": true,
"google": false,
"weibo": false,
"instapper": false,
"vk": false,
"all": ["facebook", "google", "twitter", "weibo", "instapaper"]
},
"fontsettings": {
"theme": "white",
"family": "sans",
"size": 2
},
"edit": {
"link": "https://github.com/rstudio/bookdown-demo/edit/master/01-get-started.Rmd",
"text": "Edit"
},
"download": null,
"toc": {
"collapse": "subsection"
}
});
});
</script>
</body>
</html>