Concrete CMS Core Upgrade Shell:

This is simple shell script to upgrade your Concrete CMS (formerly concrete5) site overriding the core "concrete" directory. This is suitable for someone who don't want to pile up Concrete CMS versions in "update" directory.

Since you're using GitHub, I assume you know what you're doing. This is the script that runs on your server.

This upgrade script supports Ver 8.0.0 and above.

It's no longer supporting 5.7.x. If you would like 5.7.x support, please use Version 0.3 and earlier.

Features

• Execute Concrete CMS upgrade & update languages via shell
• Enable/Disable maintenance mode
• Backup dababase
• Backup database & copy it to backup database
• Or import database to backup database

How to run

Initialize

Enter the necessary server's info and database info.

Required Variable

The following variables are required to fill

• WHERE_IS_CONCRETE5: the full server path of where Concrete CMS lives

Semi-required Variable

• DO_SUDO: If web server is running as apache/nginx user rather than your SSH log-in user, you must set sudo prefix command
• USER_PERMISSIONS: If DO_SUDO variable is entered, you must set USER_PERMISSION. This shell will chown files, language, and concrete folders.

Optional Variables

For Main Database Backup

This script has a feature back up your Concrete CMS database dump and files. If you want to use this feature, you must fill out the following variables

• PROJECT_NAME: This will become the prefix of your back-up files
• WHERE_TO_SAVE: The server full path of where to save the backup files
• MYSQL_CHARASET: Enter the database's character collation. If it's later than 8.5.0, it's usually utf8mb4. If it's old database, it's usually utf8.
• PROD_DB_*: Enter your main Concrete CMS database info such as host address, db username, db password, database name, and port.
  • Read commend carefully regarding tablespace for MySQL engine.

For Backup Database

This is intended to copy production database to backup database. If production database backup failed, you can quickly point to this backup database.

• USE_IMPORT_FILE & IMPORT_FILE : True/False, then enter the full server path of SQL dump. We have this option to import additional SQL from server. You may want to import and debug from backup.
• BACKUP_DB_*: Enter your backup Concrete CMS database info such as host address, db username, db password, database name, and port.
  • Read commend carefully regarding tablespace for MySQL engine.
• BACKUP_DB_EMPTY_DB: Set it to true if you want to empty backup database before importing. It is recommended to do so especially if you are restoring from upgrade failure because schema may have changed.
• BACKUP_DB_ANONYMIZE_USERS: Set it to true, if you are backing up the database to develop environment, you want to anonymize the user email. You may ended up sending test emails to actual user by accident. If your data got stolen, you are entitled for information breach. If you've set true, it will anonymize all users' email address to dummy@example.com.
• BACKUP_DB_SET_DEFAULT_FILESTORAGELOCATION: Set it to true, if you want to set default file storage location back to Concrete CMS's very default application/files. If your production site is using some external file storage, you don't want develop site to upload the file to production environment by mistake.

C5_Version & CONCRETE5_PACKAGE_DOWNLOAD

This script let you run without any option, if you do so, it will fetch the Concrete CMS version which are set in this variable. If you want to change it to older version, change it accordingly.

How to run

Obtain your desired Concrete CMS version and Download URL.

For legacy (newer) versions, visit Concrete CMS website and get download URL. When executing the shell script, concretecms-upgrade.conf must exist in the same directory.

sh concretecms-upgrade.sh [Concrete CMS version] [ZIP Download URL]

In case of 8.5.12

sh concrete5-upgrade.sh 8.5.12 https://www.concretecms.org/download_file/2bba0898-1539-48ff-b273-0cbddc7588da

Enter the option that you would like to execute.

Wait until the commands finish processing.

Version History

Version	Updates
4.0.0	- Separated variables from shell scripts. - Changed so that when an error occurs during the upgrade, the shell stops in the middle of the process.
3.0.1	- Changed filename from concrete5 to concretecms
3.0.0	- Version 9 support & validation check not to run upgrade for 5.7 and earlier versions - Add a BACKUP_DB_EMPTY_DB option to empty backup database before importing - Add a BACKUP_DB_ANONYMIZE_USERS option when backing up to backup database - Add a file storage location option when backing up to backup database
2.0.1	- Readme: change concrete5 to Concrete CMS - Bug fix which prod db backup ends with error with empty tar command
2.0	- Enable/Disable Maintenance Mode - New config & database backup option - Change from wget to curl - Bug fix: Was unable to run the script with no option - Readme
1.0	Drop Concrete CMS support for 5.7 and earlier version
0.3	Ability to specify different Concrete CMS version and download zip by command

MIT LICENSE and NO GUARANTEE

This script is licensed under The MIT License. USE IT AT YOUR OWN RISK.

Legacy version

If you would like legacy version of 5.6 & earlier, visit the legacy branch https://github.com/concrete5cojp/concrete5-upgrade-shell/tree/legacy