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 |
| VCF to CSV | Contacts | 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 |
| pdftops | Documents | 1 | 2 |
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:
- PUID=1000 # user id for file permissions (should match your host user id)
- JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234 # will use randomUUID() if unset
# - HTTP_ALLOWED=true # uncomment this if accessing it over a non-https connection
volumes:
- ./data:/app/dataor
docker run -p 3000:3000 -e PUID=1000 -e PGID=1000 -v ./data:/app/data ghcr.io/c4illin/convertxEnsure PUID and PGID match your host user (id -u and id -g) to avoid permission issues on the mapped ./data volume. If you get unable to open database file, verify the directory permissions or run chown -R $USER:$USER path on the path you choose.
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.
Environment variables
All are optional, JWT_SECRET is recommended to be set.
Warning
Never expose the service to the internet with ALLOW_UNAUTHENTICATED or ACCOUNT_REGISTRATION true. Only allow users you trust to access the service.
| 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 |
| PUID | 0 (root) | User ID to run the application process as (it first uses root to chown the files) |
| PGID | PUID if unset, root if both unset | Group ID to run the application process as |
| UMASK | 002 (when PUID is set) | File creation mask for processes and created files |
| 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/" | |
| BRANDING | ConvertX | Custom string that allows you to change the display name of the website in the header (max 26 characters) |
| FFMPEG_ARGS | Arguments to pass to the input file of ffmpeg, e.g. -hwaccel vaapi. See #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. |
| PORT | 3000 | Application listen port |
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/
Tutorial in polish: https://www.kreatywnyprogramista.pl/convertx-lokalny-konwerter-plikow
Screenshots
Development
- Install Bun and Git
- Clone the repository
bun installbun run dev
Pull requests are welcome! See open issues for the list of todos. The ones tagged with "converter request" are quite easy. Help with docs and cleaning up in issues are also very welcome!
Use conventional commits for commit messages.
