> For the complete documentation index, see [llms.txt](https://piara-docs.gitbook.io/piara-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://piara-docs.gitbook.io/piara-documentation/admin-guide/installation-lite.md). # Installation Installation video: {% embed url="" %} ### Prerequisites * Debian 64-bit (amd64) latest (LTS) release. * To install Debian on your **personal computer** for local development or testing, a guide using VirtualBox is provided in the [Installation in VirtualBox](#installation-in-virtualbox) section. * Hardware Requirements: * CPU: 4 cores * Memory: 8 GB RAM * Disk Space: 40 GB * PIARA Lite License Key: Obtain a free license key from our website: [piarainc.com](https://piarainc.com) ### Steps 1. Connect to your Debian server via SSH * Open your terminal and replace `` with the actual IP address of your Debian server. ```shell ssh root@ ``` E.g., for a local Debian server installed using [Installation in VirtualBox](#installation-in-virtualbox) ```shell ssh root@localhost -p 2224 ``` * This assumes you have configured port forwarding in VirtualBox, mapping the guest SSH port (22) to host port 2224 2. Set up Docker's `apt` repository ```shell apt-get update apt-get install ca-certificates curl install -m 0755 -d /etc/apt/keyrings curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc chmod a+r /etc/apt/keyrings/docker.asc echo \ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ tee /etc/apt/sources.list.d/docker.list > /dev/null apt-get update ``` 3. Install the latest version of Docker ```shell apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin ``` 4. Initialize a Docker Swarm ```shell docker swarm init --advertise-addr 127.0.0.1 ``` 5. Install `git` ```shell apt install git ``` 6. Download deployment scripts and configs ```shell git clone https://github.com/piara-lite/piara-lite-deploy.git piara ``` 7. Run the PIARA installation script The `piara.sh` script automates the installation process. ```shell cd piara/ chmod ug+x piara.sh ./piara.sh install ``` 8. Follow the installation wizard * You will be prompted to enter the following information: * Your license key * Webapp domain name (Press Enter to keep default: piaralite.piaratestsandbox.net) * Identity Name (Enter any suitable text) * Marking Definition Statement (Enter any suitable text) 9. Copy the output information * The installation script will output the following information: * Webapp URL * Admin Username * Admin Password **Important:** Store this information in a secure location 10. After the installation scripts complete, verify the service status by running the following commands If the "REPLICAS" column shows "1/1" for each service, all services have successfully started. ```shell docker stack services piara-back ``` and ```shell docker stack services piara-front ``` **Note:** It may take up to 10 minutes for all services to start 11. Create `identity` and `marking-definition` objects This script configures the identity and marking definitions for your environment ```shell back/add-identity.sh ``` 12. Open your web browser to log in. Log in using the admin username and password displayed during the installation wizard * **Scenario 1: Local Virtual Machine with Default Domain** * If you installed PIARA Lite on a virtual machine on your local computer and used the default Webapp domain name during installation, open in your web browser * **Scenario 2: Local Virtual Machine with Custom Domain** * If you installed PIARA Lite on a virtual machine on your local computer and entered a custom Webapp domain name, you need to add an entry to your local computer's `/etc/hosts` file. * Add the following line to your `/etc/hosts` file, replacing `` with the IP address of your virtual machine: ```shell yourcustomdomain.com ``` * Then, open your custom domain (e.g., `http://yourcustomdomain.com`) in your web browser. * **Scenario 3: Cloud Virtual Machine with Default Domain** * If you installed PIARA Lite on a virtual machine in the cloud and used the default Webapp domain name during installation, you need to add an entry to your local computer's `/etc/hosts` file * Add the following line to your `/etc/hosts` file, replacing `` with the public IP address of your cloud virtual machine: ```shell piaralite.piaratestsandbox.net ``` * Then, open in your web browser. * **Important:** You may need to configure your cloud provider's firewall to allow access to the server * **Scenario 4: Cloud Virtual Machine with Custom Domain** * If you installed PIARA Lite on a virtual machine in the cloud and entered a custom Webapp domain name, you need to add an entry to your local computer's `/etc/hosts` file. * Add the following line to your `/etc/hosts` file, replacing `` with the public IP address of your cloud virtual machine: ```shell yourcustomdomain.com ``` * Then, open your custom domain (e.g., `http://yourcustomdomain.com`) in your web browser. * **Important:** You may need to configure your cloud provider's firewall to allow access to the server. ### Installation in VirtualBox 1. Your computer must have enough resources to allocate the following to a guest Virtual Machine: 1. 4 CPU, 8 RAM, 40GB disk space. 2. Note. Remember, the host still needs resources. It should have at least double that amount. 2. Download and install latest VirtualBox for Windows: 3. Download latest stable (LTS) Debian image (amd64): 4. Create new VM in VirtualBox: 1. Chose a “Name” for the new virtual machine 2. Keep “Folder” unchanged(unless you want a different location) 3. Find the Debian ISO image that you just downloaded in step #2. 4. Do **NOT** “Skip Unattended Install” 5. Pick “Username” and “Password”. (default username is “vboxuser”, password is “changeme”) 6. Set “Hostname” to: ``` piaralite ``` 1. Set “Domain Name” to: ``` piaratestsandbox.net ``` 1. Minimum system requirements: 1. Processors: 4 CPU 2. Base Memory: 8 GB RAM (same as 8192 MB) 3. Virtual Hard disk: 40 GB 5. After Debian is installed, login to the guest Debian VM with the credentials from the step 4 6. Open command line terminal: 7. Switch to `root` . Password for the `root` is the same as in step 4. ``` su - ``` 8. Setup SSH server(you must be root after the step 7): 1. install openssh-server ``` apt install openssh-server ``` 1. Check status to make sure that the server is “active” ``` systemctl --no-pager status ssh ``` 1. Allow root to connect by adjusting sshd config: ``` sed -i "/PermitRootLogin/c\PermitRootLogin yes" /etc/ssh/sshd_config ``` It will replace `#PermitRootLogin prohibit-password` with `PermitRootLogin yes` 9. Disable GUI (you must be root): 1. Execute to disable GUI: ``` systemctl set-default multi-user.target ``` * Optional. If you need to enable GUI later, you can do this with a command ``` systemctl set-default graphical.target ``` 10. Shutdown the guest Debian VM: ``` shutdown now ``` 11. In VirtualBox, enable port forwarding for the Debian VM for SSH access from your host machine, plus PIARA. 1. First, choose the Debian VM, then open *“Settings” >> “Network” >> “Advanced”* section. This will show additional network adapter options. Then, we click on “*Port Forwarding*” button. 2. Click on the plus '+' icon and add the following: | Name | Protocol | Host IP | Host Port | Guest IP | Guest Port | | ----- | -------- | ------- | --------- | -------- | ---------- | | PIARA | TCP | | 443 | | 443 | | SSH | TCP | | 2224 | | 22 | 12. Start the guest Debian VM. 13. To connect to the guest Debian via SSH use: 1. Username: root 2. Password: the user’s password you picked in step 3.e 3. IP: localhost 4. Port: 2224 5. Example command for the terminal on your host machine: ``` ssh root@localhost -p 2224 ``` 14. After that you may follow normal setup steps, and then access PIARA Lite in your host machine browser: 1.