Configuration Files

Gigantics uses YAML configuration files to control various aspects of the application. This section provides detailed information about configuring different components of the system.

Configuration File Location

The main configuration file is located at config/default.yaml in your Gigantics installation directory. This file contains all the configurable options for your instance.

Configuration Sections

The configuration file is organized into several sections:

Security Configuration: Encryption keys and session settings (most critical)
Server Configuration: Host, port, and base URL settings
Database Configuration: MongoDB connection parameters
Environment Configuration: Environment-specific settings
Logger Configuration: Log levels and output formats
Process Configuration: Daemon and worker settings
SMTP Configuration: Email server settings
Log Configuration: Log directory location

Example Configuration File

Here's a comprehensive example of a Gigantics configuration file:

# config/default.yaml
secretSessionKey: session secret
encryptionKey: my-secret-key
 
# Server settings
server:
  baseUrl: 'http://localhost:5000'
  host: localhost
  port: 5000
 
# MongoDB settings
mongodb:
  host: localhost
  port: 27017
  dbname: gigantics
  username: ''
  password: ''
 
# Process settings
process:
  daemon: false
  workers: 0
 
# Logger settings
logger:
  level: 'http'
  output: 'dev'
 
# SMTP settings
smtp:
  host: smtp.ethereal.email
  port: 587
  username: 'montana.kulas@ethereal.email'
  password: '2q6GhNY5gc72msh7z4'
  baseUrl: 'http://localhost:5000'
  subject: 'no reply'
  from: 'no-replay@gigantics.io'
 
# Log file location
logs: './logs/out.txt'

Operating System Specific Configuration

Gigantics can be configured differently based on the operating system it's running on:

Windows Configuration

Windows paths use backslashes and can specify drives:

logs: 'C:\ProgramData\Gigantics\logs\out.txt'

Linux Configuration

Linux paths use forward slashes and follow standard Unix conventions:

logs: '/var/log/gigantics/out.txt'

Applying Configuration Changes

After modifying the configuration file, you need to restart the Gigantics application for changes to take effect:

# Stop the application
./gig stop
 
# Start the application
./gig start

For more detailed information about specific configuration options, see the related sections in this documentation.

On this page