# Codex

Codex is a web-based comic archive browser and reader for organizing, importing, and reading personal CBZ, CBR, CB7, CBT, and PDF comic libraries. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1162/codex

## Description

Codex is a web-based comic archive browser and reader for organizing, importing, and reading personal CBZ, CBR, CB7, CBT, and PDF comic libraries.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

62/100 (Good), based on 4 of 4 factors.
- Maintained: 100 (last commit 15 days ago)
- Popular: 50 (326 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 20 (16 GB minimum RAM, runs on ARM)

## Links

- Docker Hub: https://hub.docker.com/r/ajslater/codex
- GitHub: https://github.com/ajslater/codex
- Documentation: https://codex-comic-reader.readthedocs.io/DOCKER/#migrating-from-docker-hub
- Unraid: https://ca.unraid.net/apps/codex-09j4wrv1mmwhin?q=Codex

## Common questions

### Which Docker image should I use now?

Use the GHCR image. The Docker Hub image is deprecated and only republished to warn you to switch.

### Do I need a writable volume to edit comic metadata?

Yes, tag editing and online tagging write changes back to comic files, so the comics directory must be mounted writable with filesystem write permission.

### Does Codex support Remote-User SSO from a reverse proxy?

Yes, it supports the Remote-User HTTP header for reverse-proxy SSO with tinyauth, Authelia, or Authentik proxy mode.

### Can Codex serve OPDS catalogs?

It supports OPDS 1 and 2 with streaming, search, and authentication.

### Can I make the whole library anonymous or require accounts?

You can choose anonymous browsing or registration-required mode. Private libraries can also be restricted to specific user groups.

---
Source: Our Local Host (https://ourlocalhost.com/app/1162/codex), the self-hosted and open-source app directory.