Getting Started with TYPO3
TYPO3 is an Open Source CMS written in PHP. To get more information, visit their website.
Create Environment
First you have to create a website on your server. Our website module provides everything you need to manage, deploy and run your website. Every website is type based, which means you have to select a particular Type.
Log in to cockpit.opsone.ch
Choose your server or create a new one
Go to websites, and create a new one
Select website type TYPO3 and fill in all settings
Tip
You don’t need to remember your DB credentials. We always provide them as Environment Variables.
According to those settings, our automation will configure the webserver/vhost as required.
Access with SSH
On the server you can work with SSH. Due to security reasons, we allow key based logins only.
If you don’t have an SSH key: Create an SSH key pair
Add your SSH Public Key in the Cockpit: Either for the whole server or within the website.
Now you can log in via SSH. Username is your chosen website name.
Tip
Wondering why your existing SSH key is not working? Maybe it does not meet our minimum requirements.
Install TYPO3
We recommend that you install TYPO3 via composer to have full control over the update cycle and all the needed dependencies.
Note
Check the different TYPO3 types in our overview to get the specific version configurations and TYPO3 core directories.
The webroot of your website may vary depending on what TYPO3 Version you select and can also be checked in the Type Overview linked above.
You find the official setup instructions in the TYPO3 Documentation.
To create a basic TYPO3 installation via composer, follow the instructions below to leverage some of our optimizations and avoid some common pitfalls:
Create a fresh TYPO3 project in a new directory ~/typo3v14, make sure to execute this command in your website’s home directory:
cd ~/
composer create-project "typo3/cms-base-distribution:^14" typo3v14
Now remove the empty ~/public-directory, and instead create a new symlink to the relevant directory in the new TYPO3 installation directory (~/typo3v14/public)
cd ~/
rm -rf public && ln -s typo3v14/public/ public
Change into the directory of the TYPO3 installation and add the new default template named Camino, this happens by requiring/installing this package as a dependency via composer:
cd ~/typo3v14
composer req typo3/theme-camino
To create the initial configuration, you can execute the command below. Note that the database credentials are pre-filled from the environment variables that are present on the server - and they can also be found in the website settings in the cockpit.
The setup wizard will ask you some questions to create an admin account and set the project title. Make sure to safely store your administrator credentials as you will need them to log into your new installation after the setup.
cd ~/typo3v14
vendor/bin/typo3 setup --server-type=apache --driver=mysqli --host=$DB_HOST --port=3306 --dbname=$DB_NAME --username=$DB_USERNAME --password=$DB_PASSWORD
The resulting configuration file is stored in ~/typo3v14/config/system/settings.php
By default, the Camino template site with some demo content will be reachable under the path /camino. To make it the “default” and reachable at /, run the following command, to override the site configuration:
cd ~/typo3v14
sed -i 's/\/camino\//https:\/\/'$WEBSITE_SERVER_NAME'/' config/sites/camino/config.yaml
As the last step, you need to initialize the TYPO3 extensions:
cd ~/typo3v14
vendor/bin/typo3 extension:setup
After these steps, your TYPO3-Installation is now reachable at the configured hostname you configured in the cockpit at the beginning of the setup.
To access the TYPO3 backend, navigate to /typo3 and login with the admin user created in the setup wizard.
Request-Limits with TYPO3
Our default website configuration contains webserver limitations to reduce the risk that too many requests from one single client could overload the server. Working in the TYPO3 backend can generate a lot of requests towards the webserver - and even clash with the default limits.
Should this cause a problem for you (e.g. seeing 429 too many requests errors in your browser console or the webserver logs), you should fine-tune these limits:
Find an example for how to set limits for TYPO3 in the section about request limits.
Note
As both these limits and the location of the .htaccess file are specific to your project, we don’t deliver this configuration automatically and you need to include it in your configuration yourself.