Home assistant add-on: Codex

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

About

Codex is a web based comic archive browser and reader This addon is based on the official docker image : https://hub.docker.com/r/ajslater/codex

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
Install this add-on.
Click the Save button to store your configuration.
Set the add-on options to your preferences
Start the add-on.
Check the logs of the add-on to see if everything went well.
Open the webUI and adapt the software options

Configuration

Webui can be found at http://homeassistant:PORT. The default username/password : described in the startup log. Configurations can be done through the app webUI, except for the following options

Add theme/squeleton

You can place the user folder from the theme/skeleton in /share/codex/www/user,

Options

Option	Description	Default	Example
`PGID`	Group ID for file permissions	`0`	`1000`
`PUID`	User ID for file permissions	`0`	`1000`
`TZ`	Timezone in long format	-	`America/Los_Angeles`
`CODEX_RESET_ADMIN`	Reset admin user and password to defaults	-	`1`
`CODEX_SKIP_INTEGRITY_CHECK`	Skip database integrity repair on startup	-	`1`
`csrf_allowed`	Comma separated list of addresses allowed to access the app	`http://homeassistant.local:8123,https://homeassistant.local:8123`	`http://localhost:8123`
`localdisks`	Hardware name of drives to mount (comma separated)	-	`sda1,sdb1,MYNAS`
`networkdisks`	SMB servers to mount (comma separated)	-	`//SERVER/SHARE`
`cifsusername`	SMB username for all shares	-	`username`
`cifspassword`	SMB password	-	`password`
`cifsdomain`	SMB domain	-	`WORKGROUP`

PGID: 1000
PUID: 1000
TZ: "America/Los_Angeles"
CODEX_RESET_ADMIN: 1
CODEX_SKIP_INTEGRITY_CHECK: 1
csrf_allowed: "http://homeassistant.local:8123,https://homeassistant.local:8123"
localdisks: "sda1,sdb1"
networkdisks: "//SERVER/SHARE"
cifsusername: "username"
cifspassword: "password"
cifsdomain: "WORKGROUP"

Custom Scripts and Environment Variables

This addon supports custom scripts and environment variables through the addon_config mapping:

Custom scripts: See Running Custom Scripts in Addons
env_vars option: Use the add-on env_vars option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.

Mounting Drives

This addon supports mounting both local drives and remote SMB shares:

Local drives: See Mounting Local Drives in Addons
Remote shares: See Mounting Remote Shares in Addons

Illustration

Support

Create an issue on github

5.9 KiB Raw Blame History