archive.social/docs/const.md

const

thread-keeper

Author: The Harvard Library Innovation Lab
License: MIT

• const
  • .CERTS_PATH
  • .DATA_PATH
  • .TMP_PATH
  • .TEMPLATES_PATH
  • .EXECUTABLES_FOLDER
  • .STATIC_PATH
  • .REQUIRE_ACCESS_KEY
  • .MAX_PARALLEL_CAPTURES_TOTAL
  • .MAX_PARALLEL_CAPTURES_PER_IP
  • .APP_VERSION

const.CERTS_PATH

Path to the folder holding the certificates used for signing the PDFs. Defaults to ./certs/ Can be replaced via the CERTS_PATH env variable.

Kind: static constant of const

const.DATA_PATH

Path to the "data" folder. Defaults to ./app/data/ Can be replaced via the DATA_PATH env variable.

Kind: static constant of const

const.TMP_PATH

Path to the folder in which temporary files will be written by the app.

Kind: static constant of const

const.TEMPLATES_PATH

Path to the "templates" folder. Defaults to ./app/templates/ Can be replaced via the TEMPLATES_PATH env variable.

Kind: static constant of const

const.EXECUTABLES_FOLDER

Path to the "executables" folder, for dependencies that are meant to be executed directly, such as yt-dlp.

Kind: static constant of const

const.STATIC_PATH

Path to the "static" folder.

Kind: static constant of const

const.REQUIRE_ACCESS_KEY

If true, users will be required to provide an access key. Defaults to false. Can be replaced via the REQUIRE_ACCESS_KEY env variable, if set to "1".

Kind: static constant of const

const.MAX_PARALLEL_CAPTURES_TOTAL

Maximum capture processes that can be run in parallel. Defaults to 50. Can be replaced via the MAX_PARALLEL_CAPTURES_TOTAL env variable.

Kind: static constant of const

const.MAX_PARALLEL_CAPTURES_PER_IP

Maximum capture processes that can be run in parallel for a given IP address. Defaults to:

• 2 if REQUIRE_ACCESS_KEY is false
• 10 if REQUIRE_ACCESS_KEY is true Can be replaced via the MAX_PARALLEL_CAPTURES_PER_IP env variable.

Kind: static constant of const

const.APP_VERSION

APP version. Pulled from package.json by default.

Kind: static constant of const