EasyDCIM Documentation
Back Home
Free Trial Request Get Started

System Configuration Fields: Quick Reference

Installation & Configuration

# System Configuration Fields: Quick Reference

EasyDCIM global settings are currently split into two groups in the admin area:

  • Basic tabs: Base Settings, Mail Configuration, Authentication, Email Summaries, Client Area, Appearance, and System Access.
  • Advanced tabs: Notifications, Orders & Services, Traffic Management, Power, and Other.

Some entries are simple fields, while others open a modal or a dedicated configuration view. A few sections are also dynamic and depend on the installed Client Area package, available SSO providers, or registered provisioning modules.

# Base Settings

# Company Name

  • Sets the company name displayed throughout EasyDCIM.

# Administrator Email

  • Defines the default sender address used by the system for notifications and other outgoing email messages.

# Site Base URL

  • Specifies the primary EasyDCIM URL, for example https://dcim.example.com.
  • This value should match the real application entry point and SSL configuration.

# Timezone

  • Selects the global timezone used in logs, summaries, and date/time presentation.

# Admin Area Language

  • Defines the default language used in the backend interface.

# Mail Configuration

# Mail Driver

  • Selects the delivery method for outgoing mail.
  • The current UI offers SMTP and Sendmail.

# SMTP Host Address

  • Hostname or IP address of the outgoing mail server.

# SMTP Host Port

  • Port used by the SMTP server.
  • Common values are 25, 465, and 587.

# SMTP Server Username

  • Username used to authenticate to the SMTP server.
  • In most installations this is an email address.

# SMTP Server Password

  • Password used for SMTP authentication.

# E-Mail Encryption Protocol

  • Controls the transport encryption used for SMTP.
  • Available options are No Encryption, SSL, and TLS.

# Disable Outbound Mail & Enable Logging

  • When enabled, EasyDCIM does not send outbound email but still logs mail activity.

# Disable Emails To Clients & Enable Logging

  • When enabled, customer-facing messages are blocked, while email logging remains active.

# Send Test Mail

  • A built-in action button is available on this page to verify the current mail configuration.

# Authentication

The current Authentication tab is divided into two provider groups:

  • Client Area Authentication Providers
  • Backend Authentication Providers

Each provider entry includes a Yes/No switch and a Configure button.

# Client Area Authentication Providers

# GitHub

  • Enables GitHub-based SSO for the Client Area.
  • Configuration is based on OAuth application credentials.

# Google

  • Enables Google-based SSO for the Client Area.
  • Configuration is based on OAuth application credentials.

# Client Area OAuth Provider

  • Enables a custom OAuth provider for the Client Area.
  • The configuration form includes Client ID, Client Secret, Authorization URL, Access Token URL, Resource URL, and optional Scopes.

# Backend Authentication Providers

# GitHub

  • Enables GitHub-based SSO for administrator logins.

# Google

  • Enables Google-based SSO for administrator logins.

# Backend OAuth Provider

  • Enables a custom OAuth provider for backend logins.
  • The configuration form includes Client ID, Client Secret, Authorization URL, Access Token URL, Resource URL, optional Scopes, and Login Button Text.

# Email Summaries

The summary page currently exposes three summary types:

# Daily Email Summary

  • Main switch to enable or disable the daily summary.
  • Includes Configure and Test actions.

# Weekly Email Summary

  • Main switch to enable or disable the weekly summary.
  • Includes Configure and Test actions.
  • The configuration view adds a Delivery Day selector for the weekday on which the summary is sent.

# Monthly Email Summary

  • Main switch to enable or disable the monthly summary.
  • Includes Configure and Test actions.
  • The configuration view adds a Delivery Day selector for the day of the month.

# Shared Summary Configuration

  • Each summary configuration screen allows you to choose which widgets are included in the email.
  • Each summary configuration screen also allows you to select which administrators receive the given summary.
  • A preview action is available for individual widgets.

# Client Area

# Client Area Mode

  • Controls how the Client Area is deployed.
  • Available modes are:
    • Local: the Client Area is installed together with EasyDCIM.
    • External: the Client Area is hosted on a separate server or URL.

# Client Area URL

  • Displayed when External mode is selected.
  • Defines the external base URL of the Client Area interface.

# Client Area Branding

  • Opens the Client Area branding editor.
  • Use it to manage branding elements such as logo, favicon, colors, and similar appearance options.

# Client Area Version

  • Read-only field showing the currently installed Client Area version, when available.

# Default Client Area Language

  • Defines the default language used in the Client Area interface.

# Disable Client Area

  • Disables access to the built-in Client Area for end users.

# Appearance

The Appearance tab now focuses on table defaults, email appearance, shortcuts, and backend styling.

