n8n-nodes-codex

This is an n8n community node for Codex, a self-hosted digital library management system for comics, manga, and ebooks.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

Credentials

To use this node, you need to configure Codex API credentials:

1. In n8n, go to Credentials > New
2. Search for "Codex API"
3. Enter your Codex server URL (e.g., https://your-codex-server.com)
4. Choose your authentication method:
   • API Key: Use an API key generated from your Codex server
   • JWT Token: Use a JWT token for authentication

Resources

This node supports the following Codex resources:

| Resource | Operations | |----------|------------| | Admin | Server administration operations | | API Key | Create, Delete, Get, List, Update API keys | | Book | Analyze, Delete Progress, Get, List, Update Metadata, Update Progress | | Duplicate | Duplicate detection and management | | Filesystem | File and directory operations | | Genre | Genre management | | Library | Scan, Analyze, Get Books, Get Series, and 20+ more operations | | Metrics | Analytics and usage metrics | | Miscellaneous | Settings, Setup, Thumbnails, Progress, Scans | | Series | Series management operations | | Tag | Tag management | | Task | Background task operations | | User | User management | | User Preference | Preferences, Ratings, Integrations |

Compatibility

• Requires n8n version 1.0.0 or later
• Tested with Codex API v1

Usage

Example: List all books in a library

1. Add a Codex node to your workflow
2. Select your Codex credentials
3. Choose Library as the resource
4. Choose Get All Books as the operation
5. Enter the Library ID
6. Execute the workflow

Example: Track reading progress

1. Add a Codex node to your workflow
2. Select Book as the resource
3. Choose Update Progress as the operation
4. Enter the Book ID and progress data
5. Execute the workflow

Development

# Install dependencies
npm install

# Build the node
npm run build

# Run in development mode with hot reload
npm run dev

# Lint the code
npm run lint

# Fix linting issues
npm run lint:fix

Local Testing with Docker

A Docker Compose configuration is included for local development:

# Start Codex and n8n containers
npm run docker:up

# View logs
npm run docker:logs

# Stop containers
npm run docker:down

Resources

• n8n Community Nodes Documentation
• Codex Documentation

License

MIT