About Contao Manager

This article is machine translated.

The development of the Contao Manager is supported by the Contao Association.

Task of the manager

Like most PHP projects, Contao is installed and updated with Composer. Composer is a package manager that can be used from the command line and can also be used to manage Contao completely from the command line. The Contao Manager is a tool that provides a graphical user interface to manage a Contao installation. It takes the hurdle of the command line and allows you to execute the necessary commands with just one click.

The manager can be used to perform the following tasks, among others:

  • Install Contao
  • Update Contao
  • Search for extensions
  • Install extensions
  • Uninstalling extensions
  • Empty Contao Cache (system maintenance)

Further functions are planned for the future, such as Define system settings.

The Contao Manager is optional and not required for running Contao. However, the tool makes it easier for beginners to install and manage extensions because no composer knowledge is required.

It is still possible to manage the installation of Contao 4 and extensions directly from the command line using Composer.

Install Contao Manager

System requirements

The system requirements are basically the same as for Contao. The Contao Manager automatically checks if the requirements are met.

  • PHP version 7.1 or newer
  • PHP extension Intl and OpenSSL
  • PHP functions proc_open and proc_close
  • PHP setting allow_url_fopen must be active

Hosting Configuration

In Contao, all publicly accessible files are located in the subfolder /webof the installation. Create the folder weband set the Document Root of the installation to this subfolder using the Hosting Provider Admin panel.

Example: example.compoints to the directory /www/example/web

Pro Contao installation therefore requires a separate (sub)domain.

Download and Installation

The Contao Manager consists of a single file that can be downloaded from contao.org. After successful download you will receive a file contao-manager.phar. transfer this file to the directory web on your web server.

Files .phar are not executed by all hosting providers. For best compatibility, add the file extension .php(final file name: contao-manager.phar.php).

.php files are transferred by most FTP programs in text mode instead of binary mode, which destroys the manager file. Therefore, add the file extension .php only after the upload.

Starting Contao Manager

Then use your browser to access the URL www.example.com/contao-manager.phar.php. You should see the Contao Manager welcome page.

Welcome page of the Contao Manager

Basic configuration

Before you install Contao, you have to configure the manager itself. Create a new user by entering a username and password. The password is independent from the later Contao installation.

Contao Manager does not need its own database. The configuration of the Contao Manager is stored in the database manager.json and the user data in the users.json directory /contao-manager.

Server configuration

The Contao Manager needs the path to the PHP binary and other server information to run background processes correctly.

Most servers are detected automatically. If your hosting provider is not listed, you can add it to our Wiki.

Server configuration

Select the appropriate configuration for your server or hosting provider. For a manual configuration select “Other …”.

Server configuration

Composer Resolver Cloud

The Composer Resolver Cloud allows you to install Composer dependencies even if the server does not have enough memory. Please note that your dependency resolution package information is sent to a Contao Association cloud service.

After the successful basic configuration, Contao can now be installed.

Frequently asked questions about the Contao Manager {#frequently asked questions about the Contao Manager}

How to update the Contao Manager?

Basically, a manual update is not necessary. The manager automatically checks in the background and updates itself if a new version is available.

In case of problems, you can always download the latest contao-manager.phar version and upload and replace it manually via FTP.

Did you forget your Contao Manager login information?

To reset your password, you must connect to your server via FTP.

In the directory contao-manager, delete the file users.json.

Now call the Contao Manager from your domain with the addition contao-manager.phar.php and create a new admin user.

If you see the login mask for an existing user despite deleting the file users.json, delete the cookies of the domain or open the Contao Manager page in the “incognito mode” of your browser.

Can I add another user account to Contao Manager? {#can-add-another-user-account to the Contao Manager}

Yes, you have to edit the file users.json in the directory contao-manager and add an additional user account. In our case this is h.lewis.

{
    "users": {
        "k.jones": {
            "username": "k.jones",
            "password": "…"
        },
        "h.lewis": {
            "username": "h.lewis",
            "password": "…"
        }
    },
    "version": 2,
    "secret": "…"
}

Can Contao Manager be added to an existing installation? {#the-contao manager can be added to an existing installation}

Yes, if you use a Contao installation in the Managed Edition, you can install Contao Manager later. Just upload the contao-manager.phar files into the directory web and add the file extension .php.

During the basic installation, the manager recognizes that Contao is already installed.