Skip to content

Commit 10d5662

Browse files
committed
update features section
1 parent 490e005 commit 10d5662

1 file changed

Lines changed: 40 additions & 23 deletions

File tree

README.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,46 @@ A final docker.io image has been released on dockerhub.
1818

1919
## ✨ Features
2020

21-
- Codex is a web server.
22-
- Full text search of comic metadata and bookmarks.
23-
- Filter and sort on all comic metadata and unread status per user.
24-
- Browse a tree of Publishers, Imprints, Series, Volumes, or your own folder
25-
hierarchy, or by tagged Story Arc.
26-
- Browse a multi-sortable table of comic metadata.
27-
- Mark Publishers, Series, Volumes, Folders, Story Arcs, and individual Issues
28-
as favorites and filter on them per user.
29-
- Read comics in a variety of aspect ratios and directions that fit your screen.
30-
- Watches the filesystem and automatically imports new or changed comics.
31-
- Anonymous browsing and reading or reigistered users only, to your preference.
32-
- Per user bookmarking & settings, even before you make an account.
33-
- Private Libraries accessible only to certain groups of users.
34-
- Optional Age Restrictions per user for Age tagged comics.
35-
- Reads CBZ, CBR, CBT, and PDF formatted comics.
36-
- Syndication with OPDS 1 & 2, streaming, search and authentication.
37-
- Save and load named views and searches.
38-
- Add custom covers to Folders, Publishers, Imprints, Series, and Story Arcs.
39-
- Fastest bulk comic importing by far of any comic server.
40-
- Fail2Ban log support.
41-
- Remote-User HTTP header SSO support.
42-
- Runs in 1GB of RAM, faster with more.
43-
- GPLv3 Licenced.
21+
### 📚 Library
22+
23+
- Reads **CBZ, CBR, CB7, CBT and PDF** comics.
24+
- **Fastest bulk importer** of any comic server.
25+
- **Watches the filesystem** and auto-imports new or changed comics.
26+
- **Custom covers** for Folders, Publishers, Imprints, Series, and Story Arcs.
27+
28+
### 🔎 Browse & Search
29+
30+
- Browse a tree of **Publishers, Imprints, Series, Volumes**, your **folder
31+
hierarchy**, or by tagged **Story Arc**.
32+
- **Full-text search** across comic metadata and bookmarks.
33+
- **Filter and sort** on any metadata field, including per-user unread status.
34+
- A **multi-sortable metadata table** view for power browsing.
35+
- **Save and load** named views and searches.
36+
- **Favorites** at the Publisher, Series, Volume, Folder, Story Arc, or Issue
37+
level — filterable per user.
38+
39+
### 📖 Read
40+
41+
- Adapts to any screen with multiple **aspect ratios and reading directions**.
42+
- **Per-user bookmarks and reading settings**, preserved even without an
43+
account.
44+
45+
### 👥 Users & Access
46+
47+
- **Anonymous browsing** or registration-required mode — your choice.
48+
- **Private libraries** restricted to specific groups of users.
49+
- Optional **age restrictions** for age-tagged comics.
50+
51+
### 🔌 Integrations
52+
53+
- **OPDS 1 & 2** syndication with streaming, search, and authentication.
54+
- **Remote-User HTTP header SSO** for reverse-proxy single sign-on.
55+
- **Fail2Ban** log for IP-banning failed login attempts.
56+
57+
### 🪶 Operations
58+
59+
- Runs in **1 GB of RAM** (faster with more).
60+
- **GPLv3** licensed.
4461

4562
### Examples
4663

0 commit comments

Comments
 (0)