Installation

Installation on Linux

Installation using Docker (Recommended)

1. Obtain the Docker image by pulling it from Docker Hub :

   docker pull vonb/pathlay:latest
   

2. Download the docker-compose.yml

3. Navigate to the directory with the downloaded docker-compose.yml files:

   cd directory
   

4. Create the “pathlay_users” directory:

   mkdir pathlay_users
   

5. Create the “pathlay_data” directory:

   mkdir pathlay_data
   

6. Build the image from docker-compose.yml:

   docker compose build
   

To run the container from this image check How to run.

Installation with .deb package

You can install PathLay from the deb package on Ubuntu-based distributions (tested on Ubuntu 22.04 and Mint Virginia):

1. Go to the directory where the deb file is located and execute the following:

   sudo dpkg -i pathlay_0.1.0-alpha.4_Ubuntu-jammy_amd64.deb
   

2. If the installer reports missing dependencies, run the following command in the same terminal to install them:

   sudo apt-get -f install
   

Apache Server Installation

1. Copy pathlay folder to your apache directory of choice, default is /var/www/html/:

   cp -r pathlay /var/www/html/
   

2. Enable apache modules:

   a2enmod cgid
   a2enmod rewrite
   a2enmod headers
   a2dissite 000-default
   systemctl reload apache2
   

3. Add the following configuration to the /etc/apache2/apache2.conf file:

   <FilesMatch "\.(ttf|otf|eot|woff|js|css|woff2)$">
     <IfModule mod_headers.c>
       Header set Access-Control-Allow-Origin "*"
     </IfModule>
   </FilesMatch>
   

4. Add the following configuration to the /etc/apache2/sites-enabled/localhost.conf file:

   ServerName localhost
   AddHandler cgi-script .cgi .pl
   
   <Directory '"$chosenPath"'>
     Header set Access-Control-Allow-Origin "*"
     Options All
     AllowOverride All
   </Directory>
   

   If the file doesn’t exist, create it. Be sure to replace “$chosenPath” with the location of the pathlay directory.

5. Setup environment variables:

   export APACHE_RUN_USER="www-data"
   export APACHE_RUN_GROUP="www-data"
   export APACHE_PID_FILE="/var/run/apache2.pid"
   export APACHE_RUN_DIR="/var/run/apache2"
   export APACHE_LOCK_DIR="/var/lock/apache2"
   export APACHE_LOG_DIR="/var/log/apache2"
   

6. Setup permissions and ownership:

   chgrp -R www-data "$chosenPath"
   chmod -R 774 "$chosenPath"
   chmod g+s "$chosenPath"
   

   Be sure to replace “$chosenPath” with the location of the pathlay directory.