Quick Start Guide

Once you have ConvertX running (see Installation), follow these steps to process your first file.

1. Initial Setup

If you deployed with ACCOUNT_REGISTRATION=true (default), you need to create an account.

  1. Navigate to the web interface (e.g., http://localhost:3000).
  2. Click Register in the navigation bar.
  3. Enter an email and password.
  4. Click Register. You will be logged in automatically.

Note: If ALLOW_UNAUTHENTICATED=true is set, you can skip registration and start converting immediately.

2. Converting a File

  1. Upload: On the homepage, drag and drop a file into the upload zone, or click the area to select a file from your computer.
  2. Select Format:
    • Once uploaded, the file appears in the list.
    • Click inside the "Search for conversions" bar or click one of the suggested target formats (e.g., png, pdf) that appear in the dropdown.
  3. Convert: Click the Convert button.
  4. Download:
    • You will be redirected to the Results page.
    • Wait for the progress bar to complete.
    • Click the Download icon next to your file, or use the Tar button to download all files as an archive.

3. Managing History

Click History in the top navigation bar to view past jobs. You can re-download files (if they haven't been auto-deleted) or remove job records.