Table of Contents

Basic Setup

Basic Setup can be found under [Settings] > [System] > [General] > [Basic Setup].

OptionDescription
Root Web Directory

This value represents the full server path to the web server's document root directory (e.g. /home/user/public_html/). This is not necessarily the path to the directory Blesta is installed under.

This setting is used when the web server cannot provide the path to your Blesta installation, such as when the cron is run via CLI. This typically occurs for URLs constructed for emails that are sent by cron via CLI.

The path to the document root directory may vary depending on your web server configuration. In most cases, generally speaking, any directories in the absolute path to your Blesta installation that do not appear in the URL should be included in your Root Web Directory setting. Consider the following examples:

  1. Installing Blesta in a subdirectory named "billing".
    The URL to the admin dashboard in your browser will be: domain.com/billing/admin/
    Assuming the absolute path to your account is /home/user/, and your web directory is named /public_html/, your Root Web Directory setting will be set to: /home/user/public_html/
  2. Installing Blesta in a subdomain named "clients".
    The URL to the admin dashboard in your browser will be: clients.domain.com/admin/
    Assuming the absolute path to your account is /home/user/, and your web directory is named /public_html/, your Root Web Directory setting may be set to: /home/user/public_html/clients/

The use of Virtual Directories on your web server may interfere with this value. If the cron is run via CLI, it does not use the web server, and therefore is unaware of your virtual directory aliasing, resulting in incorrect URLs in emails sent by cron. To resolve this issue, either remove the virtual directory alias to your Blesta installation, or set the cron to run via wget, which will use the web server, and thus be aware of the virtual directory alias.

Temp DirectoryThe full server path where Blesta should write temporary files. This directory must be writable by the server's web user and cron user.
Uploads DirectoryThe full server path where Blesta should write uploaded files. This directory must be writable by the server's web user and cron user.
Logs DirectoryThe full server path where Blesta should write log files. This directory must be writable by the server's web user and cron user.
Rotation Policy

The number of days to retain logs.

Rotation Policy controls the amount of time to retain most log data, cron log being the exception as that is controlled by the Blesta.cron_log_retention_days configuration.

Options that control what logs to delete can be found in the configuration. They include:

  • Blesta.auto_delete_accountaccess_logs
  • Blesta.auto_delete_contact_logs
  • Blesta.auto_delete_email_logs
  • Blesta.auto_delete_gateway_logs
  • Blesta.auto_delete_module_logs
  • Blesta.auto_delete_transaction_logs
  • Blesta.auto_delete_user_logs

GeoIP Settings

GeoIP Settings can be found under [Settings] > [System] > [General] > [GeoIP Settings].

Enabling GeoIP will allow certain features to take advantage of location services. GeoIP requires the GeoLite City binary database, which can be obtained from your account at https://www.maxmind.com/. The file should be unzipped and uploaded to your Uploads Directory and placed in a folder named system.

OptionDescription
Enable GeoIPCheck to enable GeoIP features.

Maintenance

Maintenance can be found under [Settings] > [System] > [General] > [Maintenance].

OptionDescription
Enable Maintenance Mode

Check to enable maintenance mode.

When in maintenance mode:

  • Only staff users may use the system.
  • All other users will be directed to the login page.
  • The API will be disabled.
Reason for MaintenanceEnter the reason for the maintenance. This will be displayed to users that access the system when maintenance mode is enabled.

License Key

License Key can be found under [Settings] > [System] > [General] > [License Key].

OptionDescription
License KeyThis is your Blesta license key. If you receive a new license key, enter it here.

Payment Types

Payment Types can be found under [Settings] > [System] > [General] > [Payment Types]. Payment types allow manual payments to be recorded.

Adding a Payment Type

To add a payment type click Create Payment Type on the payment type listing page.

Editing a Payment Type

To edit a payment type click Edit next to the payment type on the payment type listing page.

OptionDescription
NameThe name of the payment type.
TypeDebit or Credit. When set to debit, transactions using this payment type are considered income-based while credit is non-income-based.
Use Language Definition

Check if the value entered for Name has a language definition.

Add your custom language definitions to the _custom.php language file.

Deleting a Payment Type

To delete a payment type click Delete next to the payment type on the payment type listing page.

  • No labels