KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

issued

★ 75 Open GitHub ↗

A fast, self-hosted comic library server. Scan your comics, read in browser, or use any OPDS client.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Issued

**Your personal comic library server**

Host your digital comics (CBZ/CBR/CB7/PDF files) on your home server and read them on any device. Issued automatically organizes your collection and makes it available through mobile apps like Panels, Chunky, or a built-in web reader.

## What You Get

- 📚 **Keep your folder structure** – No need to reorganize your comics
- 🔄 **Automatic updates** – New comics are detected and added automatically
- 🖼️ **Thumbnail previews** – See cover images before opening
- 📱 **Read anywhere** – Use your favorite comic reader app (Panels, Chunky, etc.)
- 🌐 **Web reader** – Read in your browser without installing anything (on mobile too!)
- 🌙 **Light and dark themes** – Follow your system preference or switch manually
- 🔖 **Ongoing series** – Mark active series and quickly see new issues, totals, and possible gaps
- ⚡ **Easy setup** – One command to get started

## Supported Formats

Issued works with all common digital comic formats:

- **CBZ** (Comic Book ZIP) - ZIP archives containing images
- **CBR** (Comic Book RAR) - RAR archives containing images (requires `unrar`)
- **CB7** (Comic Book 7-Zip) - 7-Zip archives containing images
- **PDF** - PDF documents with comic pages

Issued detects the real container from the file contents. Misnamed archives, such
as a `.cbz` file that is actually compressed with 7-Zip, are handled automatically.

All formats support:
- ✅ Automatic page extraction and rendering
- ✅ Thumbnail generation from first page
- ✅ Metadata extraction (ComicInfo.xml or PDF metadata)
- ✅ Full compatibility with OPDS readers and web reader
- ✅ Reading progress tracking

## Collection view
<img width="2314" height="1998" alt="image" src="https://github.com/user-attachments/assets/3e69bb33-28e4-4bcd-ad35-b2b29a4b1ff4" />

## Web and Mobile reader
<img width="2108" height="1986" alt="image" src="https://github.com/user-attachments/assets/c2079181-d3ee-4a91-b5a1-264177f0ada3" />

## Edit metadata (uses ComicInfo.xml if available)
<img width="2120" height="1980" alt="image" src="https://github.com/user-attachments/assets/971ca199-080c-40be-be9c-9c7b232ce6b0" />

## Continue reading and Last Added
<img width="2216" height="1720" alt="image" src="https://github.com/user-attachments/assets/6b989866-fca2-44e0-85c4-06513065d1a7" />

## Before You Start

> **Docker users:** skip this section — the Docker image includes everything you need.

**For CBR files only** (skip if you only have CBZ or PDF):

