cold/README_Admin.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
<!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="cold-admin">COLD Admin</h1>
<blockquote>
<p>COLD - controlled object lists and datum</p>
</blockquote>
<p>This directory implements the staff interface for <a
href="https://github.com/caltechlibrary/cold">cold</a>. It is
implemented in TypeScript, compiled into an executable via <a
href="https://deno.land">Deno</a>. It is intended to run as a service
via systemd in Linux or other POSIX system. Objects are stored in <a
href="https://caltechlibrary.github.io/dataset">dataset</a> collection.
The collections are accessed via JSON API provided by <a
href="https://caltechlibrary.github.io/datatset/datasetd.1.html">datasetd</a>.
Dataset collections are using <a href="https://sqlite.org">SQLite 3</a>
for object storage.j</p>
<h2 id="requirements">Requirements</h2>
<ul>
<li><a href="https://github.com/caltechlibrary/dataset">Dataset</a>
&gt;= 2.1.18 (running COLD Admin)</li>
<li><a href="https://deno.land">Deno</a> &gt;= 2.0 (used to build the
app and compile services) (build COLD Admin)</li>
<li><a href="https://pandoc.org">Pandoc</a> &gt;= 3.1 (render
documentation and version.ts) (build COLD Admin)</li>
<li>GNU Make (build COLD Admin)</li>
<li>Zip (packaging build and installation)</li>
<li>Bash+cURL or Powershell (installation only)</li>
</ul>
<h2 id="additional-resources">Additional Resources</h2>
<ul>
<li>COLD Admin <a href="user_manual.html">User Manual</a></li>
</ul>
<h2 id="report-problems-and-issues">Report problems and issues</h2>
<p>See <a href="https://github.com/caltechlibrary/cold/issues">Github
Issues</a></p>
</section>
<footer-global></footer-global>
</body>
</html>