CBORD MobileID/CardAdmin Door Opener

Due to this program's reliance on Playwright, the recommended deployment method is through Docker. The Native (Manual) installation is only compatible with Debian/Ubuntu, macOS, and Windows.

Docker Installation (Linux, macOS, Windows):

Make sure you have Docker already installed on your device (that will be acting as the server).
Download CBORD_Docker.zip from the latest release. To do this from the command line, copy the link address of CBORD_Docker.zip and use the following command (be sure to replace paste_copied_link_here with the copied link):

mkdir open_door && cd open_door
wget paste_copied_link_here

Then, unzip the binary using the following command:

unzip CBORD_Docker.zip

Using nano, vim, or any other text editor, assign the following variables in .env to the appropriate values:

• For LOGINUSER=, replace "oktausername1" with your OKTA username
• For PASS=, replace "okta_p@ssword" with your OKTA password
• For CBORDURL=, replace "https://cardadmin.iit.edu" with the login address for your CardAdmin interface

Open a terminal in the same directory as the docker-compose.yml file and install using the following command:

docker compose up --build -d

If you choose to change the environment variables later, make your edits, save, then use the command:

docker compose down && docker compose up -d

Once complete, go to the Apple Shortcut section to install the shortcut to your iPhone.

Optional:

If you would like receive emails every time your door is unlocked, assign the following variables in .env to the appropriate values:

• For SENDER=, replace "senderemail@gmail.com" with a sender Gmail to receive door unlock notifications from
• For APPPASS=, replace "aaaa bbbb cccc dddd" with:
  • Your Gmail password (if you ARE NOT using 2FA)
  • A generated app password (if you ARE using 2FA)

Native (Manual) Installation (Debian/Ubuntu, macOS, Windows):

Download CBORD_Manual.zip from the latest release. Using nano, vim, or any other text editor, assign the following variables in .env to the appropriate values:

• For LOGINUSER=, replace "oktausername1" with your OKTA username
• For PASS=, replace "okta_p@ssword" with your OKTA password
• For CBORDURL=, replace "https://cardadmin.iit.edu" with the login address for your CardAdmin interface

Optional:

If you would like receive emails every time your door is unlocked, assign the following variables in .env to the appropriate values:

• For SENDER=, replace "senderemail@gmail.com" with a sender Gmail to receive door unlock notifications from
• For APPPASS=, replace "aaaa bbbb cccc dddd" with:
  • Your Gmail password (if you ARE NOT using 2FA)
  • A generated app password (if you ARE using 2FA)

Manual Service Configuration:

Using nano, vim, or any other text editor, edit "/root/open_door/openDoorServer.py" in openDoor.service to the file path of openDoorServer.py.

Move openDoor.service to /etc/systemd/system using the following command:

sudo mv openDoor.service /etc/systemd/system

Allow openDoor.service to run on startup using the following command:

sudo systemctl enable openDoor.service

Start openDoor.service using the following command:

sudo systemctl start openDoor.service

Check whether openDoor.service is running using the following command:

sudo systemctl status openDoor.service

Opening Your Door:

If using openDoor.py:

After configuring the .env file, to use the python script, simply run it.

If using openDoor.service:

After configuration and service configuration, as long as openDoor.service is enabled and running, you may visit the local IP of the host server, followed by the port, and the subdirectory.
For example, http://192.168.0.50:5000/open_sesame.

If using openDoorCookies.py:

Using nano, vim, or any other text editor, replace the following values for their appropriate keys with the associated cookies:

• For "PHPSESSID":, replace "php_sess_id" with the appropriate cookie value

Apple Shortcut:

Download the unlockDoor.shortcut file to your iOS device using/clicking the QR code or link below:

Apple Shortcut Download Link: https://raw.githubusercontent.com/dekay7/CBORDDoorUnlock/main/unlockDoor.shortcut

Shortcut Configuration:

When prompted to enter a URL, replace the default value, http://192.168.0.50:5000/open_sesame, with the local IP of the host server, followed by the port, and the subdirectory.