Migrate older projects to Sitepackage

TYPO3 11 TYPO3 12

Move TYPO3 project files from fileadmin to an extension sitepackage

If you have implemented a project with TYPO3 a long time ago, its configuration files are usually located in the folder: fileadmin.

The migration from fileadmin to a centralised site configuration requires careful planning and adaptation of all relevant configurations and paths. By following these steps, you can ensure that your TYPO3 installation complies with current best practices and is easier to manage in the long term.

A sitepackage is a TYPO3 extension that contains all relevant configurations for a website. By storing the entire configuration in one package, it is protected from unauthorised access. As an extension, your sitepackage manages your dependencies on other extensions and/or the TYPO3 version. This makes deployment easier and allows you to place the configuration of your website under version control.

Many thanks to Benjamin Kott.

Here are some advantages:

Configuration files not accessible for editors
Configuration files are protected
Autoload PageTS
Autoload TypoScript
Static PageTS Template
Static TypoScript Template
Dependency Management
Clean version control possible

Prerequisites

TYPO3 installation (version 9.5 or higher recommended)
Access to the TYPO3 backend and the file structure

Steps to migration

Create a full backup of your TYPO3 installation and database.

I prefer to create a DEV so that the live website with TYPO3 does not suffer any downtime.

Create siteconfig package. Click here to go to the sitepackage builder

I use the Sitepackage-Builder, with which you can create a sitepackage extension optimised for the TYPO3 version, which you simply import into the project via Extensions / Extensions. Everything is perfectly harmonised here. However, some changes are necessary for this.

Image of the Sitepackage Builder process

When you set up a new project, you can select the Bootstrap Package. It contains various configurations, including those relating to the backend and content elements.

When upgrading from older projects, I recommend the Base Package: Fluid Styled Content

There are also a few things to consider here, but they are easier to configure.

Switch on debugging

The created file is now imported via the extensions and activated in the root template. Debugging / error messages should now be switched on in any case.

Here you can find out how to switch on the debug mode of TYPO3.

Copy files to the new Sitepackage file system

In the file directory under typo3conf / ext / siteconfig you will find all the relevant files, neatly and systematically organised.

Now all files such as images, CSS, Javascript etc. are copied to the folder under Public / ....

Under Configuration we find the file setup.typoscript under TypoScript. All relevant configurations are already included here. It is important to transfer the old references here.

References to other Typoscript files can also be referenced here:

<INCLUDE_TYPOSCRIPT: source="FILE:EXT:siteconfig/Configuration/TypoScript/menu.typoscript">

The files must end with file.typoscript. Not .ts or .txt!

Change template

The template is naturally located in siteconfig / Private / Layout. This refers via <main> to Template / Page / Default.html. As in the original, the tempaltes and partials are defined here.

However, if we have defined a backend layout, we need the respective templates referenced to the ID of the backend layout according to the following concept:

ID 1 = siteconfig / Private / Templates / Page / Default / 1.html

ID 2 = siteconfig / Private / Templates / Page / Default / 2.html

The template of the respective backend layout is located there.

Back