Upgrade

The application is regularly updated to fix bugs, add new features, or extensions.

Cloud

Cloud updates are automatic. You don't need to do anything, the application will update automatically.

Self-hosted

Self-hosted updates are manual. You need to replace the application files with the new ones.

warning

We recommend making a backup of your application and database before starting an update.

To update ClientXCMS, choose one of the methods below: downloading the release (archive), updating via Git, or via the administration interface.

Archive (release)

1. Download the latest release from GitHub and save it as clientxcms.zip:

curl -fsSL -o clientxcms.zip "https://github.com/ClientXCMS/ClientXCMS/archive/refs/tags/$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/ClientXCMS/ClientXCMS/releases/latest | sed 's#.*/##').zip"

2. Put your application in maintenance mode:

php artisan down

3. Extract the archive and replace the files:

unzip -q clientxcms.zip -d /tmp/cx && shopt -s dotglob && mv /tmp/cx/ClientXCMS-*/* /var/www/clientxcms/ && rm -rf /tmp/cx

4. Install dependencies and run migrations:

composer install --optimize-autoloader --no-dev
php artisan migrate --seed && php artisan clientxcms:db-extension --all

5. Clear caches and rebuild assets:

php artisan cache:clear
php artisan view:clear
php artisan route:clear
npm install && npm run build

6. Exit maintenance mode and run post-update hooks:

php artisan up
php artisan clientxcms:on-update

Git

1. If you installed your instance via Git, you can update by pulling the remote branch:

cd /var/www/clientxcms
git fetch --all --tags --prune
git checkout master
git pull origin master

2. Put your application in maintenance mode:

php artisan down

3. Install dependencies and run migrations:

composer install --optimize-autoloader --no-dev
php artisan migrate --seed && php artisan clientxcms:db-extension --all

4. Clear caches and rebuild assets:

php artisan cache:clear
php artisan view:clear
php artisan route:clear
npm install && npm run build

5. Exit maintenance mode and run post-update hooks:

php artisan up
php artisan clientxcms:on-update

Automatic

1. Log in to your administration interface.
2. Go to Settings > Security > Update.
3. Click the update button to launch the automatic process.
4. Rebuild the assets:
   • Run the command npm install && npm run build.

Plesk

If you use Plesk and installed the application via the Laravel Toolkit, you can follow these steps:

1. Log in to your Plesk panel.
2. Go to the Git repository manager.
3. Update the Git repository with the new version by clicking the "Deploy Now" button.
4. Follow steps 3 to 5 of the Git update method above using the Laravel Toolkit interface.