Maintenance¶

When operating the system, you must supervise:

Monitor the utilization of hardware resources (CPU, RAM, free disk size)
Timely elimination of causes of hardware resource overload, or increase in hardware resources
Protection of the server operating system from unauthorized access
Protection of the system from DDoS-attacks
Data backup
Updating of the system when new versions are released by the developer
Deletion or transfer of old .log files

Backup¶

The database and the data directories specified in the docker-compose.yml file named data must be backed up:

/opt/getscreen/db/data
/opt/getscreen/download/data
/opt/getscreen/image/data
/opt/getscreen/storage/data

System update¶

To update the system, run the following commands:

cd /opt/getscreen/
sudo docker-compose pull
sudo docker-compose up -d

The Server and Download components make schema changes in the database on their own, if necessary.

For major upgrades, the developer can provide additional instructions which must be followed to correctly upgrade to the new version of the system.

Reset Main Administrator password¶

In case if main administrator's password been lost, you can reset it if you keep ssh access to the server. Please run command

cd /opt/getscreen
sudo docker exec -it getscreen-server /opt/server/server -reset-password

Command will display the new password:

The administrator password has been changed to [new password]

After that, container with server must be restarted:

cd /opt/getscreen
sudo docker-compose restart getscreen-server

Configure custom folder for video recordings storage¶

To configure storage of video recordings outside of standard /opt/getscreen folder, open docker-compose.yml file. Find section for getscreen-storage container

  #########################################################
  # Storage (screen videos) server
  #########################################################

  [skipped]

    volumes:
      - ./storage/data:/opt/storage/data:rw
      - ./storage/log:/opt/storage/log:rw
      - ./storage/config.json:/opt/storage/config.json:ro
      - ./cert/server.crt:/opt/storage/cert/server.crt:ro
      - ./cert/server.key:/opt/storage/cert/server.key:ro

and add line into volumes section

    volumes:
      - ./storage/data:/opt/storage/data:rw
      - ./storage/log:/opt/storage/log:rw
      - ./storage/config.json:/opt/storage/config.json:ro
      - ./cert/server.crt:/opt/storage/cert/server.crt:ro
      - ./cert/server.key:/opt/storage/cert/server.key:ro
      - /path/to/video:/opt/storage/data/save:rw

where /path/to/video - path where you want to store video

Last update: December 1st, 2023