tiny-iiif - GitLite

KO | EN

gitlite — search

#javascript #go #golang #android #deep-learning #docker #nodejs #java #cli #kubernetes #vue #pytorch #openai #open-source

tiny-iiif

(★ 63)

Turn a folder of images into a working IIIF setup – in a minute or less!

파일 탐색기

최종 버전 다운로드 (.zip)

- cantaloupe.properties
- Dockerfile
- - .gitkeep
- - .gitkeep
- - .gitkeep
- development.md
- https-setup.md
- - default.conf
  - default.conf.https
- entrypoint.sh
- - types.ts
- astro.config.mjs
- components.json
- Dockerfile
- package-lock.json
- package.json
- tsconfig.json
.env.example
.gitignore
docker-compose.dev.yml
docker-compose.yml
LICENSE
README.md
screenshot.jpg

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/rsimon/tiny-iiif

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd tiny-iiif

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker compose -f docker-compose.dev.yml up -d --build

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

cd tiny

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tiny.iiif

Turn a folder of images into a working [IIIF](https://iiif.io/) setup – in a minute or less!

![Screenshot of the tiny.iiif admin GUI](https://raw.githubusercontent.com/rsimon/tiny-iiif/main/screenshot.jpg "Screenshot of the tiny.iiif admin GUI")

## Contents

- [Overview](#overview)
- [Who is tiny.iiif for?](#who-is-tinyiiif-for)
- [Features](#features)
- [Self-Hosting](#self-hosting) — on your own server
- [Hosted Service](#hosted-service-at-tiny-iiiforg) — no server required
- [Usage](#usage)
- [Development](#development)
- [License](#license)

## Overview

**tiny.iiif** is a lightweight IIIF server for small to medium-sized collections. It provides a simple way to publish images via the IIIF [Image](https://iiif.io/api/image/3.0/) and [Presentation](https://iiif.io/api/presentation/3.0/) APIs without deploying a full collection management system.

It fills the gap between large repository platforms and hand-editing IIIF manifest JSON files.

## Who is tiny.iiif for?

tiny.iiif is particularly useful for:

- Small collections (tens to a few thousand images)
- Online exhibitions
- Digital Humanities research projects
- DH classroom exercises
- Developers building IIIF-powered tools
- Institutions that need lightweight IIIF infrastructure without running a full repository stack

## Features

- **Drag & drop images** → instant IIIF Image Service powered by [IIPImage](https://iipimage.sourceforge.io/) or [Cantaloupe](https://cantaloupe-project.github.io/).
- **Create a folder, add images** → instant IIIF Presentation v3 manifest
- **Zero configuration** → works out of the box with sensible defaults
- **User-friendly admin interface** → simple, modern, easy to use
- **Production-ready** → Docker-based deployment with [NGINX](https://nginx.org/) as reverse proxy

## Self-Hosting

### Requirements

- Minimum server hardware: **1 CPU and 2 GB RAM** (2 CPUs / 4 GB for Cantaloupe)
- Sufficient disk space – tiny.iiif converts all uploaded images to [pyramidal TIFF format for performance reasons](https://cantaloupe-project.github.io/manual/5.0/images.html)
- Docker 24.0+ and Docker Compose 2.x
- A domain or subdomain pointing to your server

### Installation

1. **Clone this repository**

2. **Create an environment file** - copy the included `.env.example`

```sh
   cp .env.example .env
   ```

3. **Configure authentication**
   Edit `.env` to change your username and password for the admin GUI. (Default credentials are `tiny` / `tiny`.)

4. **Optional: Configure image server** - per default, tiny.iiif uses [IIPImage](https://iipimage.sourceforge.io/). You can choose to use [Cantaloupe](https://cantaloupe-project.github.io/) instead.
   
   - Set `COMPOSE_PROFILE=cantaloupe` in `.env`
   - Uncomment the Cantaloupe variable section: `IIIF_PROXY_DESTINATION` and `IIIF_IMAGE_PATH` 
   - Comment out the IIPImage section

5. **Start tiny.iiif**

```sh 
   docker compose up --build
   ```

6. **Access services locally**
   - Admin GUI: <http://localhost/tiny>
   - IIIF Image API: <http://localhost/iiif>
   - Manifests: <http://localhost/manifests>

7. **Configure HTTPS** – to set up HTTPS using [LetsEncrypt](https://letsencrypt.org/) follow the [HTTPS Setup Guide](guides/https-setup.md).

> [!IMPORTANT]
> You can **only choose between IIPImage or Cantaloupe during initial setup**. Once you have created manifests, switching is no longer supported because image-server-specific URLs are embedded in the manifests. To change servers later, you must delete and re-create all manifests.

## Hosted Service at tiny-iiif.org

For institutions and projects without in-house IT support or infrastructure to manage servers, managed hosting is available at:

```
https://[your-name].tiny-iiif.org
```

Hosted service includes:

- Deployment and server management
- Updates and maintenance
- Cloud hosting in a geographic region of your choice
- Technical support
- tiny-iiif.org sub-domain or optional custom domain
- Disk space starting from 50 GB

For pricing or to discuss project requirements, contact [hello@rainersimon.io](mailto:hello@rainersimon.io). Your subscription contributes directly to the continued maintenance and development of tiny.iiif as an open-source project.

## Usage

Once **tiny.iiif** is running:

1. Open the admin GUI at <http://[your-domain]/tiny>
2. Log in with your credentials (default: `tiny` / `tiny`)
3. Drag and drop images to publish them as IIIF image service
4. Create folders and add images to publish IIIF Presentation manifests

## Development

This repository includes a separate Docker setup for frontend development. See the [Developer Guide](guides/development.md) for details.

## License

[MIT](LICENSE)