Home

Welcome to the HallPassProj wiki!

1. Setup the QR codes:
   First, you need to look at example.link to get a template on what your links should look like. Then you need to make a unique QR code for every room in your building containing a unique page=# which will be registered to the room number upon the first scan and stored in the servers registred_qrid folder along with the registered room number.
   

2. Setup server:
It is possible to use the built-in web server of PHP just issue the command 'php -S :8080 -t ' then it should be running!
The dependencies that are needed are listed in the dependencies file. install these packages using your distro's package manager.

3. Use the config file:
The config.ini file is located in the root of the VirtualPass DIR under /config/config.ini
You can set the administrator portal username and password email functionality custom domain name insecure general logs located in /src/log/inout.log
This file is located behind the src (the src dir is designed to act as the website root so that the webserver cannot access the config file but the PHP files can).

  Config options:
  To enable the generation of user Emails set
  em_enable=0
  to
  em_enable=1
  This will generate email.html in the human_info/user_id/ folder

  To change the administrator portal username and password change the config option:
  from
  admin_uname=admin
  admin_passwd=admin
  to
  admin_uname=your_username_here
  admin_passwd=your_password_here

  To enable the generation of insecure user position logs change this config option:
  from
  enable_insecure_general_logs=0
  to
  enable_insecure_general_logs=1
  This will generate log/inout.log accessable via a button in the admin portal also accessable to anyone.

  If you're having trouble with the server not setting your domain name correctly change this config option:
  from
  overide_automatic_domain_name=0
  domain_name=
  to
  overide_automatic_domain_name=1
  domain_name=your_domain_here

4. human_info folder: this folder stores the user's activity in HTML files accessible via the administrator portal. This folder contains the directory with the user's unique ID (known as phid) along with an index with each level of info including the date class and hour.

5. registered_phid folder: this is where the user's file is written and stored in the format of an ini file. This can be a bit buggy at times if the user already has a cookie named "phid". This file also contains the HTML used for the user's email.

6. registerd_qrids folder: This folder contains the QR code IDs and the room numbers themselves

7. usr_pre_fls folder: The contents of this folder are used to make "student.php" in the administrator portal to check for the admin cookie same as in every other PHP file in the admin portal. If this folder is removed student.php will be insecure and allow anyone to view all the user info.