SMTP Configuration

Configure the SMTP email settings for your Gigantics instance to enable email notifications and communications.

Configuration Properties

The SMTP configuration section in your config/default.yaml file controls how Gigantics sends emails:

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'

Property Details

host

• Type: String
• Default: 'smtp.ethereal.email'
• Description: The hostname of your SMTP server

port

• Type: Number
• Default: 587
• Description: The port number your SMTP server uses

username

• Type: String
• Default: 'montana.kulas@ethereal.email'
• Description: The username for authenticating with the SMTP server

password

• Type: String
• Default: '2q6GhNY5gc72msh7z4'
• Description: The password for authenticating with the SMTP server

baseUrl

• Type: String
• Default: 'http://localhost:5000'
• Description: Base URL used in email templates

subject

• Type: String
• Default: 'no reply'
• Description: Default subject line for emails

from

• Type: String
• Default: 'no-replay@gigantics.io'
• Description: The "from" address used for sending emails

Examples

Gmail SMTP Configuration

smtp:
  host: smtp.gmail.com
  port: 587
  username: 'your-email@gmail.com'
  password: 'your-app-password'
  baseUrl: 'http://localhost:5000'
  subject: 'Gigantics Notification'
  from: 'your-email@gmail.com'

Outlook SMTP Configuration

smtp:
  host: smtp-mail.outlook.com
  port: 587
  username: 'your-email@outlook.com'
  password: 'your-password'
  baseUrl: 'http://localhost:5000'
  subject: 'Gigantics Notification'
  from: 'your-email@outlook.com'

Custom SMTP Server

smtp:
  host: mail.yourcompany.com
  port: 465
  username: 'gigantics@yourcompany.com'
  password: 'secure_password'
  baseUrl: 'https://gigantics.yourcompany.com'
  subject: 'Gigantics Notification'
  from: 'gigantics@yourcompany.com'

Security Considerations

1. App Passwords: For Gmail and other providers, use app-specific passwords instead of your main account password
2. Encryption: Use TLS/SSL ports (587, 465) when available
3. Credentials: Never commit SMTP credentials to version control
4. Access: Restrict access to the configuration file containing SMTP credentials

Testing Email Configuration

You can test your SMTP configuration by:

1. Restarting the application after configuration changes:

   ./gig stop
   ./gig start

2. Triggering a test email through the application interface

3. Checking the logs for any SMTP connection errors

Common SMTP Providers

For production use, make sure to replace the default development credentials with your actual SMTP server credentials.