Skip to content

Latest commit

 

History

History
69 lines (65 loc) · 2.82 KB

options.json.md

File metadata and controls

69 lines (65 loc) · 2.82 KB
Raw

options.json

Here are all the options you can set in data/options.json

{
    "archive_domain": "ifarchive.org",
    "cache": {
        "max_buffer": 20000000,
        "max_entries": 1000,
        "max_size": 1000000000
    },
    "cache-control-age": 604800,
    "cache-control-age-error": 0,
    "certbot": {
        "email": "[email protected]",
        "renew_time": 720,
        "test": true,
    },
    "domain": "localhost",
    "https": false,
    "index": {
        "index_url": "https://ifarchive.org/indexes/Master-Index.xml",
        "recheck_key": "secretkey",
        "recheck_period": 5
    },
    "nginx": {
        "cache" :{
            "keys_size": 50,
            "max_size": 1000,
            "support_bypass": false
        },
        "reload_time": 360
    },
    "open_file_of_same_type": true,
    "serve_proxy_pac": false,
    "subdomains": true
}
  • archive_domain: (str) domain of the IF Archive to use for downloading files
  • cache: options for the app's cache
    • max_buffer: (int bytes) buffer size to use when extracting to RAM
    • max_entries: (int) number of zip files to cache
    • max_size: (int bytes) amount of disk to use for the cache
  • cache-control-age: (int seconds) time to set for the Cache-Control header
  • cache-control-age-error: (int seconds) time to set for the Cache-Control header for error pages
  • certbot: options for certbot
    • email: (str) email address for certbot notifications (required for HTTPS)
    • rewew_time: (int minutes) period to rewew certificate
    • test: (bool) obtain a test certificate from the Let's Encrypt staging server
  • domain: (str) the main domain of the app
  • https: (bool) whether to enable HTTPS
  • index: options for the IF Archive index processor
    • index_url: (str) URL to Master-Index.xml
    • recheck_key: (str) a secret key used when forcing the index to be rechecked
    • recheck_period: (int minutes) period to check if Master-Index.xml has changed
  • nginx: nginx options
    • cache: nginx cache options
      • keys_size: (int MB) amount of RAM to use for cache keys
      • max_size: (int MB) amount of disk to use for the cache
      • support_bypass: (bool) whether to support bypassing the cache through the "Pragma: no-cache" HTTP header
    • reload_time: (int minutes) period to reload nginx (to check for certificate changes)
  • open_file_of_same_type: (bool) when opening a specific file, with the open query parameter, if no direct match is found, to redirect to another file as long as there is only one that matches the file extension
  • serve_proxy_pac: (bool) whether to serve a proxy.pac file
  • subdomains: (bool) whether to use wildcard subdomains for unsafe files

Note that the archive_domain config option is not fully supported. It is used for fetching zip files, but the Unbox page templates and other features are hardcoded to the ifarchive.org domain.