Step-by-Step Update Guide for the Platform

You can update the Protectimus On-Premise Platform using a Docker image on any operating system.

However, if you initially installed the Platform on Windows, you may follow the instructions for Windows users below.

1. Updating Platform Using a Docker Image

You have two options for updating the Protectimus On-Premise Platform with a Docker image:

• cloning a repository from Git;
• manual update.

We’ll walk you through both methods, allowing you to choose the one that best suits your preferences.

1.1. Updating via Git Repository Cloning

1. Use this command to copy the repository containing Docker Compose files to your local computer, where the Protectimus On-Premise Platform is installed.
   
   

   git clone
   https://github.com/protectimus/platform

   The contents of the archive will be as follows:
   
   

   .
   └── platform
   	├── platform
   	│   ├── docker-compose.yaml
   	│   ├── .env
   	│   ├── platform_data
   	│   │   ├── autogenerated-keystore.jks
   	│   │   └── protectimus.platform.properties
   	│   └── postgres_data
   	├── radius
   	│   ├── config
   	│   │   ├── radius.all.yml
   	│   │   └── radius.yml
   	│   ├── docker-compose.yaml
   	│   └── .env
   	└── unifi-guest-portal
       	├── config
       	│   ├── fragments.html
       	│   ├── guest-portal.all.yml
       	│   └── guest-portal.yml
       	├── docker-compose.yaml
       	└── .env

2. Go to the platform directory:
   
   

   cd platform/platform

3. Run the application using Docker Compose.
   
   This command will start all the containers required for your application in the background (-d):
   
   

   docker-compose up -d

4. Stop running containers using this command:
   
   

   docker-compose down

5. Make a backup of your database. The data is located in the postgres_data directory.

6. Get latest changes from Git repository.
   
   This command will update your local repository to the latest version that you have uploaded to Git.
   
   Resolve any configuration conflicts if necessary.
   
   

   git pull

7. Download the updated images. This command will download the updated Docker images from your Docker registry:
   
   

   docker-compose pull

8. Restart containers with new images.
   
   This command will restart the containers using the updated images in the background mode (-d):
   
   

   docker-compose up -d

1.2. Manual Update from Github

1. Download the latest version of the archive with the Protectimus Platform from Github and extract it:
   https://github.com/protectimus/platform/releases
   
   The contents of the archive will be as follows:
   
   

   .
   └── platform
   	├── platform
   	│   ├── docker-compose.yaml
   	│   ├── .env
   	│   ├── platform_data
   	│   │   ├── autogenerated-keystore.jks
   	│   │   └── protectimus.platform.properties
   	│   └── postgres_data
   	├── radius
   	│   ├── config
   	│   │   ├── radius.all.yml
   	│   │   └── radius.yml
   	│   ├── docker-compose.yaml
   	│   └── .env
   	└── unifi-guest-portal
       	├── config
       	│   ├── fragments.html
       	│   ├── guest-portal.all.yml
       	│   └── guest-portal.yml
       	├── docker-compose.yaml
       	└── .env

2. Go to the platform directory:
   
   

   cd platform/platform

3. Run the application using Docker Compose.
   
   This command will start all the containers required for your application in the background (-d):
   
   

   docker-compose up -d

4. Stop running containers using this command:
   
   

   docker-compose down

5. Make a backup of your database. The data is located in the postgres_data directory.

6. Change the component version to the latest in the .env file.

7. Download the updated images. This command will download the updated Docker images from your Docker registry:
   
   

   docker-compose pull

8. Restart containers with new images.
   
   This command will restart the containers using the updated images in the background mode (-d):
   
   

   docker-compose up -d

2. Updating Platform on Windows

2.1. Stop Platform, Bot, and Radius Services

Before updating the platform, stop the platform, bot, and Radius in services.

2.2. Upgrade Platform and Select Existing Database

Install the new version of the Protectimus On-Premise Platform, and when selecting a database, choose the one used in the old version of the Protectimus platform.

1. Choose the necessary components.

2. Click Next.

3. Click Next.

4. Use your username and password to log in to the PostgreSQL database you created during the first platform installation and click LogIn.

5. Enter the name of the database you used in the old version of the Protectimus platform and click Select.
   
   You can click the List button to see the list of available databases if you don’t remember the exact name of the necessary database.

6. Preferably, use the same destination folder as previously.

7. Once the platform is installed, you will see the changelog describing recent updates; close it.

8. Then click OK to finish the installation.

If you have other questions, contact Protectimus customer support service.