# Table View

  • Sets the global default backend table density.
  • Available options are Default and Compact.

# Default Rows Per Page

  • Defines the default number of rows shown in backend tables.

# Allowed Page Sizes

  • Defines which page sizes are available in the backend table page-size switcher.
  • The field expects a comma-separated list of positive integers, for example 5, 10, 20, 50, 100, 200.

# Email CSS Style

  • Lets you customize the global CSS applied to system emails.
  • The page also includes actions to reset the CSS to its default value and to browse available email variables.
  • Lets you define the default footer appended to outgoing system emails.
  • The page also includes an action to restore the default footer.

# Floor Skipping

  • Controls whether EasyDCIM automatically skips the floor-selection step when a location contains only one floor.

# Custom Backend CSS

  • Adds custom CSS rules to the backend interface.
  • Enter raw CSS without <style> tags.

# System Access

# Allowed IP Addresses (Backend)

  • Defines which IPv4 or IPv6 addresses and CIDR ranges are allowed to access the backend panel.
  • By default, all addresses are allowed.
  • To reset the whitelist from the command line, use easydcim-control app shell -- php artisan settings:allowed-ips.

# Allowed IP Addresses (Admin API)

  • Defines which IPv4 or IPv6 addresses and CIDR ranges are allowed to access the Admin API.

# Advanced Firewall

  • Opens the ModSecurity configuration modal.
  • The current modal contains:
    • ModSecurity Enabled
    • Additional Allowed IP Addresses

# Support Team Access

  • This is currently controlled by an action button rather than a plain toggle.
  • Depending on the current state, the button allows you to enable or disable support-team SSH access.

# Test SSH Connection

  • Verifies the current local SSH connectivity used by EasyDCIM.

# SSH Access Notes

  • SSH keys can still be regenerated from the command line with easydcim-control app shell -- php artisan ssh:generate.

# Notifications

# Mail Notifications

  • Enables or disables email notifications generated by the system.

# Mail Notifications Recipients

  • Defines which administrator accounts receive notification emails.

# Automatically Remove Notifications Records Older Than

  • Controls the automatic cleanup interval for stored notification records.
  • Current options include Do not remove, 1 day, 1 week, 2 weeks, 1 month, 3 months, and 6 months.

# Orders & Services

# Accept Order Actions

  • Defines which order actions are accepted globally.
  • The current UI exposes Activate Service.

# Provisioning Module Sections

  • EasyDCIM renders one configuration block per registered provisioning module.
  • In a typical installation this includes modules such as Colocation and Server.

# Minimum Matching Percentage

  • Available per provisioning module.
  • Defines the minimum matching threshold required before an order can be activated.

# Require Exact Parts Specifications

  • Currently displayed for the Server provisioning module.
  • When enabled, server matching requires an exact component count and specification fit.

# Configure Actions

  • Each provisioning module exposes configuration links for:
    • Activate
    • Suspend
    • Unsuspend
    • Terminate

# Traffic Management

# Aggregate Traffic IN & OUT Swap

  • Swaps inbound and outbound traffic directions globally.
  • Useful when collection is wired in the opposite direction than expected.

# Aggregate Traffic Units

  • Controls the units used to display aggregate traffic.
  • Current options are Auto, Mbps, Gbps, Tbps, and Pbps.

# Aggregate Traffic Precision

  • Controls how many decimal places are shown in traffic charts and legends.
  • Current options are 1, 2, 3, and 4 decimal places.

# 95th Percentile Method

  • Selects how the traffic 95th percentile is calculated.
  • Current options are:
    • Max(IN, OUT)
    • Sum(IN + OUT)
    • OUT only
    • IN only

# Power

Global power settings currently act as the fallback level in the power inheritance chain.

# Power Units

  • Defines the unit used for power calculations.
  • Current options are Amps and kVA.

# Default Power Phase

  • Defines the default electrical phase.
  • Current options are 1 Phase and 3 Phase.

# Power Voltage (V)

  • Defines the default voltage used in power calculations.
  • This global value is used when no override exists on the PDU, rack, or location level.

# Other

# Debug Mode

  • Enables or disables backend debug mode.

# Quick Search Limit

  • Defines how many results are returned in quick search.

# Send an Activation Email After Account Creation

  • Controls whether the system sends an activation email to a newly created customer account.

# Default Port Types

  • Defines the default network port types used as filters for devices.

# Additional Inventory Statuses

  • Lets you define custom inventory statuses beyond the built-in defaults.

# Default Metadata Groups

  • Defines which metadata groups are shown by default in the device summary view.

# Maintenance Actions

  • The Other tab also includes action buttons for:
    • Clear Cache
    • Restart Queue