Skip to content

Commit

Permalink
Added smaller README (<25K) for cantaloupe so it can be used with Doc…
Browse files Browse the repository at this point in the history
…kerHub
  • Loading branch information
nigelgbanks committed Nov 22, 2021
1 parent 84e7770 commit 010b18c
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/dockerhub-description.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
username: ${{ secrets.REGISTRY_USER }}
password: ${{ secrets.REGISTRY_PASS }}
repository: ${{ secrets.REPOSITORY }}/cantaloupe
readme-filepath: ./cantaloupe/README.md
readme-filepath: ./cantaloupe/README.dockerhub.md

- name: Code-Server - Update Docker Hub Description
uses: peter-evans/dockerhub-description@v2
Expand Down
42 changes: 42 additions & 0 deletions cantaloupe/README.dockerhub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Cantaloupe

Docker image for [Cantaloupe] version 3.3.1.

Please refer to the [Cantaloupe Documentation] for more in-depth information.

As a quick example this will bring up an instance of [Cantaloupe], and allow you
to view on <http://localhost:80/cantaloupe/>.

```bash
docker run --rm -ti -p 80:80 islandora/cantaloupe
```

## Dependencies

Requires `islandora/tomcat` docker image to build. Please refer to the
[Tomcat Image README](../tomcat/README.md) for additional information including
additional settings, volumes, ports, etc.

## Volumes

| Path | Description |
| :---- | :------------------- |
| /data | [Cantaloupe Caching] |

## Settings

Please see the
[documentation](https://github.com/Islandora-Devops/isle-buildkit/tree/main/cantaloupe#settings)
in Github as the settings here exceed the file length supported by Docker Hub.

## Logs

| Path | Description |
| :------------------------------------------ | :---------------- |
| /opt/tomcat/logs/cantaloupe.access.log | [Cantaloupe Logs] |
| /opt/tomcat/logs/cantaloupe.application.log | [Cantaloupe Logs] |

[Cantaloupe Caching]: https://cantaloupe-project.github.io/manual/3.1/caching.html
[Cantaloupe Documentation]: https://cantaloupe-project.github.io/manual/3.1/getting-started.html
[Cantaloupe Logs]: https://cantaloupe-project.github.io/manual/3.1/logging.html
[Cantaloupe]: https://cantaloupe-project.github.io/

0 comments on commit 010b18c

Please sign in to comment.