Portainer Templates logo

Portainer Templates

Codex Codex

Stack

Ebooks

Codex is a web server comic book browser and reader.

Image details

Pulls: 325k
Architecture: amd64, arm64
Image size: 246 MB
Latest: 1.10.11
User: ajslater
Created: Aug 23, 2020
Updated: 4 months ago
Status: active

Configuration

Type
Compose
Platform
linux
Image
docker.io/ajslater/codex
Ports
9810:9810
Volumes
/config : /portainer/Files/AppData/Config/codex/comics : /portainer/comics
Restart
on-failure
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Codex

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Codex, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  codex:
      image: docker.io/ajslater/codex
      container_name: codex
      volumes:
          - /portainer/Files/AppData/Config/codex:/config
          - /portainer/comics:/comics:ro
      ports:
          - 9810:9810
      restart: on-failure

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/codex.yml up -d

More install options in our documentation.

🐳 Codex Docker Image

Codex is a web server comic book browser and reader.
⚠️ Further updates to codex will be released on ghcr.io/ajslater/codex ⚠️

Links

Serve Codex on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying codex.example.com to http://codex:9810

Add this to your Caddyfile

codex.example.com {
	reverse_proxy http://codex:9810
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:9810 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :9810
  • Stop the other service, or pick a different host port. In 9810:9810 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:9810. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, codex can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 9810

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/codex (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull docker.io/ajslater/codex

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Codex is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Codex needs bundled into one download. This template pulls docker.io/ajslater/codex, which Docker fetches once (about 246 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Codex's comes from Docker Hub, published by ajslater.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 1.10.11. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 9810:9810 means it's reachable on port 9810 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 9810:9810

Volumes

A volume is where Codex keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /portainer/Files/AppData/Config/codex on the host
  • /comics from /portainer/comics on the host

Restart policy

The restart policy here is on-failure, so Codex only gets restarted when it exits with an error, not when it finishes cleanly or you stop it yourself. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Codex sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container codex. That's what you'll spot in the containers list and use in commands like docker logs codex.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Codex up. Add the template list to Portainer once, then deploying Codex is a click rather than a wall of config.