AWS PixelStreaming Auto-Update Service User Guide

Table of Contents

• Introduction
• Step 1: Editing the Configuration File
• Step 2: Running the Script
• Step 3: Update Process
• Warnings and Recommendations

Introduction

This guide provides detailed instructions on how to use the AWS PixelStreaming Auto-Update service designed for automatic updates of the PixelStreaming service built with Unreal Engine on AWS. This service automates the process of detecting update files and automatically updating the PixelStreaming service.

Step 1: Editing the Configuration File

1. Edit the autoupdate.config file.
2. Set the following parameters:
   • api_url: A URL where the API is specified. Fill this in if API calls are needed.
   • build_path: Path to the folder containing update files.
   • backup_path: Path to the folder where backups will be stored.
   • extract_path: Absolute path where archive files will be extracted.
   • file_name: Base name of the update file.
   • extension_type: Extension type of the update file.
   • backup: Set to yes if you want backups to be created.
   • repeat_time: Interval at which the script checks for updates (in seconds).

Step 2: Running the Script

1. Open a terminal.
2. Run the script by entering the following command:

   bash autoupdate.sh

Step 3: Update Process

• When the script starts, an ASCII art graphic will be displayed on the screen.
• The script reads the configuration file and performs the specified actions.
• Ensures that required packages are installed.
• Checks the presence and access permissions of critical directories.
• Extracts and validates the update file.
• Takes backups (if specified).
• Makes API calls (if specified).
• Enables automatic updates by repeating the process.

Warnings and Recommendations

• While the script is designed to provide automatic updates, it's essential to use it carefully by understanding its logic before using it.
• It's recommended to test the script in a non-production environment to understand its functionality and prevent unexpected issues.