Skip to content

Commit

Permalink
cantaloupe updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffreycwitt committed May 24, 2024
1 parent 2b6a808 commit 1e961a9
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 36 deletions.
26 changes: 15 additions & 11 deletions dhsi/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@
5. [Navplace viewer](day-two/navplace.md)
2. [Work Period]((day-two/configuring-viewers.md#work-period))

## Wednesday, Session 1: 9:00am-10:15am
## Wednesday, Session 7: 9:00am-10:15am
1. [Introduction to Annotations](day-three/annotations.md)
2. [Creating Annotations in Annotorious](day-three/annotorious.md)
2. [Creating Annotations in Mirador](day-three/creating-annotations.md)
3. [Annotation Stores](day-three/annotations-stores.md)
4. [Annotation Server Install](day-three/annotations-stores-install.md)

## Wednesday, Session 2: 10:30am-12:00pm
## Wednesday, Session 8: 10:30am-12:00pm
2. [Simple annotation server](day-three/annotations-sas.md)
3. [Annonatate](day-three/annonatate.md)
4. [Storytelling editors](day-three/exhibit.md)
Expand All @@ -73,12 +73,9 @@
3. [Adding annotations to a manifest](day-three/annotation-in-manifest.md)


## Wednesday, Session 3: 1:00pm-2:15pm
1. IIIF Search API
1. Using Annotations
2. Examples in Mirador and UV
3. Add the service block to the manifest
2. Exercise
## Wednesday, Session 9: 1:00pm-2:15pm
1. [IIIF Search API](day-three/iii-search-api.md)
2. [Exercise](day-three/iii-search-api.md#exercise)

## Wednesday, Session 4: 2:30pm-3:45pm
1. [Reusing Annotations in your website](day-three/annona.md)
Expand All @@ -89,13 +86,20 @@
## Thursday, Session 1: 9:00am-10:15am
1. [Advanced used cases](day-four/advanced-use-cases.md)

## Thursday, Session 2: 10:30am-12:00pm
## Thursday, Session 12: 10:30am-12:00pm
1. Introduction to Jekyll and GitHub pages
2. Wax

## Thursday, Session 13: 10:30am-12:00pm

## Thursday, Session 14: 1:00pm-2:15pm

- [Overview](README.md)
## Thursday, Session 15: 2:30pm-3:45pm

## Friday, Session 16: 9:00am-10:15am


<!-- - [Overview](README.md)
- [Guest Presentations](GuestPresentations.md)
## Day One - Monday
Expand Down Expand Up @@ -157,5 +161,5 @@
## Extras
- [Guides](extras/README.md)
- [Using non IIIF images in a manifest](https://glenrobson.github.io/iiif_stuff/simple_images/)
- [A basic Video manifest](extras/AVExample.md)
- [A basic Video manifest](extras/AVExample.md) -->

72 changes: 47 additions & 25 deletions dhsi/day-one/cantaloupe.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

## Launching Your Own Image Server With Cantaloupe
## Launching Your Own Image Server

So, far we've seen some ways to get our images online and IIIF accessible with minimal effort. This is great for small or personal projects.

Expand All @@ -11,50 +11,72 @@ But it has the advantage of being scalable. Once set up, it allows you to server

In this section, we're going to see what it looks like to set up such server. You may or may not be responsible for setting up such a server, but it's good to see how it is done. This will help you work with project partners and help you see that setting up such a server isn't actually that difficult. :)

### Download Cantaloupe
First let's just take a look at the [Cantaloupe Landing Page](https://cantaloupe-project.github.io/) to get a glimpse of what it can do.

TODO: I dumped this in from an earlier presentation; needs to be updated for newest cantaloupe version and links need to be checked
We can notice things here like

For more information, checkout the [Cantaloupe getting started guide](https://cantaloupe-project.github.io/manual/4.1/getting-started.html).
* authorization policy
* watermarking
* customizable images sources (e.g. AWS S3, etc)

[Download Cantaloupe v4.1.1](https://github.com/medusa-project/cantaloupe/releases/download/v4.1.1/cantaloupe-4.1.1.zip)

If you're going to be responsible for serving images at scale or at the institutional level, then familiarity with images servers like Cantaloupe is important.

## Installing Cantaloupe

So in this exercise, we're going to walk through setting up and running Cantaloupe.

There actually aren't that many steps to getting it up and running. But we can also look at few of the configuration properties to see how it can be modified and customized to meet various needs.

I've created two paths for installation.

1. You can run this locally on your own computer (recommended so that you can really be in control of the process)
2. Or you can launch a github codespace instance that I have pre-configured (recommended if you don't have Java installed on your computer)

### Running Cantaloupe on Your Local Computer

To start you need to download the Cataloupe build. [Download Cantaloupe v5.0.6](https://github.com/cantaloupe-project/cantaloupe/releases/download/v5.0.6/cantaloupe-5.0.6.zip)

Go to your downloads folders

Unzip the download and place the contents of that folder in our `WorkshopDir` folder.
Unzip the download and you should have a new folder called `cantaloupe-5.0.6`.

`$ unzip cantaloupe-4.1.1.zip`
Open `cantaloupe-5.0.6` in vscode.

Now move the extracted folder to our `WorkshopDir`
In this folder, there should be a file called `cantaloupe.properties.sample`. Create a copy of this, called `cantaloupe.properties`

`$ mv cantaloupe-4.1.1 ~/Your/Path/To/WorkshopDir`
We will modify some properties here in a moment, but the default properties should be enough to get the instance working.

Now navigate to that WorkshopDir
In vscode go to the terminal and run:

Using the alias we set up, e.g. `$ workshop` or with your full path, e.g. `$ cd ~/Your/Path/To/WorkshopDir`
`$ java -Dcantaloupe.config=./cantaloupe.properties -Xmx2g -jar Cantaloupe-5.0.6.jar`

List all the files in this directory
Now navigate to [http://127.0.0.1:8182???](http://127.0.0.1:8182???) in your browser.

`$ ls`
### Running Cantaloupe in Code Spaces

And you should see `cantaloupe-4.1.1`
Via github code spaces, I've configured a computer that already has Cantaloupe downloaded and installed.

### Configure Cantaloupe
So all you have to do is launch this computer in your browser here.

Navigate into `cantaloupe-4.1.1`
And then run cantaloupe.

`$ cd cantaloupe-4.1.1`
In the browser based vscode, go to the terminal and run:

Create a copy of the sample configuration file
`$ java -Dcantaloupe.config=./cantaloupe.properties -Xmx2g -jar Cantaloupe-5.0.6.jar`

`$ cp cantaloupe.properties.sample cantaloupe.properties`
Follow the Code Space prompts to view your working instance in browser.

And open the file `cantaloupe.properties` in your favorite text editor.
## Configuring Cantaloupe

If you're using `atom` and have installed the command line tools, you can type:
We won't explore all the ways you can configure Cantaloupe, but let's make a few changes so we can get a sense of what's possible.

`$ atom cantaloupe.properties`
### Adding Your Own Images
### Basic Auth
### Water Marks
### AWS S3 Connection

<!--
Now lets enable the admin panel where we will modify the rest of the settings.
Scroll to line 105, and change false to true. Also add a password/secret.
Expand All @@ -76,9 +98,9 @@ Scroll to line 297 and change `AutomaticSelectionStrategy` to `ManualSelectionSt
+ processor.selection_strategy = ManualSelectionStrategy
```
Save the file.
Save the file. -->

### Run Cantaloupe
<!-- ### Run Cantaloupe
Now, start Cantaloupe
Expand Down Expand Up @@ -122,4 +144,4 @@ Change the Path Prefix to `../images/`
### Updating Your Custom Image Viewer with your own Images.

-->
File renamed without changes.

0 comments on commit 1e961a9

Please sign in to comment.