With the help of our "Setup Tool", many tasks can be carried out very easily that would otherwise require many manual steps.
The tool is a so-called bash script that is executed on the server. You must therefore connect to the server via SSH and then start the script there.
Here you will find instructions on how to connect to the server under different operating systems:
You will then find the setupTool.sh script in the typo3cms/tools directory
To start the script, connect to the web server via SSH and then execute the following commands:
cd typo3cms/tools
./setupTool.sh
The language selection
As soon as you have executed the tool with ./setupTool.sh, you will be taken to the language selection.
There are currently only 2 languages, German and English.
You can select the desired language by either navigating between the two languages using the arrow keys or by clicking on the desired language with the mouse. You must then select the highlighted language with the space bar or a double click and then click on "Select" or confirm with Enter.
The main menu
Once you have selected the desired language, you will be taken to the main menu. There you can then select one of the various items.
To select a menu item, you can either use the arrow keys to move to the desired item and then select it using the space bar, or you can double-click on the desired menu item. To continue, click on "Select" or simply confirm with the Enter key.
Install sample project
The following is required for the installation:
- At least 1 GB web space
- A new directory name
- New backend/install tool password
- The domain under which the project should run (important for TYPO3 9LTS)
- Name and password of the new database
Once you have entered all the data and selected the sample project version, the project will be installed.
After the installation process, you only need to point the domain to the directory and the new project should be running.
Installing an empty TYPO3 project
The following is required for the installation:
- At least 1 GB web space
- A new directory name
- New backend/install tool password
- The domain under which the project should run (important for TYPO3 9LTS)
- Name and password of the new database
Once you have entered all the data and selected the TYPO3 version, the project will be installed.
After the installation process you only have to point the domain to the directory and then the new project should run.
Copy project
Required to copy a project:
- At least as much web space as the size of the project to be copied
- A new directory name
- Name and password of the new database
First you will be asked to select a directory.
To select a folder, click twice on the folder and then confirm with the space bar. The field below should then show typo3cms/SELECTEDPROJECT.
After you have selected the folder, you must assign a new folder name.
Finally, you will be asked to enter the access data for the new database. A copy of the project should then be stored in your web space.
Create a backup of a website
The following is required to create a backup of the website:
- At least 1 GB web space
- The name of the project folder
First you will be asked to select a directory.
Once you have selected the corresponding project, the backup will be created.
The backups that you create with this tool are saved in the directory typo3cms/system/backup/setupTool-Backups/ in the respective folder.
Create a backup of a database
The following is required to create a backup of a database:
- At least 500 MB web space (depending on the size of the database)
- The name of the database (db123456_78)
- The password for the database
- The database server (to be found in your customer menu)
First you will be asked to enter the access data for the database.
After you have entered the access data for the database, the backup is created.
The backups that you create with this tool are saved in the directory typo3cms/system/backup/setupTool-Backups/ in the respective folder.
Restoring a website from a backup
To restore a website from a backup is required:
- At least 1 GB of web space
- A new directory name
- Backup of the project
- DB dump of the project
- Name and password of the new database
Copy or move the backup files from the typo3cms/system/backup/setupTool-Backups/projectname/ directory to the typo3cms/ directory.
Alternatively, you can also use the files created by the automatic backup, which are located in the typo3cms/system/backup/files/ or typo3cms/system/backup/databases/ directories.
You can then start the restore process.
First you will be asked whether you have placed the files in the typo3cms/ directory. You can confirm this.
After you have confirmed the other questions, you can continue.
Then select the zip file that contains your project by clicking on the file in the right half of the window and confirming your selection with the space bar.
You should now see typo3cms/YOUR_ZIP_FILE in the bottom line.
After this step, you must now enter a project name under which the project is to be exported.
Then select the database dump that you want to import. To import the dump into a database, you now only need to enter the access data for the new database. The tool will do the rest.
Now all you have to do is point a domain to the directory and the website will be up and running again.
Restoring a database
The following is required to restore a database:
- The database dump to be imported
- Access data for a new, empty database
First, you will be asked to select the database dump to be imported. This should ideally be located in the typo3cms/ directory.
Click on the database dump and confirm the selection with the space bar so that the bottom line reads typo3cms/IHR_DATENBANK_DUMP.
You must then enter the access data for the new/empty database.
After you have entered the new access data and the dump has been successfully imported, you only need to change the access data for the database in your project. In TYPO3 you have to edit the file typo3conf/LocalConfiguration.php.
Create a new TYPO3 admin user
The following is required to create an admin user in your project:
- The name of the project directory
- Username of the new user
- Password of the new user
First you will be asked to select the project for which the admin user is to be created.
You must then enter the user name and password for the user.
Once you have entered all the data, the user is created and you can log in to the TYPO3 backend with the user.
Set new Installtool password
The following is required to set the Installtool password:
- The directory name of the project
- The new password
First you will be asked to select a directory.
To select a folder, click twice on the folder and then confirm with the space bar. The field below should then show typo3cms/SELECTEDPROJECT.
After the project has been selected, you must enter a new password.
You must then confirm the password reset.
Update TYPO3 version (e.g.: 8.7.22 -> 8.7.24)
IMPORTANT: Only works for projects that work with symlinks.
The following is required to update the TYPO3 version:
- The directory name of the project
First you will be asked to select a directory.
To select a folder, click twice on the folder and then confirm with the space bar. The field below should then show typo3cms/SELECTED PROJECT.
After the folder has been confirmed with Enter, the version of the symlink is automatically read out and then updated to the latest version stored in the script. If the latest TYPO3 core is not available, it will also be downloaded and unpacked.
Updating the MySQL version
This point is helpful if you want to migrate an old MySQL database in version 3 or 4 to version 5.
The following is required to update the MySQL database in your project:
- The name of the project directory in which the database is used
- A new MySQL 5 database
First you will be asked to select the project for which the MySQL database is to be updated.
You must then enter the access data for the new database.
After you have entered the new access data, the old database will be transferred to the new database. This may take a moment, depending on the size of the database.
The script automatically adjusts the access data in the TYPO3 configuration file.
Once the process is complete, please check that the website is still working properly.