Configuration

Your Maze project has a {project_name}/config directory, this directory contains Maze configuration files.

Default Environments

Your Maze project ships with three default environments:

• Development

• Test

• Production

The files for each of the environment is found in {project_name}/config/environments.

Getting the current environment

To get the current maze environment just type Maze.env.to_s. You can also check against the current environment Maze.env== :production or Maze.env.development? Maze.env.test? Maze.env.production?

Setting the current environment

Maze sets the current environment based on the MAZE_ENV environment variable. The default environment is development.

Configuring Maze

All maze project have a directory called config/ in this directory you will find

Initializers

You can use initializers to hold configuration settings that should be made after all of the frameworks and shards are loaded, such as options to configure settings for these parts.

config/initializersplace any initializer file here to load at runtime.

Environments

config/environments all your environment YAML configuration files live here, these files get loaded based on the MAZE_ENV value. For example MAZE_ENV=staging then this will expect a config/environments/staging.yml file to exist.

Application.cr

config/application.cr this is the main entry file for maze application files and it allows you to overwrite setting based on dynamic values, it makes it possible to use environment variables as your settings.

Maze::Server.configure do |app|
  app.name = ENV["APP_NAME"] if ENV["APP_NAME"]?
  app.host = ENV["HOSTNAME"] if ENV["HOSTNAME"]?
  app.logger = ::Logger.new(STDOUT)
  app.logger.level = ::Logger::INFO
end

Where do custom settings go?

You can include new settings in any of the environment YAML files by specifying them in the secrets section.

database_url: postgress:://postgres:@localhost:5432/test_development
secrets: 
  custom: secret value here

Encrypted Environment Settings

With Maze you can encrypt your environment setting maze encrypt {envrionment}, this command will open your editor to allow make changes if needed and then encrypt the file {envrionment}.enc.

A .encryption_key file is provided. It contains a secret_key_base that is used to decrypt your encrypted environment settings. This file is added to .gitignore so it will not be committed to your repository. Without the encryption key, you won't be able to decrypt your environment settings.

Never commit the encryption key!

Setup your production machine and use the variable MAZE_ENCRYPTION_KEY

See more on encrypt section