From d9953a810b1234c8393fa6141cd84c52301d456c Mon Sep 17 00:00:00 2001 From: Hannes Braun Date: Tue, 26 Oct 2021 17:58:40 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EHome=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Home.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Home.md b/Home.md index 1caa9af..338f8f4 100644 --- a/Home.md +++ b/Home.md @@ -1,9 +1,9 @@ ## Welcome to the "TheCitadelofRicks" wiki! -"TheCitadelofRicks" (tcor for short) is a API for timetable and mensa data of the HS Offenburg. -It's build with spring and kotlin. +"TheCitadelofRicks" (tcor for short) is an API for timetable and mensa data of the HS Offenburg. +It's built with Spring and Kotlin. -tcor currently provides 3 request options. /courses which will return a array "courses" with all currently available courses at the HS Offenburg, /timetable?courseName={coursename}&week={week} which will return a given weeks timetable for a given course and /mensamenu which will return the menu of the mensa for the current and next week. +tcor currently provides 3 request options. /courseList which will return an array "courses" with all currently available courses at the HS Offenburg, /timetable?courseName={coursename}&week={week} which will return a given weeks timetable for a given course and /mensamenu which will return the menu of the mensa for the current and next week. Since software version 1.2.0 tcor supports cachet api reporting. @@ -29,7 +29,7 @@ Here is an example of the config.xml: ``` ### Docker -To build tcor as docker image, execute `docker build -t tcor:latest .` If the build was successfull, +To build tcor as docker image, execute `docker build -t tcor:latest .` If the build was successful, you can run tcor via `docker run -v {path-to-the-tcor-folder}:/tcor -p 8080:8080 tcor`. You can also use the tcor docker image from dockerhub, see https://hub.docker.com/r/mosadxyz/tcor. For the docker image to work properly you need to copy a java keystore into the tcor folder (right besides the config.xml file). Also make sure the file is named "cacerts".