rophako/config-sample.py

# Sample config file for Rophako.
#
# Edit this file and save the copy as "config.py".

import os
_basedir = os.path.abspath(os.path.dirname(__file__))
import datetime

DEBUG = True

# 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 default 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 HTML folder.
SITE_ROOT = os.path.join(_basedir, "site", "www")

# E-mail addresses for site notifications (i.e. new comments).
NOTIFY_ADDRESS = ["root@localhost"]

# 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!'

# Password strength: number of iterations for bcrypt to hash passwords.
BCRYPT_ITERATIONS = 12

# Where to save temp files for photo uploads, etc.
TEMPDIR = "/tmp"

# Rophako uses a flat file JSON database system, and the Redis caching server
# sits between Ropahko and the filesystem.
DB_ROOT      = "db"
REDIS_HOST   = "localhost"
REDIS_PORT   = 6379
REDIS_DB     = 0
REDIS_PREFIX = "rophako:"

# Mail settings
MAIL_METHOD = "smtp" # or "sendmail", not yet implemented
MAIL_SERVER = "localhost"
MAIL_PORT   = 25
MAIL_SENDER = "Rophako CMS <no-reply@rophako.kirsle.net>"

# 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 EMOTICON_ROOT_PRIVATE to look there instead.
EMOTICON_THEME = "tango"
EMOTICON_ROOT_PRIVATE = os.path.join(_basedir, "rophako", "www", "static", "smileys")

################################################################################
## Blog Settings                                                              ##
################################################################################

BLOG_ENTRIES_PER_PAGE = 5  # Number of entries to show per page
BLOG_ENTRIES_PER_RSS  = 5  # The same, but for the RSS feed
BLOG_DEFAULT_CATEGORY = "Uncategorized"
BLOG_DEFAULT_PRIVACY  = "public"
BLOG_TIME_FORMAT      = "%A, %B %d %Y @ %I:%M:%S %p" # "Weekday, Month dd yyyy @ hh:mm:ss AM"
BLOG_ALLOW_COMMENTS   = True

# RSS feed settings.
RSS_TITLE             = "Kirsle.net"
RSS_LINK              = "http://www.kirsle.net/"
RSS_LANGUAGE          = "en"
RSS_DESCRIPTION       = "The web blog of Kirsle"
RSS_COPYRIGHT         = "Copyright {}, Kirsle.net".format(str(datetime.datetime.now().strftime("%Y")))
RSS_WEBMASTER         = NOTIFY_ADDRESS[0]
RSS_IMAGE_TITLE       = RSS_TITLE
RSS_IMAGE_URL         = "http://www.kirsle.net/static/avatars/casey.png"
RSS_IMAGE_WIDTH       = 96
RSS_IMAGE_HEIGHT      = 96
RSS_IMAGE_DESCRIPTION = "Kirsle's Avatar"

################################################################################
## Photo Settings                                                             ##
################################################################################

# The path to where 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.
PHOTO_ROOT_PRIVATE = os.path.join(_basedir, "site", "www", "static", "photos")
PHOTO_ROOT_PUBLIC  = "/static/photos"

PHOTO_DEFAULT_ALBUM = "My Photos" # Default/fallback album name.
PHOTO_TIME_FORMAT   = BLOG_TIME_FORMAT

# Photo sizes.
PHOTO_WIDTH_LARGE  = 800  # Max width of full size photos.
PHOTO_WIDTH_THUMB  = 256  # Max square width of photo thumbnails.
PHOTO_WIDTH_AVATAR = 96   # Square width of photo avatars.

################################################################################
## Comment Settings                                                           ##
################################################################################

COMMENT_TIME_FORMAT = "%A, %B %d %Y @ %I:%M %p"

# 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.
COMMENT_DEFAULT_AVATAR = ""