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 |
|---|---|---|---|
| Inkscape | Vector images | 7 | 17 |
| 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 |
| LibreOffice | Documents | 41 | 22 |
| Dasel | Data Files | 5 | 4 |
| Pandoc | Documents | 43 | 65 |
| msgconvert | Outlook | 1 | 1 |
| dvisvgm | Vector images | 4 | 2 |
| ImageMagick | Images | 245 | 183 |
| GraphicsMagick | Images | 167 | 130 |
| Assimp | 3D Assets | 77 | 23 |
| FFmpeg | Video | ~472 | ~199 |
| Potrace | Raster to vector | 4 | 11 |
| VTracer | Raster to vector | 8 | 1 |
| Markitdown | Documents | 6 | 1 |
Deployment¶
I run ConvertX as part of the Utilities stack (with IT-Tools and BentoPDF); the compose there is the live one. Standalone, it looks like this:
Warning
If you can't log in, make sure you are accessing the service over localhost or HTTPS, otherwise set HTTP_ALLOWED=true.
services:
convertx:
image: ghcr.io/c4illin/convertx:v0.19.0
container_name: convertx
restart: unless-stopped
ports:
- "3002:3000"
environment:
- JWT_SECRET=${JWT_SECRET} # will use randomUUID() if unset (logins then reset on every recreate)
# - HTTP_ALLOWED=true # only if you access it over plain HTTP on a trusted LAN
volumes:
- /mnt/appdata/convertx/data:/app/data
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:3000/healthcheck"]
interval: 30s
timeout: 10s
retries: 3
start_period: 30s
Then visit http://<YOUR_SERVER_IP>:3002 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 the input file of ffmpeg, e.g. -hwaccel vaapi. See https://github.com/C4illin/ConvertX/issues/190 for more info about hw-acceleration. |
|
| FFMPEG_OUTPUT_ARGS | Arguments to pass to the output of 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 |
| MAX_CONVERT_PROCESS | 0 | Maximum number of concurrent conversion processes allowed. Set to 0 for unlimited. |
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. I pin a release tag (e.g. v0.19.0) and let Renovate propose updates; ConvertX is pre-1.0, so a minor bump can break things and gets reviewed first.
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 |