jmn319/convertx repository overview

⁠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

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: # Defaults are listed below. All are optional.
      - ACCOUNT_REGISTRATION=false # true or false, doesn't matter for the first account (e.g. keep this to false if you only want one account)
      - JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234 # will use randomUUID() by default
      - HTTP_ALLOWED=false # setting this to true is unsafe, only set this to true locally
      - ALLOW_UNAUTHENTICATED=false # allows anyone to use the service without logging in, only set this to true locally
    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.

⁠Tutorial

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

⁠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:
  • deark⁠
  • LibreOffice
  • dvisvgm⁠

⁠Contributors

⁠

⁠Star History

⁠