Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 1.5 KB

README.md

File metadata and controls

50 lines (38 loc) · 1.5 KB
Raw

file-converter-gui

Self-hostable GUI interface for @nottimtam/file-converter.

See file-converter for general implementation instructions and API reference.

Installation

npm i @nottimtam/file-converter-gui

Spinup

npm start

Environment Variables

For the application to run properly, certain environment variables need to be defined.

Example

NODE_ENV=development
API_VERSION=1
PORT=3000
CLEAR_JOB_ON_DOWNLOAD=true
FILE_TEMP=./temp
FILE_SIZE_LIMIT=1000000000
DANGEROUSLY_FORCE_CLEAR_TEMP=false

Breakdown

  • NODE_ENV
    • "production" / "development"
  • API_VERSION
    • "1" (the only current API version)
  • PORT
    • The port you want the server to listen on.
  • CLEAR_JOB_ON_DOWNLOAD
    • "true" / "false"
  • FILE_TEMP
    • The directory to store files in during the conversion process.
  • FILE_SIZE_LIMIT
    • An optional maximum upload size in bytes.
  • DANGEROUSLY_FORCE_CLEAR_TEMP
    • "true" / "false" (serious consequences for parameter misuse, do not include parameter in .env unless absolutely necessary)