Support

Documentation

System configuration

There are some settings which are common across all backup profiles. Most of these settings have to do with the way the application interacts with your server environment. This is what you can configure in the System Configuration page. This page is organised in different tabs.

[Tip]Tip

If you accidentally modify any of these settings to a value that doesn't work on your server and you can no longer log in to Akeeba Solo you can still recover from this error without losing your backups or your backup profile settings. Simply delete the file Solo/assets/private/config.php from your server and try accessing Akeeba Solo again. You will see the web installer. Go through with it an a new configuration file will be generated.

Since Akeeba Backup uses the native user management system of the site it runs inside, should you be unable to log in to your site please consult the support forums of your site's script (e.g. WordPress or Joomla!)

The Application Configuration tab allows you to set up the basic configuration parameters for Akeeba Solo that depend on your server environment.

[Important]Important

Some of the following options are only relevant to Akeeba Solo (standalone). If you are using Akeeba Backup you will not see the options that are not necessary, such as the database setup section.

System Configuration – Application Configuration

Server timezone

Select the timezone your server is located in. Please note that the timezone of your server may be different than the timezone you live in or the timezone of your hosting company's headquarters. For example, a client in Frankfurt, Germany has signed up with a host based in London, UK but the server is located in Amsterdam, Netherlands. The timezone which has to be used here is Europe/Amsterdam. If you are unsure please ask your host.

URL to Akeeba Solo

Enter the URL which points to your Akeeba Solo installation. Normally you don't need to change that after installing Akeeba Solo.

Session timeout (minutes)

You will remain logged in to Akeeba Solo for this many minutes since your last activity on the system. The default is 1440 minutes (one day). We recommend to always log out after you are done managing Akeeba Solo as a standard security practice. Despite this setting, you may be logged out automatically if your IP changes, your browser is updated or your browser's user agent string is modified (e.g. operating system update, Java update etc).

Filesystem driver

On many shared hosts you need to use one of the (S)FTP modes below and enter your (S)FTP parameters to make sure that the application can write to its files properly. Not all hosts support SFTP. You need both SFTP support at the server and the mod_ssh2 PHP extension to be installed. You typically only need that on shared hosts with bad permissions / ownership of files and directories.

[Note]Note

The settings below only appear when you select a filesystem driver other than Direct File Writes.

(S)FTP Server Hostname

The hostname or IP address of your (S)FTP server, e.g. ftp.example.com or 127.0.0.1. You MUST enter this without the ftp://, sftp:// or ssh:// prefix. If unsure about this and the other FTP settings please ask your host.

(S)FTP Server Port

The port number your (S)FTP server listens to. Usually it's 21 for FTP and 22 for SFTP. If unsure, ask your host.

(S)FTP Username

The username you use to connect to your (S)FTP server. If unsure, ask your host.

(S)FTP password

The password you use to connect to your (S)FTP server. If unsure, ask your host.

(S)FTP directory

The (S)FTP directory to the Akeeba Solo installation or your site (if you are using Akeeba Backup). On FTP servers this is not the same as the filesystem path. If unsure, ask your host.

The Public API tab lets you configure the settings for the front-end backup option. You only need to use this for scheduling CRON jobs with the alternative backup CRON script, a third party service using the front-end backup URL or for using the remote JSON API with Akeeba Remote Control CLI or a compatible third party service. Otherwise we recommend turning this feature off.

System Configuration – Public API

Enable front-end and remote backup

When enabled, allows launching a new backup without logging in to the back-end. Useful for scheduling backups on your server or performing remote backups.

You only need to use this for scheduling CRON jobs with the alternative backup CRON script, a third party service using the front-end backup URL or for using the remote JSON API with Akeeba Remote Control CLI or a compatible third party service. Otherwise we recommend turning this feature off.

Secret word

Required to authenticate a remote backup method. Also protects the front-end backup feature from Denial of Service attacks by requiring you to pass this secret word in the front-end backup URL.

Please note that if you use any character other than a-z, A-Z and 0-9 you MUST NOT use the secret word verbatim in the front-end backup URL. Instead, you have to URL-encode it. The Schedule Automatic Backups page does that automatically for you. Just go to th Control Panel, click Schedule Automatic Backups, scroll all the way down and use one of the tabs to get the URL or command line you need to use with the secret word properly encoded in the URL.

For security reasons, you must use a complex enough secret word. Akeeba Backup / Akeeba Solo enforces that by disabling the front-end backup feature and the JSON API if you are using a Secret Word with a low complexity. We strongly recommend using a "secret word" consisting of at least 16 random, mixed case alphanumeric characters. It should not be a dictionary word or based off a dictionary word. One good resource for truly random secret words is Random.org's password generator.

[Note]Note

Why is this field not a password field? The Secret word is transmitted in the clear when you load the page and is also visible when you view the source of the page or right click on the field and choose Inspect Element. In other words, as long as someone has access to the component configuration page they can trivially find out the secret word. Not to mention that the secret work is also plainly visible in the Schedule Automatic Backups page. Always use HTTPS with a commercially signed SSL certificate when configuring or backing up your site.

