rophako/defaults.yml

# Default configuration settings for Rophako -- DO NOT EDIT THIS FILE!
#
# To configure your site, create a new file named "settings.yml" and override
# settings defined in this file. Your settings.yml is masked on top of the
# settings in defaults.yml.

rophako:
  ###
  # General Website Settings
  ###
  site:
    debug: false

    # Unique name of your site, e.g. "kirsle.net"
    site_name: example.com

    # Path to your site's HTML root. Whenever Rophako tries to render a
    # template, it will check in your site's root for the template first
    # before defaulting to the fallback pages in the rophako/www folder.
    # All of the core Rophako pages, e.g. for account, blog, photo albums
    # and so on, have templates in the default site. You can override those
    # templates by creating files with the same paths in your site's root.
    site_root: "{basedir}/site/www"

    # E-mail address for site notifications (e.g. new comments and errors)
    notify_address: &ADMIN_EMAIL root@localhost

    # Default date/time format (not used by the Rophako app but referenced
    # by other spots in this config file, for easy overriding).
    _date_format: &DATE_FORMAT '%A, %B %d %Y @ %I:%M:%S %p'

    # Preferred time zone to present datetimes in. See `pytz.all_timezones` for
    # valid options here. Examples: "US/Eastern", "America/Los_Angeles" etc.
    timezone: US/Pacific

    # Where to save temp files for photo uploads etc.
    tempdir: /tmp

  ###
  # Database settings
  ###
  db:
    # Rophako uses a flat file JSON database system, and a Redis server sits
    # between Rophako and the filesystem. The db_root is the path on the
    # filesystem to store documents in (can be relative, default "./db")
    db_root: db

    # Redis connection settings
    redis_host: localhost
    redis_port: 6379
    redis_db: 0
    redis_prefix: "rophako:"

  ###
  # Security Settings
  ###
  security:
    # Set this value to true to force SSL/TLS on your web app. Turning this on
    # will do the following:
    # - Send HTTP Strict-Transport-Security header
    # - Use secure session cookies (SSL-only)
    force_ssl: false

    # Secret key used for session cookie signing. Make this long and hard to
    # guess.
    #
    # Tips for creating a strong secret key:
    # $ python
    # >>> import os
    # >>> os.urandom(24)
    # '\xfd{H\xe5<\x95\xf9\xe3\x96.5\xd1\x01O<!\xd5\xa2\xa0\x9fR"\xa1\xa8'
    #
    # Then take that whole quoted string and paste it right in as the secret
    # key. Do NOT use that one, it was just an example. Make your own!
    secret_key: 'for the love of Arceus, change this key!'

    # How long the session key should last for (in days).
    session_lifetime: 30

    # Password strength: number of iterations for bcrypt password.
    bcrypt_iterations: 12

    # Proxy support. If you *KNOW* your web app will be behind a trusted proxy,
    # such as a load balancer, you can make the app accept the X-Forwarded-For
    # header to provide the user's real IP address. Do NOT set this if you are
    # not behind a proxy, otherwise a malicious user could "spoof" their address
    # by using this header.
    use_forwarded_for: false

  ###
  # Mail Settings
  ###
  mail:
    method: smtp  # or sendmail (not implemented yet)
    server: localhost
    port: 25
    sender: Rophako CMS <no-reply@rophako.kirsle.net>

  ###
  # Plugin Configurations
  ###
  emoticons:
    # Emoticon theme used for blog posts and comments. Should exist at the URL
    # "/static/smileys" from your document root, and have a file named
    # "emoticons.json" inside. If you add a custom theme to your private site
    # folder, then also change the root_private to look there instead.
    theme: tango
    root_private: "{basedir}/rophako/www/static/smileys"

  blog:
    default_category: Uncategorized
    default_privacy: public
    time_format: *DATE_FORMAT
    allow_comments: true
    entries_per_page: 5

    # RSS feed settings
    title: Rophako CMS Blog
    link: http://rophako.kirsle.net/
    language: en
    description: The web blog of the Rophako CMS.
    copyright: "Copyright {year}"
    webmaster: *ADMIN_EMAIL
    image_title: Rophako CMS Blog
    image_url: https://www.kirsle.net/static/avatars/default.png
    image_width: 100
    image_height: 100
    image_description: Rophako CMS
    entries_per_feed: 5

  photo:
    # The path to where the uploaded photos will be stored.
    # The PRIVATE path is from the perspective of the server file system.
    # The PUBLIC path is from the perspective of the web browser via HTTP.
    root_private: "{basedir}/site/www/static/photos"
    root_public: /static/photos
    default_album: My Photos
    time_format: *DATE_FORMAT

    # Max widths for photo sizes
    width_large: 800
    width_thumb: 256
    width_avatar: 96

  comment:
    time_format: *DATE_FORMAT

    # We use Gravatar for comments if the user provides an e-mail address.
    # Specify the URL to a fallback image to use in case they don't have
    # a gravatar.
    default_avatar: ""

    # The grace period window that users are allowed to modify or delete their
    # own comments (in hours)
    edit_period: 2

  wiki:
    default_page: Main Page
    time_format: *DATE_FORMAT

  ###
  # List of Enabled Plugins
  ###

  # Which plugins to enable? List each plugin by module name. The plugins
  # will be assumed to be blueprints that can be attached to the main app
  # object. If you instead want to load an arbitrary Python module (i.e. to
  # define custom routes at the app layer, not in a blueprint) list those
  # under the "custom" section.
  blueprints:
    - rophako.modules.blog
    - rophako.modules.wiki
    - rophako.modules.photo
    - rophako.modules.comment
    - rophako.modules.emoticons
    - rophako.modules.contact

  # If adding custom scripts, remove the empty array and define a list like
  # in the above blueprints example.
  custom: []