Install `unrar` on your computer:
- **macOS**: `brew install rar`
- **Linux**: `sudo apt install rar`
- **Windows**: Download from [rarlab.com](https://www.rarlab.com/rar_add.htm)

> **Note:** CBZ, CB7, and PDF files work without any extra software. CBR files need `unrar` to extract.

## Installation

### Option 1: Docker (Recommended)

**Best for:** Running on a home server or NAS. Everything is pre-configured, including `unrar`.

**Step 1:** Create a `docker-compose.yml` file anywhere on your server:

```yaml
services:
  issued:
    image: ghcr.io/metalogico/issued:latest
    restart: unless-stopped
    ports:
      - "8181:8181"
    volumes:
      - ./data:/app/data
      - /path/to/your/comics:/comics:ro   # ← Change this path
```

Change `/path/to/your/comics` to your comics folder:
```yaml
- /home/user/Comics:/comics:ro     # Linux
- /Users/john/Comics:/comics:ro    # macOS
- C:/Comics:/comics:ro             # Windows
```

**Step 2:** Start the server
```bash
docker compose up -d
```

**Done!** Your comics are now available at:
- 📱 **Mobile apps**: `http://YOUR-SERVER-IP:8181/opds/`
- 🌐 **Web reader**: `http://YOUR-SERVER-IP:8181/reader/`

> Replace `YOUR-SERVER-IP` with your computer's IP address (e.g., `192.168.1.100`)

**Alternative: `docker run`**
```bash
docker run -d --name issued \
  --restart unless-stopped \
  -p 8181:8181 \
  -v /path/to/your/comics:/comics:ro \
  -v issued_data:/app/data \
  ghcr.io/metalogico/issued:latest
```

**Alternative: `docker create`** (create now, start later)
```bash
docker create \
  --name=issued \
  --user 1000:1000 \
  -p 8181:8181 \
  --mount type=bind,source=/path/to/your/comics,target=/comics,readonly \
  --mount type=bind,source=/path/to/data,target=/app/data \
  --restart unless-stopped \
  ghcr.io/metalogico/issued:latest
```
Then start it:
```bash
docker start issued
```

The image is also available on Docker Hub as `metalogico/issued`.

---

### Option 2: Standalone Executable

**Best for:** Quick setup on your personal computer.

> **Windows note:** Put the executable in a writable folder, such as your Desktop
> or another folder inside your user profile. Avoid `C:\Program Files` unless you
> run it with permissions to write there, because Issued stores `config.ini`,
> `library.db`, logs, and thumbnails beside the executable by default.

**Step 1:** Download for your system

Get the latest release from [GitHub Releases](https://github.com/metalogico/issued/releases):
- **macOS**: `issued-macos`
- **Linux**: `issued-linux`  
- **Windows**: `issued.exe`

**Step 2:** Make it executable (macOS/Linux only)

```bash
chmod +x issued

# macOS only: If blocked by security
xattr -d com.apple.quarantine issued
```

**Step 3:** Initialize your library

```bash
# Replace with your actual comics folder path
./issued init --library /path/to/your/comics
```

Examples:
```bash
./issued init --library ~/Comics              # macOS/Linux
./issued init --library C:\Users\You\Comics   # Windows
```

**Step 4:** Scan your comics

```bash
./issued scan
```

This will:
- Find all CBZ/CBR/CB7/PDF files
- Create thumbnails
- Build the library database

**Step 5:** Start the server

```bash
./issued serve
```

**Done!** Your comics are now available at:
- 📱 **Mobile apps**: `http://YOUR-COMPUTER-IP:8181/opds/`
- 🌐 **Web reader**: `http://YOUR-COMPUTER-IP:8181/reader/`

> **Tip:** Keep the terminal window open while the server runs. New comics will be detected automatically.

---

## Using Your Comic Library

### On Mobile Apps

**Popular apps that work with Issued:**
- **Panels** (iOS) - Best overall experience
- **Chunky Reader** (iOS) - Great for iPad
- **KyBook** (iOS) - Feature-rich
- **Moon+ Reader** (Android) - Highly customizable
- And many oders with opds support (please let me know what you use and I'll add it here)

**How to connect:**

1. Open your comic reader app
2. Add a new OPDS catalog
3. Enter: `http://YOUR-IP:8181/opds/`
4. Browse and download comics!

> **Finding your IP:** 
> - macOS/Linux: Run `ifconfig` or `ip addr`
> - Windows: Run `ipconfig`
> - Look for something like `192.168.1.100`

### In Your Browser

Just open: `http://localhost:8181/reader/`

From the web reader you can browse folders, search your library, read comics, edit comic details, and keep track of what you are reading.

- Use **Recent** to see the comics you added most recently.
- Use **Continue Reading** to jump back into comics you have started but not finished.
- Mark comics as done from the grid or table view.
- When you are inside a series folder, use **Mark all as completed** if you want to mark the whole series as done.

### Ongoing series

If you follow series that are still coming out, Issued can keep them together for you.

1. Open the series folder in the web reader.
2. Click the **Ongoing** button.
3. Use **Ongoing** in the top menu to see all the series you are tracking.

The Ongoing page shows the latest added issue, how many issues are in the series, and possible missing issue numbers. The button appears on series folders that contain comics directly.

**Optional:** Add password protection by editing `config.ini`:
```ini
[reader]
user = yourname
password = yourpassword
```

## Common Tasks

### Add new comics

Just copy them to your comics folder! If the server is running, they'll be detected automatically.

You can also start a scan from the web reader: click the refresh icon in the top menu. Issued will scan your library, show how many comics were added, updated, or deleted, and then refresh the page.

Or manually scan from the command line:
```bash
./issued scan
```

### Rescan everything

```bash
./issued scan --force
```

### Check library stats

```bash
./issued stats
```

### Regenerate all thumbnails

```bash
./issued thumbnails --regenerate
```

### Change settings

Edit `config.ini` in the app data folder. For standalone executables this is the
same folder as the executable unless you set `DATA_DIR`; for Docker it is
`/app/data` inside the container, usually backed by your mounted volume.
- Change port: `[server]` → `port = 8080`
- Add password: `[reader]` → `user = name`, `password = pass`
- Adjust thumbnails: `[thumbnails]` → `width`, `height`, `quality`

## Advanced Configuration

Edit `config.ini` for more options:

```ini
[library]
path = /path/to/comics    # Your comics folder
name = My Comics          # Library name shown in apps

[server]
host = 0.0.0.0           # Listen on all network interfaces
port = 8181              # Change if port is already in use

[thumbnails]
width = 300              # Thumbnail width in pixels
height = 450             # Thumbnail height in pixels
quality = 85             # JPEG quality (1-100)
format = jpeg            # jpeg or webp

[monitoring]
enabled = true           # Auto-detect new comics
debounce_seconds = 2     # Wait time before processing changes

[reader]
user =                   # Leave empty for no password
password =               # Leave empty for no password
```

### Reverse proxy

Issued keeps its two public route prefixes when served through a reverse proxy:

- Web reader: `https://issued.example.com/reader/`
- OPDS catalog: `https://issued.example.com/opds/`

Do not strip or rewrite `/reader` or `/opds`. For example, with nginx:

```nginx
server {
    listen 443 ssl;
    server_name issued.example.com;

location / {
        proxy_pass http://issued:8181;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}
```

Reader assets and images use origin-relative URLs, so they work with either an
IP address or a domain. OPDS clients require absolute URLs; forwarding `Host`
and `X-Forwarded-Proto` ensures those URLs contain the public domain and
protocol.

When nginx, Caddy, Traefik, or another proxy runs in a separate container, add
`FORWARDED_ALLOW_IPS=*` to the Issued container environment, or replace `*`
with the proxy network/IP range. This lets Uvicorn trust the forwarded protocol.

## Troubleshooting

### Comics not showing up

1. **Check the scan worked:**
   ```bash
   ./issued stats
   ```
   Should show your comic count.

2. **Try a forced rescan:**
   ```bash
   ./issued scan --force
   ```

### Can't connect from mobile app

1. **Use your computer's IP address**, not `localhost`
   - Find it: `ifconfig` (Mac/Linux) or `ipconfig` (Windows)
   - Example: `http://192.168.1.100:8181/opds/`

2. **Check firewall:**
   - Make sure port 8181 is allowed
   - macOS: System Settings → Network → Firewall
   - Windows: Windows Defender Firewall → Allow an app

3. **Make sure both devices are on the same network**
   - Computer and phone/tablet must be on the same WiFi

### CBR files won't open

**Install unrar:**
- macOS: `brew install unrar`
- Linux: `sudo apt install unrar`
- Windows: Download from [rarlab.com](https://www.rarlab.com/rar_add.htm)

Then restart the server.

### macOS says "cannot be opened"

```bash
xattr -d com.apple.quarantine issued
```

### Port 8181 already in use

Edit `config.ini` and change the port:
```ini
[server]
port = 8080
```

Then use `http://YOUR-IP:8080/opds/` instead.

### Server stops when I close the terminal

**Docker:** It runs in the background automatically.

**Executable:** Run in the background:
```bash
# macOS/Linux
nohup ./issued serve &

# Or use screen/tmux
screen -S issued
./issued serve
# Press Ctrl+A then D to detach
```

## Why is it Violet / Purple?
This project uses the violet accent color just because my baby daughter is called Violet <3

---

## Getting Help

If you're stuck:
1. Check the [Issues](https://github.com/metalogico/issued/issues) page
2. Open a new issue with:
   - Your OS (macOS/Linux/Windows)
   - How you installed (Docker/executable)
   - What you tried
   - Error messages (if any)

---

## License

MIT. See [LICENSE](LICENSE) for details.

issued

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README