From 4d873e657430da4dfedec993017da5294f7fddf0 Mon Sep 17 00:00:00 2001 From: Orangerot Date: Fri, 27 Dec 2024 14:38:39 +0100 Subject: doc: added README --- README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..14f92a7 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +# ic3s + +> Import your liked Talks from the 38c3 Hub in your Calendar + +## Usage (Android) + +Requirements: + +- ICSx5 +- Fossify Calendar (other Calendar Apps could also work) + +In ICSx5 subscribe to a new calendar on `+`. For the Webcal-Address type in the +url on which ic3s is hosted: + +``` +https://{HOST}/events.ics +``` + +Enable authentication and enter your credentials from the 38c3 Hub. At last +click on `subscribe`. It now should tell you that it successfully downloaded +your calendar. + +Now go to Fossify Calendar, click on the three dots on the top right and +settings. Go down to the *CalDAV* heading, click an `manage synchronised +calendars` and select the url you just entered in ICSx5 and apply. You might +need to pull down on the main screen of Fossify and ICSx5 until the loading +symbol appears to get the latest data. + +## Setup + +Start `ic3s` as a service. Here an example for freebsd: + +```sh +#!/bin/sh + +# PROVIDE: ic3s +# REQUIRE: LOGIN +# KEYWORD: shutdown + +. /etc/rc.subr + +name=ic3s +rcvar=ic3s_enable + +load_rc_config $name + +: ${ic3s_enable="NO"} +: ${ic3s_user="ic3s"} + + +command=/usr/sbin/daemon +procname=/usr/local/bin/ic3s +pidfile=/var/run/${name}/${name}.pid + +command_args="-c -p ${pidfile} ${procname}" + +run_rc_command "$1" +``` + +Put this in your `nginx.conf` +``` +server { + ... + location /events.ics { + proxy_pass http://127.0.0.1:8080$request_uri; + proxy_set_header Host $http_host; + proxy_buffering off; + } + ... +} +``` + +Have fun :) + +## License + +This project is licensed under the AGPL-3 License - see the `LICENSE` file for details -- cgit v1.2.3