Email on backup completion

Send a notification e-mail after the front-end or remote backup is completed.

Email address

Send email to this address (leave blank to email all Super Users)

Email subject

Leave blank to use default. You can use all variables you can use for naming archive files, e.g. [HOST] and [DATE]

Email body

Leave blank to use default. You can use all of variables you can use for naming archive files, e.g. [HOST] and [DATE]. You can also use [PROFILENUMBER] for the current profile's number, [PROFILENAME] for the current profile's name, [PARTCOUNT] for the number of total generated backup archive's parts and [FILELIST] for a list of backup archive parts.

The Push notifications tab lets you configure push notifications to your mobile and desktop devices.

Akeeba Solo 1.3.2 and later can notify you on backup start, finish and –sometimes– on backup failure using push notifications delivered through the third party application Pushbullet. Push messages are delivered to all your devices running the Pushbullet client software including smartphones and tablets (iOS, Android, Windows) as well as laptops and desktops (Windows, Linux, Mac OS X).

Please note that backup failure notifications are only delivered for backups started in the web interface through your browser. For technical reasons beyond our control these notifications can not be delivered for remote (JSON API) and scheduled (CRON job) backups: if the backup fails the PHP executable stops working, therefore our PHP code to send notifications can not work.

Push notifications

Check the box to enable push notifications with Pushbullet.

Pushbullet Access Token

Enter your Pushbullet Access Token. You can find it in your Pushbullet account page. Do note that this token gives full access to your Pushbullet account and is visible by everyone who can view and edit Akeeba Solo's / Akeeba Backup's settings.

The Update tab lets you tell the application how to handle its Live Update feature.

System Configuration – Update

Download ID

This is required to enable live updates of the Professional release. Please visit https://www.akeebabackup.com/my-subscriptions.html to get your personal Download ID.

Minimum release stability for update notifications

Select the minimum release stability level for which you will be notified that a new update is available. Please use RC and Stable only on mission critical sites. Help us test new releases on live servers by installing alphas and betas.

Display PHP warning

Currently ignored

The E-mail tab tells the application how to send out emails. Please note that the application is using the established PHPmailer software for handling email sending.

System Configuration – E-mail

Enable e-mail

Set to ON to allow the application to send out e-mails. When you set it to OFF no emails will be sent at all.

Mailer

Choose the method used by the application to send emails. You can choose between:

  • PHP Mail. The internal PHP mail() function is used. This may not work on many servers.

  • SMTP server. An SMTP server is used to send out emails. It can be hosted on the same server as the application or somewhere entirely differently - e.g. GMail.

  • Sendmail. The system's sendmail binary is used to send emails. Please consults with your host if this is a viable option,

From email

The email address the emails will appear to be coming from, e.g. .

From name

The name the emails will appear to be from, e.g. Your Akeeba installation.

Require SMTP authentication

Enable if you are using SMTP and your SMTP server requires authentication, i.e. using your username and password to send emails. Only used with the SMTP server Mailer option.

SMTP security

Choose the security preference of your SMTP server. Please consult your email provider. Only used with the SMTP server Mailer option.

SMTP port

The port of your SMTP server. Usually it's 25 for no encryption, 465 for SSL/TLS encryption. Only used with the SMTP server Mailer option.

SMTP username

The username used for SMTP authentication. Only used with the SMTP server Mailer option.

SMTP password

The password used for SMTP authentication. Only used with the SMTP server Mailer option.

SMTP host

The hostname or IP address of your SMTP server. Only used with the SMTP server Mailer option.

The Database setup tab allows you to change the way the application connects to your database

[Warning]Warning

Do not change the parameters on that page after you have installed Akeeba Solo unless you are perfectly sure about what you are doing. Making a mistake in these settings will make it impossible to log into Akeeba Solo!

System Configuration – Database setup

Database type

Select the database server technology you are going to use.

Please note that for MySQL there are two options: MySQLi and MySQL (with or without the i at the end). Most servers allow you to use the newer, better, faster MySQLi (with the i at the end) option. If this doesn't work, you can also try using the one without the i at the end. This is discouraged as that option is the older, slower one which may have a performance impact on your backups.

Database server host name

The host name or IP address of your database server. It is usually localhost or 127.0.0.1 which are very different as far as the database connection is concerned. If localhost doesn't work, try 127.0.0.1 (note: these are dots, not commas, between the numbers). Otherwise please ask your host. Some hosts require something different in there, e.g. database123.example.com.

User name

The user name you use to connect to your database. This is provided by your host.

Password

The password you use to connect to your database. This is provided by your host.

Database name

The name of your database. This is provided by your host.

Database table name prefix

This is the common prefix of all database tables used by Akeeba Solo. It has to be two to four lowercase characters a-z and numbers 0-9 followed by an underscore. If you are unsure, use the default value of solo_

Cookies Notification - Action required

This website uses cookies to provide user authentication and improve your user experience. Please indicate whether you consent to our site placing these cookies on your device. You can change your preference later, from the controls which will be made available to you at the bottom of every page of our site.