Due to this program's reliance on Playwright, it is only compatible with Debian/Ubuntu, macOS, and Windows.
Any malicious use of this program is not the responsibility of the author. By downloading and using this program, you agree that you, and any other parties involved in your implementation of this program, are entirely responsible for its use/misuse.
Please do not do stupid shit. The goal of this program is to provide an alternate method of room access as a quality of life improvement. No malicious intent exists behind the development of this program.
This will install the openDoorServer
as well.
Install dependencies and run the install.sh
script:
apt update && apt install -y sudo curl && curl -sSL https://raw.githubusercontent.com/dekay7/CBORDDoorUnlock/main/install.sh | bash
Rename example.env
to .env
using the following command:
sudo mv example.env .env
Using nano
, vim
, or any other text editor, assign the following variables in .env
to the appropriate values:
- For
USERNAME=
, replace "oktausername1" with your OKTA username - For
PASSWORD=
, replace "okta_p@ssword" with your OKTA password
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)
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
After configuring the .env
file, to use the python script, simply run it.
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.
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
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
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.