-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
183 lines (159 loc) · 8.16 KB
/
index.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
---
layout: default
title: Home
---
<header>
<div class="media">
<img src="{{ site.baseurl }}/images/cantaloupe.png" class="mr-3" width="154" height="81">
<div class="media-body">
<h1 class="mt-0">Cantaloupe
<br>
<small>High-performance dynamic image server in Java</small></h1>
</div>
</div>
</header>
<hr>
<p>Cantaloupe is an open-source dynamic image server for on-demand generation of derivatives of high-resolution source images. With available operations including cropping, scaling, and rotation, it can support deep-zooming image viewers, as well as on-the-fly thumbnail generation. Compliance with the <a href="http://iiif.io/">IIIF Image API</a> enables it to work with <a href="http://iiif.io/apps-demos/">a growing number of client applications</a>.</p>
<div class="text-center">
<button id="download-scroller" data-target="#get-started" type="button" class="btn btn-lg btn-outline-success">
<span class="fa fa-download"></span> Download
</button>
</div>
<section id="features">
<div class="card-group">
<div class="card">
<div class="card-body">
<h4 class="card-title">Easy</h4>
<ul>
<li>Get started in minutes. A web server is built right in.</li>
<li><span class="text-info">One human-friendly configuration file</span> with extensive inline help.</li>
</ul>
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">Standards-Compliant</h4>
<ul>
<li>Fully conformant to all <span class="text-info">IIIF Image API</span> versions through 3.0.</li>
</ul>
</div>
</div>
</div>
<div class="card-group">
<div class="card">
<div class="card-body">
<h4 class="card-title">Secure</h4>
<ul>
<li><span class="text-info">Dynamic, selective image and text watermarking</span> with fine-grained controls.</li>
<li><span class="text-info">On-the-fly redaction</span> of image regions.</li>
<li>Built-in support for HTTPS and HTTP Basic authentication.</li>
<li>Supports <span class="text-info">arbitrary authorization policies</span> for integration into diverse infrastructures, and tiered access to dynamically degraded images.</li>
</ul>
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">Flexible</h4>
<ul>
<li>Serve images from multiple sources, with different settings, via the same application instance.</li>
<li>Customize behavior using a delegate class written in Ruby or Java.</li>
<li>Dynamically transform embedded XMP image metadata.</li>
<li>HTTP methods for common management functions like purging the cache and updating the configuration.</li>
</ul>
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">High-Quality</h4>
<ul>
<li><span class="text-info">Selectable resample filters, sharpening levels, and compression levels</span> to optimize output for speed or quality.</li>
</ul>
</div>
</div>
</div>
<div class="card-group">
<div class="card">
<div class="card-body">
<h4 class="card-title">Modular</h4>
<ul>
<li><span class="text-info">Pluggable sources</span> for retrieving images from a variety of places—including filesystems, databases, remote web servers, and cloud storage—with optional scriptable "hooks" to enable dynamic source selection and image lookup.</li>
<li><span class="text-info">Pluggable processors</span> to support a variety of source image formats—as well as still-frame extraction from videos in a variety of formats.</li>
<li><span class="text-info">Pluggable caches</span> with customizable strategies and available automatic maintenance.</li>
</ul>
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">Fast</h4>
<ul>
<li><span class="text-info">Optimized JPEG2000 and TIFF readers</span> capable of excellent performance with massive images.</li>
<li>Available <span class="text-info">filesystem, database, Redis, in-memory, and cloud storage caches</span> to speed up response times and reduce server load.</li>
<li>An in-memory metadata cache boosts performance for frequently-accessed images.</li>
</ul>
</div>
</div>
</div>
</section>
<section id="get-started">
<h1 class="display-4" style="margin-top:0.5em">Get Started</h1>
<div class="card-group">
<div class="card">
<div class="card-header">Download</div>
<div class="card-body">
<div class="text-center">
<p class="text-info">Upgrading? Review <span class="filename">UPGRADING.md</span> and <span class="filename">CHANGES.md</span> in the downloaded file for important info.</p>
<a href="https://github.com/cantaloupe-project/cantaloupe/releases" class="btn btn-lg btn-success download-button"><i class="fa fa-download"></i> Download</a>
<p class="text-muted">Requires Java 11+</p>
<p><a class="btn btn-sm btn-dark" href="https://github.com/cantaloupe-project/cantaloupe/releases">
<i class="fa fa-download"></i> Download an Older Version</a></p>
<p class="text-muted">Optional components, such as particular processors, may have other dependencies; see the <a href="manual/">user manual</a>.</p>
</div>
</div>
</div>
<div class="card">
<div class="card-header">Configure</div>
<div class="card-body">
<ol>
<li>The distribution archive bundles a sample configuration file, named <span class="filename">cantaloupe.properties.sample</span>. Make a copy and open it in a text editor.</li>
<li>Set <code>FilesystemSource.BasicLookupStrategy.path_prefix</code> to a folder path containing some images.</li>
</ol>
</div>
</div>
<div class="card">
<div class="card-header">Run</div>
<div class="card-body">
<ul class="nav nav-pills" role="tablist">
<li class="nav-item">
<a class="nav-link active" id="run-mac-tab" data-toggle="tab" href="#run-mac" role="tab" aria-controls="home" aria-selected="true">macOS/Linux</a>
</li>
<li class="nav-item">
<a class="nav-link" id="run-windows-tab" data-toggle="tab" href="#run-windows" role="tab" aria-controls="profile" aria-selected="false">Windows</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade show active" id="run-mac" role="tabpanel" aria-labelledby="run-mac-tab">
<p>From a command prompt:</p>
<pre>java -Dcantaloupe.config=/path/to/cantaloupe.properties -Xmx2g -jar cantaloupe-<span class="latest-release">x.x.x</span>.jar</pre>
</div>
<div class="tab-pane fade" id="run-windows" role="tabpanel" aria-labelledby="run-windows-tab">
<p>From a command prompt:</p>
<pre>java -Dcantaloupe.config=C:\path\to\cantaloupe.properties -Xmx2g -jar cantaloupe-<span class="latest-release">x.x.x</span>.jar</pre>
</div>
</div>
<p>Now, assuming you have an image named <span class="filename">image.tif</span>, try accessing:</p>
<ul>
<li><a href="http://localhost:8182/iiif/3/image.tif/info.json">http://localhost:8182/iiif/3/image.tif/info.json</a></li>
<li><a href="http://localhost:8182/iiif/3/image.tif/0,0,200,200/max/0/default.jpg">http://localhost:8182/iiif/3/image.tif/0,0,200,200/max/0/default.jpg</a></li>
</ul>
</div>
</div>
</div>
</section>
<section id="get-help">
<h1 class="display-4" style="margin-top:0.5em">Get Help</h1>
<p>For questions and comments, please <a href="https://github.com/cantaloupe-project/cantaloupe/discussions/new">start a GitHub discussion</a>.</p>
<p>For bug reports, feature requests, and other to-do items, please <a href="https://github.com/cantaloupe-project/cantaloupe/issues/new">file a GitHub issue</a>.</p>
</section>
<script type="text/javascript">
$(document).ready(function() { injectLatestReleaseInfo(); });
</script>