aggietimed/README.md

42 lines
1.0 KiB
Markdown
Raw Normal View History

2023-02-16 16:07:18 -05:00
# AggietimeD
AggietimeD is a simple daemon service to open a SAML with selenium, steal a cookie,
2023-02-17 10:54:34 -05:00
then sit in the background listening to requests over a unix socket - making it
"easy" to write scripts to get Aggie Time data, wherever you need it!
2023-02-16 16:07:18 -05:00
2023-02-17 16:32:58 -05:00
https://user-images.githubusercontent.com/25559600/219797856-76c82934-ceb2-4562-90bc-fff2250562a1.mp4
2023-02-16 16:07:18 -05:00
## Installation
Something among the lines of:
```
sudo pacman -S chromium
2023-02-16 16:07:18 -05:00
git clone https://github.com/Simponic/aggietime-cli
cd aggietime-cli
npm i
sudo npm install -g .
2023-02-16 16:07:18 -05:00
cp .env.example .env
chmod 0700 .env
```
Then, set your A-Number and password in `.env`.
### SystemD Service
UPDATE: (no) Thanks to the SAML update to AggieTime, we require selenium for auth.
The SystemD service will not work. Instead, I suggest starting a script to watch
2023-02-28 14:51:58 -05:00
`aggietimed` with your window manager / desktop environment, restarting if it fails,
as in `watch_aggietimed.sh`.
If at some point CAS does come back, checkout the `cas-auth` branch.
2023-02-16 16:07:18 -05:00
## Usage
Look at `aggietimed -h`.