Setting up Luminos

Luminos depends on a configuration file: settings.yaml. It looks like this:

# Configuration file for Luminos. http://luminos.menteslibres.org
#
# You are viewing a YAML formatted file, read more about the
# format at http://www.yaml.org.
#
# Note: Use two space indentations instead of the \t
# character.
#

# SERVER CONFIGURATION
server:

  # The IPv4 or IPv6 address to bind to.
  bind: "127.0.0.1"

  # Port to use.
  port: 9000

  # Use "fastcgi" to start a FastCGI server or "standalone" to
  # start a HTTP server instead.
  type: "standalone"

# VIRTUAL HOSTS CONFIGURATION
hosts:

  # Default host: if a client makes a request for an unknown
  # hosts or without any host (by typing the ip directly).
  default: "./sites/default"

  # Uncomment the following line to route client requests for
  # "foo.example.org" to the "/path/to/foo.example.org/docs"
  # directory.
  # foo.example.org: "/path/to/foo.example.org/docs"

  # Uncomment the following line to route client requests for
  # "bar.example.org" to the "/path/to/bar.example.org/docs"
  # directory.
  # bar.example.org: "/path/to/bar.example.org/docs"

By default, Luminos listens on 127.0.0.1:9000. Request that do not match any configured virtual host are looked up into the ./sites/default directory.

# settings.yaml
hosts:
  default: "./sites/default"

To add another host, write its name and path under the host category of the settings.yaml file and point it to a directory.

# settings.yaml
hosts:
  bar.example.org: "/path/to/bar.example.org/docs"

Document directories must have a special structure in order for Luminos to recognize and serve your markdown files.

Using another settings file

By default, luminos run looks up into the current working directory for a settings.yaml file, you can specify another settings file directly from the command line.

luminos -c /etc/luminos/settings.yaml run

Site examples

If you would like to see full site examples you can browse the source code of this site at the github project page.

The gosexy.org site uses Luminos too and the source code is freely available in github.

Markdown editors