Installation

ConvertX is designed to be run primarily via Docker due to the large number of system dependencies (converters) required to function.

Prerequisites

• Docker
• Docker Compose

Docker Compose Deployment

The easiest way to deploy ConvertX is using docker-compose.

1. Create a directory for your project.
2. Create a file named compose.yaml (or docker-compose.yml) with the following content:

services:
  convertx:
    image: ghcr.io/c4illin/convertx:latest
    container_name: convertx
    restart: unless-stopped
    volumes:
      - ./data:/app/data
    environment:
      - JWT_SECRET=ChangeThisToARandomString
      - ALLOW_UNAUTHENTICATED=false
      - ACCOUNT_REGISTRATION=true
      - AUTO_DELETE_EVERY_N_HOURS=24
      - TZ=Europe/Stockholm
    ports:
      - 3000:3000

1. Start the service:

docker compose up -d

1. Access the interface: Open your browser and navigate to http://localhost:3000.

Docker Tags

• ghcr.io/c4illin/convertx:latest: The stable release version (Recommended).
• ghcr.io/c4illin/convertx:main: The bleeding-edge version built from the latest commit.

Permissions

ConvertX stores its database and processed files in the /app/data directory inside the container. If you encounter permission errors regarding the database file (mydb.sqlite), you may need to adjust ownership of your local data directory:

chown -R $USER:$USER ./data