Previous: , Up: SGBlog  


Configuration

SGBlog is configured via Hjson configuration file. More or less self-describing blog configuration looks like that and contains many optional fields:

{
  GitPath: /home/sgblog/blog.git
  Branch: refs/heads/example
  Title: "Example blog"

  BaseURL: http://blog.example.com
  URLPrefix: /example

  AtomId: "urn:uuid:54e6e53f-c615-48f1-812c-6f6b094ebbdd"
  AtomAuthor: John Doe

  # URL to CSS file, optional
  CSS: /style.css
  # Email address of the webmaster, optional
  Webmaster: "webmaster@example.com"
  # URL to about page, optional
  AboutURL: /
  # Optional list of optional Git URLs for corresponding <link rel="vcs-git">
  GitURLs: [
    git://git.example.com/blog.git
    https://git.example.com/git/blog.git
  ]

  # If that ref is set, then comments will be loaded from it
  CommentsNotesRef: refs/notes/comments
  # Display link for comment writing, if email is set
  CommentsEmail: something@example.com

  # If that ref is set, then topics will be loaded from it
  TopicsNotesRef: refs/notes/topics
  # Optional file for topics state caching
  TopicsCachePath: /path/to/sgblog-topics-cache.gob

  # If set, then images are searched in XX/YY/ZZZ...ZZZ directory
  ImgPath: /path/to/directory/with/images
  ImgDomain: img.blog.example.com
}

Gopher configuration can use the same file, but it requires much less options:

{
  GitPath: /home/sgblog/blog.git
  Branch: refs/heads/example
  Title: "Example blog"

  GopherDomain: phlog.example.com

  AboutURL: http://blog.example.com/

  # Both are optional
  CommentsNotesRef: refs/notes/comments
  CommentsEmail: something@example.com

  # Both are optional too
  TopicsNotesRef: refs/notes/topics
  TopicsCachePath: /path/to/sgblog-topics-cache.gob
}