Skip to content

Latest commit

 

History

History
94 lines (73 loc) · 2.33 KB

DOCKER.md

File metadata and controls

94 lines (73 loc) · 2.33 KB
Raw

Codex

Codex is a web server comic book browser and reader.

Documentation, Source, and Issue Reports

Codex on GitHub

Usage

Here are some example snippets to help you get started creating a container from this image.

docker

docker create \
  --name=codex \
  -p 9810:9810 \
  -e PUID=501 \
  -e PGID=20 \
  -v /host/path/to/config:/config \
  -v /host/path/to/comics:/comics \
  --restart unless-stopped \
  docker.io/ajslater/codex

docker-compose.yaml

services:
  codex:
    image: docker.io/ajslater/codex
    container_name: codex
    env_file: .env
    volumes:
      - /host/path/to/config:/config
      - /host/path/to/comics:/comics:ro
    ports:
      - "9810:9810"
    restart: on-failure

Special volume setup for a CIFS share:

services:
  my-service:
    volumes:
      - nas-share:/container-path

volumes:
  nas-share:
    driver_opts:
      type: cifs
      o: "username=[username],password=[password]"
      device: //my-nas-network-name/share

Environment Variables Unique to Docker

  • PUID: Sets the UID for the default user on startup
  • PGID: Sets the GID for the default user on startup

General Codex Environment Variables

  • LOGLEVEL will change how verbose codex's logging is. Valid values are ERROR, WARNING, INFO, VERBOSE, DEBUG. The default is INFO.
  • TIMEZONE or TZ will explicitly the timezone in long format (e.g. "America/Los Angeles"). This is useful inside Docker because codex cannot automatically detect the host machine's timezone.
  • CODEX_CONFIG_DIR will set the path to codex config directory. Defaults to $CWD/config
  • CODEX_RESET_ADMIN=1 will reset the admin user and its password to defaults when codex starts.

More environment variables documented in the Codex README

Support Info

  • Shell access whilst the container is running:
    • docker exec -it codex /bin/sh
  • Monitor the logs of the container in realtime:
    • docker logs -f codex
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' codex
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ajslater/codex

Docker Image

This Document