config.py.sample

   1 #coding: utf8
   2
   3 # This is the sample configuration file for a blitiri blog engine.
   4 # If you omit a variable, the default will be used.
   5 #
   6 # If you prefer, you can set the values directly inside blitiri.cgi and not
   7 # have a configuration file.
   8
   9
  10 # Directory where entries are stored
  11 data_path = "/tmp/blog/data"
  12
  13 # Are comments allowed? (if False, comments_path option is not used)
  14 enable_comments = False
  15
  16 # Directory where comments are stored (must be writeable by the web server)
  17 comments_path = "/tmp/blog/comments"
  18
  19 # Path where templates are stored. Use an empty string for the built-in
  20 # default templates. If they're not found, the built-in ones will be used.
  21 templates_path = "/tmp/blog/templates"
  22
  23 # Path where the cache is stored (must be writeable by the web server);
  24 # set to None to disable. When enabled, you must take care of cleaning it up
  25 # every once in a while.
  26 #cache_path = "/tmp/blog/cache"
  27 cache_path = None
  28
  29 # URL to the blog, including the name. Can be a full URL or just the path.
  30 blog_url = "/blog/blitiri.cgi"
  31
  32 # Style sheet (CSS) URL. Can be relative or absolute. To use the built-in
  33 # default, set it to blog_url + "/style".
  34 css_url = blog_url + "/style"
  35
  36 # Blog title
  37 title = "I don't like blogs"
  38
  39 # Default author
  40 author = "Hartmut Kegan"
  41
  42 # Article encoding
  43 encoding = "utf8"
  44
  45 # You can customize the captcha engine by providing a Captcha class with this
  46 # interface:
  47 # Constructor:
  48 #       Captcha(article) -> constructor, takes an article[1] as argument
  49 # Attributes:
  50 #       puzzle -> a string with the puzzle the user must solve to prove he is
  51 #                 not a bot (can be raw HTML)
  52 #       help -> a string with extra instructions, shown only when the user
  53 #               failed to solve the puzzle
  54 # Methods:
  55 #       validate(form_data) -> based on the form data[2],  returns True if
  56 #                              the user has solved the puzzle uccessfully
  57 #                              (False otherwise).
  58 #
  59 # Note you must ensure that the puzzle attribute and validate() method can
  60 # "communicate" because they are executed in different requests. You can pass a
  61 # cookie or just calculate the answer based on the article's data, for example.
  62 #
  63 # Example: a captcha class to completely disable the captcha feature
  64 # class Captcha (object):
  65 #       def __init__(self, article):
  66 #               self.puzzle = ''
  67 #               self.help = ''
  68 #       def validate(form_data):
  69 #               return True
  70 # Remove the captcha input field from the form template, and that's it!
  71 #
  72 # [1] article is an object with all the article's information:
  73 #       path -> string
  74 #       created -> datetime
  75 #       updated -> datetime
  76 #       uuid -> string (unique ID)
  77 #       title -> string
  78 #       author -> string
  79 #       tags -> list of strings
  80 #       raw_contents -> string in rst format
  81 #       comments -> list of Comment objects (not too relevant here)
  82 # [2] form_data is an object with the form fields (all strings):
  83 #       author, author_error
  84 #       link, link_error
  85 #       catpcha, captcha_error
  86 #       body, body_error
  87 #       action, method
  88