-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdirectory_sync.1.html
72 lines (72 loc) · 2.03 KB
/
directory_sync.1.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
<!DOCTYPE html>
<html lang="en-US">
<head>
<title>COLD (Controlled Object List and Datum (Concept))</title>
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<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>directory_sync</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>directory_sync <a href="#options">OPTIONS</a></p>
<h1 id="description">DESCRIPTION</h1>
<p>directory_sync synchronizes the content between Caltech Directory and
CaltechPEOPLE. It uses the COLD Admin API as well as the Caltech
Directory website content as a data source.</p>
<p>Assuming COLD Admin is running on it’s standard ports no
configuration is needed.</p>
<p>directory_sync is suitable to run from a cronjob on the same machine
which hosts COLD.</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 for the COLD Admin JSON API, default 8112
</dd>
<dt>directory</dt>
<dd>
set the Caltech Directory URL, default https://directory.caltech.edu
</dd>
</dl>
<h1 id="example">EXAMPLE</h1>
<p>directory_sync is setup to contact https://directory.caltech.edu to
harvest directory content.</p>
<pre class="shell"><code>directory_sync</code></pre>
</section>
<footer>
<span>© 2025 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:[email protected]">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
</body>
</html>