Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
etc
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

GoBlog

A blogging platform written by a coder, for coders.

If you want to see how it looks, go to my home page: macias.info

Building

make compile

or

go build -o goblog ./src

Running

./goblog -cfg ./sample/config.yml

or

./goblog -cfg /path/to/goblog.yml

Configuring

Default configuration can be overridden by a YAML file config and/or Environment variables.

The YAML file config path must be passed by the -cfg command-line argument or the GOBLOG_CONFIG environment variable.

Environment variables take precedence over YAML configuration.

  • env: GOBLOG_ROOT, yaml: rootPath
    • The root folder of the blog contens (see Blog Structure)
    • Default: ./sample
  • env: GOBLOG_HTTPS_PORT, yaml: httpsPort
    • Port to serve the secure HTTPS content.
    • Default: 8443
  • env: GOBLOG_HTTP_PORT, yaml: httpPort
    • Port to listen for any HTTP request and redirect it to its HTTPS-equivalent URL
    • Default: 8080
  • env: GOBLOG_DOMAIN, yaml: domain
    • Domain/hostname/IP where the blog is going to be visible from
    • Default: localhost
  • env: GOBLOG_TLS_CERT, yaml: tlsCertPath
  • env: GOBLOG_TLS_KEY, yaml: tlsKeyPath
    • Paths of the TLS certificate and key for HTTPS serving
    • Default: empty

Blog Structure

The sample folder contains a simplified example of the Root contents for a blog. You can override the GOBLOG_ROOT environment variable to point the root to another folder.

The Root contents folders is structured as follows:

  • entries subfolder contains MarkDown entries for each entry of the blog.

    • Entries whose file name starts with a timestamp YYYYMMDDHHMMname.md will be automatically added to the index.

    • Entries whose file name starts with other pattern will be treated as pages, and will need to link them manually in the template or another entry.

  • static subfolder contains static assets (CSS, images, Javascript files...)

  • template contains the HTML templates in the Golang templating format.

    • The template MUST contain at least two files: index.html for the main index page, and entry.html for the blog entry page.

How to create your blog

Put static assets in static/ folder. They will be accessible through the /static/ URL path.

Put blog entries in entries/ folder as MarkDown documents. They will be accessible through the /entry/ URL path (without extension).

Edit blog template files under the template/ folder.

How to add an entry to your blog

Just add a file in the entries/ folder in a timestamped format. E.g. 201711281330_hello.md will create an entry created at November 28th, 2017 at 13:30.

The markdown file MUST contain a First-level header (e.g. # Post title), that will be used as title of the entry in the entry heading and links.

At this early stage of the blog, you MUST restart the blog process before changes are visible.

Environment variables

  • GOBLOG_DOMAIN (default: value returned by os.Hostname())

    • The domain of your blog (for Atom XML feeds)
  • GOBLOG_PORT (default: 8080)

    • The port where the HTTP service listens
  • GOBLOG_ROOT (default: ../sample)

    • The root folder of the blog contents

About

Simplest blog engine for coders

Resources

License

Stars

Watchers

Forks

Packages

No packages published