.. author:: Daniel Kratz <email@example.com>
.. tag:: lang-php
.. tag:: web
.. tag:: cms
For this guide you should be familiar with the basic concepts of
The OctoberCMS platform is released under the MIT License. All relevant information can be found in the LICENSE file in the repository of the project. Please also review the Marketplace terms if you plan to use plugins or themes from the official Marketplace.
We're using :manual:`PHP <lang-php>` in the stable version 7.1:
[isabell@stardust ~]$ uberspace tools version show php Using 'PHP' version: '7.1' [isabell@stardust ~]$
Your domain needs to be set up:
We will install October using the official command-line interface (CLI). To do this simply
cd into your :manual:`DocumentRoot <web-documentroot>` and use the the following command to download the install script using cURL and execute it with PHP.
[isabell@stardust ~]$ cd ~/html [isabell@stardust isabell]$ curl -s https://octobercms.com/api/installer | php All settings correct for installing OctoberCMS Downloading OctoberCMS... OctoberCMS successfully installed to: /var/www/virtual/$USER/html [isabell@stardust ~]$
The installer script will download all necessary files including the CLI so you can directly continue with the configuation of your October installation afterwards.
During the setup process you will be asked for database credentials. We use MySQL and suggest you use an :manual_anchor:`additional database <database-mysql.html#additional-databases>` for October to save your data. You have to create this database first using the following command.
To start the CLI that will guide you trough the setup use the
[isabell@stardust ~]$ cd ~/html [isabell@stardust html]$ php artisan october:install [...] [isabell@stardust ~]$
The following list contains information on what you need to enter in the CLI setup:
- Database type:
- MySQL host:
- MySQL port:
- Database name:
isabell_october(the name of the database you just created)
- MySQL login:
- MySQL password: your MySQL password that you've got from
- First name, Last name, Email adress: your account information
- Admin login: your admin username (to follow security best practices please don't use
- Admin password: your admin password (please choose a strong, secure password to prevent hacking of your installation)
- Confirm that the entered information is correct
- Application URL: the domain of your uberspace e.g.
- Configure advanced options?: select no
With the confirmation of the last step October will setup your database and install a demo package.
You can now visit your domain and you will see the frontend of the installed demo package. To log in to the admin panel append
/backend to your URL (e.g.
You can use the October CLI which we used to setup your instace also to e.g. install plugins. See the Console command list to explore all possibilities.
Check the update feed regularly to stay informed about the newest version. You will also be notified in the October backend if Updates are available.
To update October and your installed plugins you can use the
october:update CLI command in the root directory of the application. This will update the core application and plugin files, followed by a database migration.
[isabell@stardust ~]$ cd ~/html [isabell@stardust html]$ php artisan october:update Updating October... Found 1 new update! Downloading application files [...] [isabell@stardust ~]$
Tested with OctoberCMS 1.0.443, Uberspace 7.1.14