Skip to content

C4illin/ConvertX

Repository files navigation

ConvertX

ConvertX

Docker ghcr.io Pulls GitHub Release GitHub commits since latest release GitHub repo size Docker container size

A self-hosted online file converter. Supports over a thousand different formats. Written with TypeScript, Bun and Elysia.

Features

  • Convert files to different formats
  • Process multiple files at once
  • Password protection
  • Multiple accounts

Converters supported

Converter Use case Converts from Converts to
libjxl JPEG XL 11 11
resvg SVG 1 1
Vips Images 45 23
Assimp 3D Assets 70 24
XeLaTeX LaTeX 1 1
Pandoc Documents 43 65
GraphicsMagick Images 166 133
Inkscape Vector images 7 17
FFmpeg Video ~473 ~280

Any missing converter? Open an issue or pull request!

Deployment

# docker-compose.yml
services:
  convertx: 
    image: ghcr.io/c4illin/convertx
    container_name: convertx
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      - JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234 # will use randomUUID() if unset
    volumes:
      - convertx:/app/data

or

docker run -p 3000:3000 -v ./data:/app/data ghcr.io/c4illin/convertx

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.

If you get unable to open database file run chown -R $USER:$USER path on the path you choose.

Environment variables

All are optional, JWT_SECRET is recommended to be set.

Name Default Description
JWT_SECRET when unset it will use the value from randomUUID() A long and secret string used to sign the JSON Web Token
ACCOUNT_REGISTRATION false Allow users to register accounts
HTTP_ALLOWED false Allow HTTP connections, only set this to true locally
ALLOW_UNAUTHENTICATED false Allow unauthenticated users to use the service, only set this to true locally
AUTO_DELETE_EVERY_N_HOURS 24 Checks every n hours for files older then n hours and deletes them, set to 0 to disable
WEBROOT "" The address to the root path setting this to "/convert" will serve the website on "example.com/convert/"

Warning

If you can't login, make sure you are accessing the service over https or set HTTP_ALLOWED=true

Tutorial

Tutorial in french: https://belginux.com/installer-convertx-avec-docker/

Tutorial in chinese: https://xzllll.com/24092901/

Screenshots

ConvertX Preview

Development

  1. Install Bun and Git
  2. Clone the repository
  3. bun install
  4. bun run dev

Pull requests are welcome! See below and open issues for the list of todos.

Todo

  • Add messages for errors in converters
  • Add searchable list of formats
  • Add options for converters
  • Divide index.tsx into smaller components
  • Add tests
  • Make the upload button nicer and more easy to drop files on. Support copy paste as well if possible.
  • Make errors logs visible from the web ui
  • Add more converters:

Contributors

Image with all contributors

Star History

Star History Chart