summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLizzy Hunt <logan.hunt@usu.edu>2023-02-28 12:49:06 -0700
committerLizzy Hunt <logan.hunt@usu.edu>2023-02-28 12:49:06 -0700
commitbc1e54ecfadd23c071edeaa3677c909b76d06008 (patch)
treec7340251bd19dae41eb429b67134c430ae21da15 /README.md
parentf45d00440188888b17a6125f656eb975bfe8a9dc (diff)
downloadaggietimed-bc1e54ecfadd23c071edeaa3677c909b76d06008.tar.gz
aggietimed-bc1e54ecfadd23c071edeaa3677c909b76d06008.zip
Use SAML, move to shell script, update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index 686b2a9..7d04460 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# AggietimeD
-AggietimeD is a simple daemon service to do some hacked CAS authentication,
+AggietimeD is a simple daemon service to open a SAML with selenium, steal a cookie,
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!
@@ -13,20 +13,28 @@ https://user-images.githubusercontent.com/25559600/219797856-76c82934-ceb2-4562-
Something among the lines of:
```
+sudo pacman -S chromium
+
git clone https://github.com/Simponic/aggietime-cli
cd aggietime-cli
npm i
sudo npm install -g .
+
cp .env.example .env
chmod 0700 .env
```
Then, set your A-Number and password in `.env`.
-Finally (optional), change the values in `aggietimed.service` and install it in
-`~/.config/systemd/user`, and enable it with
-`systemctl --user daemon-reload && systemctl enable --now --user aggietimed`.
+### 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
+`aggietimed` and restart if it fails, as in `watch_aggietimed.sh` with your window
+manager / desktop environment.
+
+If at some point CAS does come back, checkout the `cas-auth` branch.
## Usage