config.example.yaml

web_server:
  # base_path is the base path of the web directory ("/histoire" = "http://example.com/histoire/example/path") (optional, defaults to "/". Can be "none" for just mount paths)
  #base_path: "/"
  # use_forwarded enables the ability to override various request states (like IP address) with the `X-Forwarded-`* headers (optional, defaults to false, KEEP IT ON false UNLESS YOU ARE ACTIVELY USING REVERSE PROXIES (e.g. Nginx/CloudFlare) TO ACCESS YOUR SITE. THIS HEADER CAN BE SPOOFED.)
  #use_forwarded: false
  # forwarded_for_depth allows you to specify how many values to trust for `X-Forwarded-`*. This is only used if `use_forwarded` is enabled. (optional, defaults to 1, increase as needed)
  #forwarded_for_depth: 1

file_server:
  # theme points to a folder with theme files, see README.md for information (optional, defaults to "default")
  #theme: "default"
  # show_dot_files says what it does on the tin (optional, default is false)
  #show_dot_files: false
  # use_interactive_breadcrumb allows you to disable the interactive breadcrumb if it's not to your taste (optional, defaults to true)
  #use_interactive_breadcrumb: true
  # enable_header_files lets you enable or disable reading files in each directory to give a header and footer (optional, defaults to true)
  #enable_header_files: true
  # enable_header_scripts lets you enable or disable using header scripts for headers and footers (requires enable_header_files to be enabled) (this should be disabled if you are not using it and/or running a file upload script that Histoire serves from)
  #enable_header_scripts: false
  # enable_dlbox lets you enable or disable a box below your file listing that lists commands for bulk-downloading (wget, aria2c, rclone, etc...)
  #enable_dlbox: true

  # enable_thumbnailer enables the ability for Histoire to generate thumbnails globally for images, videos, and the page itself for embeds (optional, default is false)
  #enable_thumbnailer: false
  # enable_page_thumbnail enables embed thumbnails for each folder index (optional, default is false, there is some setup required see README.md)
  #enable_page_thumbnail: false
  # page_thumbnail_backend allows you to set which backend is used for generating thumbnails of directory index pages (optional, default is wkhtmltoimage, available options are "wkhtmltoimage" via imgkit module and "qtwebengine5" via PySide2)
  #page_thumbnail_backend: "wkhtmltoimage"
  # enable_image_thumbnail enables image thumbnails (optional, default is false)
  #enable_image_thumbnail: false
  # enable_video_thumbnail enables video thumbnails (optional, default is false)
  #enable_video_thumbnail: false
  # thumbimage_cache_dir and wkhtmltoimage_cache_dir are cache directories for the page thumbnailing (optional, both point to cache/ in the location of configparse.py)
  #thumbimage_cache_dir: "/tmp/histoire/thumbimage"
  #wkhtmltoimage_cache_dir: "/tmp/histoire/wkhtmltoimage"

serve_paths:
  # This section allows for specific mounts to be used for different paths.
  # _ is used for the root mount. This will be `/`. If you used "public", your path would be `/public`. This works with the file_server.base_path variable.
  # You cannot nest or use multiple directories in each mount.
  "_":
    path: "/srv/http"
    type: "static"
  "public":
    path: "/mnt/files/opendir"
    type: "listing"