sample_appconfig.cfg

# --- CACHING SETTINGS ---

# The cache engine is where MementoEmbed stores web page responses
# Currently accepted values are 'Redis' and 'SQLite'
CACHEENGINE = "Redis"

# CACHEHOST only has meaning for Redis, specifying the hostname of the database server
# CACHEHOST = 'localhost'
CACHEHOST = "localhost"

# CACHEPORT only has meaning for Redis, specifying the port of the database server
CACHEPORT = "6379"

# CACHEDB only has meaning for Redis, specifying the Redis database to use
CACHEDB = "1"

# CACHE_EXPIRETIME indicates how often to expire entries in the cache
CACHE_EXPIRETIME = "604800"

# CACHE_FILENAME only has meaning if CACHEENGINE is set to SQLite,
# specifying the filename of the SQLite database to write the cache to,
# creating it if it does not exist
# Note: .sqlite will be added to the end of the filename by the caching library
# CACHE_FILENAME = "/tmp/mementoembed_cache"

# --- APPLICATION LOG FILE ---
# These settings apply to the log file for the application,
# writing status and debug information about its processes

# the file to write the application log
APPLICATION_LOGFILE = '/app/logs/mementoembed-application.log'

# the log level to use, specified as Python log levels
# values are: logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR
# for more information, see https://docs.python.org/3/library/logging.html
APPLICATION_LOGLEVEL = "INFO"

# --- ACCESS LOG FILE ---
# These settings apply to the log file documenting visitors to this MementoEmbed instance

# The file to write the access log
ACCESS_LOGFILE = "/app/logs/mementoembed-access.log"

# --- THUMBNAIL SERVICE ---
# These settings apply to the thumbnail service

# This value indicates whether or not thumbnail services will be availble
ENABLE_THUMBNAILS = "Yes"

# The path to the Puppeteer script for thumbnail generation, relative to the MementoEmbed root
THUMBNAIL_SCRIPT_PATH = "mementoembed/static/js/create_screenshot.js"

# The path to where thumbnails are written
THUMBNAIL_WORKING_FOLDER = "/app/thumbnails"

# The width of the viewport for thumbnails
THUMBNAIL_VIEWPORT_WIDTH = "1024"

# The height of the viewport for thumbnails
THUMBNAIL_VIEWPORT_HEIGHT = "768"

# Number of seconds to wait for the thumbnail script to finish
# before sending an error message back to the user
THUMBNAIL_TIMEOUT = "30"

# --- MEMENTO PROCESSING SETTINGS ---

# This value indicates how long, in seconds, the system should wait for a
# server to respond to an HTTP request
REQUEST_TIMEOUT = "15"

# --- SOCIAL CARD SETTINGS ---

# Should this service use data URIs for striking images
ALLOW_SOCIALCARD_DATAURIS_FOR_IMAGE = "No"

# Should this service use data URIs for favicons
ALLOW_SOCIALCARD_DATAURIS_FOR_FAVICONS = "No"