ConvertX

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
libheif	HEIF	2	4
XeLaTeX	LaTeX	1	1
Calibre	E-books	26	19
Pandoc	Documents	43	65
dvisvgm	Vector images	4	2
ImageMagick	Images	245	183
GraphicsMagick	Images	167	130
Inkscape	Vector images	7	17
Assimp	3D Assets	77	23
FFmpeg	Video	~472	~199
Potrace	Raster to vector	4	11

Any missing converter? Open an issue or pull request!

Deployment

Warning

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

# 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
      # - HTTP_ALLOWED=true # uncomment this if accessing it over a non-https connection
    volumes:
      - ./data:/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/"
FFMPEG_ARGS		Arguments to pass to ffmpeg, e.g. -preset veryfast
HIDE_HISTORY	false	Hide the history page
LANGUAGE	en	Language to format date strings in, specified as a BCP 47 language tag
UNAUTHENTICATED_USER_SHARING	false	Shares conversion history between all unauthenticated users

Docker images

There is a :latest tag that is updated with every release and a :main tag that is updated with every push to the main branch. :latest is recommended for normal use.

The image is available on GitHub Container Registry and Docker Hub.

Image	What it is
image: ghcr.io/c4illin/convertx	The latest release on ghcr
image: ghcr.io/c4illin/convertx:main	The latest commit on ghcr
image: c4illin/convertx	The latest release on docker hub
image: c4illin/convertx:main	The latest commit on docker hub

Tutorial

Note

These are written by other people, and may be outdated, incorrect or wrong.

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

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

Screenshots

Development

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

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

Use conventional commits for commit messages.

Todo

• Add options for converters
• Add tests
• Make errors logs visible from the web ui
• Add more converters:
  • deark
  • LibreOffice

Contributors

Star History