sample_config.yml

multiprocessed: true # whether to run the web application in a child process
base_path: /test # base path to prefix all routes with

# parameters passed into tornado.web.Application.__init__
port: 80 # port to host webpage on (80 is public http port, 443 is public https port, 5000 is common development port)
debug: false # similar to autoreload, whether to monitor for changes to source files
default_host: 0.0.0.0 # default host for incoming request's hosts
address: "" # the address on which the server is listening
autoreload: false # whether to monitor for changes to source files
websocket_max_message_size: 104857600 # the maximum data size of a websocket message, in bytes

wispy_static_path: wispyjs # the path at which to serve th wispyobserver/js folder

static: # parameters configuring static file handlers
  homepage: static/index.html # path to redirect to when the base_path is loaded
  folders: # str, list, or dict mapping routes to folders whose contents should be served
      static: ./static # results in the "./static" folder being served at the /base_path/static path

upload: # parameters used to configure upload handlers
  folders: # folders to allow uploading into
    uploads: ./uploads # results in the "./upload" folder accepting inputs at the /base_path/uploads path
  rules:
    accepted_filetypes: all # list of filetypes that are allowed to be uploaded to
    get_names_allowed: true # whether to return the filenames of the contents of the uploads folders
    file_creation_whitelist: # rules used to whitelist allowed upload paths when the file does not already exist
        - "*/server/uploads/*.png"
    file_overwrite_whitelist: # rules used to whitelist allowed upload paths when the file does already exist
      - "*/server/uploads/*.png"

logging_config: # configure python logging for debugging
  logger: web # name of the logger the web app should use
  level: DEBUG # level of logging to set the logger to
  stream: true # whether to stream logs to STDOUT

synchronous_task_lock: # configure a synchronous task lock object used to work on web requests concurrently
  max_workers: null # maximum number of concurrent workers allowed

func_caller: # configuration for a function caller created from the synchronous task lock object
  locking_default: false # whether functions should be locking by default (only one locking method can run at once)
  synchronous_default: true # whether functions should be synchronous by default or instead be executed in a thread pool
  max_start_delay_default: 3 # the maximum allowed time from when a web request is sent to when the worker starts executing
  check_return_annotation_default: true # whether to use the method annotations to decide whether to run function synchronously

interface: # configuration used create interfaces for python object being served by the RPC server
  include_internals: false # whether to provide access to methods and attributes starting with '_'
  include_dunders: false # whether to provide access to methods and attributes starting with '__'
  max_interface_depth: 4 # the max depth of object attributes which are served
  access_restricting_attributes: # names of attributes which can be added to methods and attributes to restrict access
    - "interface_access_restricted"
  source_access: true # whether python source code should be served to the front-end

add_attributes: true # whether to add attributes to the objects which are being served with the RPC server

instance_configs: {} # special configs to override defaults with for specific python instances