From fed84e533b1444bc1cd5aef4992c009d6f9c5bf2 Mon Sep 17 00:00:00 2001 From: Jan-Henrik Bruhn Date: Sat, 5 Aug 2023 00:22:53 +0200 Subject: [PATCH] Add readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2aff65 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# ics-adapter + +This is a tiny rust program which "proxies" .ics file URLs into a JSON format. It was developed to work with [OpenEPaperLink](https://github.com/jjwbruijn/OpenEPaperLink). + +The usage is rather simple. It is recommended to run this as a Docker container. An example docker-compose configuration might look like this: + +```yaml +version: "3" +services: + calendar: + image: ghcr.io/jhbruhn/ics-adapter:main + ports: + - "3000:3000" + restart: unless-stopped +``` + +As you can see, you only have to forward port 3000 to wherever you like, in this case port 3000. +The URL you have to enter into the OEPL Google Calendar config then looks like this: +``` +http://:3000/get?url= +``` + +With an actual .ics url, it looks like this: +``` +http://192.168.178.42:3000/get?url=https://nextcloud.net/remote.php/dav/public-calendars/whateveryolo901i230ji +``` + +# License +MIT