ConvertX/README.md

ConvertX

A self-hosted online file converter. Supports 831 different formats. Written with Typescript, Bun and Elysia.

Features

• Convert files to different formats
• Password protection
• Multiple accounts

Converters supported

Converter	Use case	Converts from	Converts to
Vips	Images (fast)	45	23
Pandoc	Documents	43	65
GraphicsMagick	Images	166	133
FFmpeg	Video	~473	~280

Deployment

# docker-compose.yml
services:
  convertx: 
    image: ghcr.io/c4illin/convertx:main
    ports:
      - "3000:3000"
    environment: # Defaults are listed below
      - ACCOUNT_REGISTRATION=false # true or false
      - JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234
    volumes:
      - /path/you/want:/app/data

Then visit http://localhost:3000 in your browser and create your account. Don't leave it unconfigured and open, as anyone can register the first account.

Todo

• Add messages for errors in converters
• Add options for converters
• Add more converters
• Divide index.tsx into smaller components
• Add tests
• Add searchable list of formats