cold/cold.1.html at main · caltechlibrary/cold · GitHub

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
<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>cold</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="search.html">Search</a></li>
    <li><a href="https://github.com/caltechlibrary/cold">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>cold</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>cold <a href="#options">OPTIONS</a></p>
<h1 id="description">DESCRIPTION</h1>
<p>cold provides the admin interface for cold. Cold is implemented using
dataset collections for object persistence and relies on datasetd for
JSON API to each collection.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>help</dt>
<dd>
display help
</dd>
<dt>license</dt>
<dd>
display license
</dd>
<dt>version</dt>
<dd>
display version
</dd>
<dt>debug</dt>
<dd>
turn on debug logging
</dd>
<dt>port</dt>
<dd>
set the port number, default 8111
</dd>
<dt>htdocs</dt>
<dd>
set the static content directory, default ./htdocs
</dd>
<dt>baseUrl</dt>
<dd>
set the browser’s base path reference, default ://
</dd>
<dt>apiUrl</dt>
<dd>
set the url to the datasetd API provided for cold
</dd>
</dl>
<h1 id="example">EXAMPLE</h1>
<p>cold is setup to run at <a href="http://localhost:8111"
class="uri">http://localhost:8111</a>. The static content hosted in the
“/var/www/html/cold/app” directory. The datasetd service is setup to run
at <a href="http://localhost:8112" class="uri">http://localhost:8112</a>
supporting the people, groups and vocabularies dataset collections.</p>
<pre class="shell"><code>cold -port=8111 -htdocs=/var/www/html/cold/app \
           -apiUrl=http://localhost:8112</code></pre>
</section>
<footer-global></footer-global>
</body>
</html>