Quick Start

This guide quickly steps you through a private installation of Plxtra XOSP. See Install for more detailed instructions.

Prerequisites

To get started, you will need a host machine with:

1. A recent version of Docker installed and running.
2. PowerShell installed on the machine for installation.
3. (Windows only) An installation of WSL2 on Windows 10 (22H2) or 11.

Installation

1. Start with a PowerShell terminal.

2. Create a folder that will contain your XOSP installation and configuration scripts.

   mkdir $HOME\xosp
   cd $HOME\xosp

3. Download an XOSP release from the GitHub repository and extract it locally.

   iwr (iwr https://api.github.com/repos/plxtra/xosp/releases/latest | ConvertFrom-Json | select -ExpandProperty tarball_url) -OutFile xosp.tar.gz
   tar -xf xosp.tar.gz --strip-components=1

4. Configure XOSP and verify your environment configuration. If you encounter any problems, follow the instructions on-screen.

   ./XOSP-Configure.ps1

5. Install XOSP. This will install the containers and configure the services. If you encounter any problems, follow the instructions on-screen.

   ./XOSP-Install.ps1

Finishing Installation

A successful installation will finish with a set of manual steps, along with some links and login credentials to use the system.

Note

All manual steps must be performed before your installation will be available from a web browser.

Windows

1. Install the generated SSL certificate Docker\xosp.crt into your operating system’s certificate store and/or your browser.

   For Chrome/Edge, the certificate can be installed from PowerShell:

   Import-Certificate -FilePath Docker\xosp.crt -CertStoreLocation Cert:\CurrentUser\Root

   For Firefox or Safari, you will need to install the certificate directly into the browser.

   Note

   Make sure to restart your browser after this step!

2. Create DNS aliases for the Plxtra installation, by copying the contents of the Docker\hosts file into your operating systems hosts file.

   start notepad "Docker\hosts"
   start -Verb RunAs notepad C:\Windows\System32\drivers\etc\hosts

Linux

1. Install the generated SSL certificate Docker/xosp.crt into your browser certificate store.
   Instructions are available for Firefox.

2. Create DNS aliases for the Plxtra installation, by copying the contents of the Docker/hosts file into your operating systems /etc/hosts file.

   cat Docker/hosts | sudo tee -a /etc/hosts

Using

Plxtra XOSP is now ready to use. You can explore it using the links provided at the end of the install script output, using the provided credentials.

Continue to learn what XOSP can do.

Troubleshooting

If you encounter any errors or issues in the above steps, please refer to the more detailed Install Instructions.