From f5bfb73abe4d8f686678bfbb69652f240392ce37 Mon Sep 17 00:00:00 2001 From: kske Date: Wed, 30 Sep 2020 18:41:53 +0200 Subject: [PATCH] Add System Requirements to README (#71) Add link to Noto emoji in README Add system requirements to README Reviewed-on: https://git.kske.dev/zdm/envoy/pulls/71 Reviewed-by: delvh Reviewed-by: DieGurke --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 520f6c8..4091e77 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,29 @@ If you want to transfer a file to another user, you can attach it to a message. On the settings page some convenience features can be configured, as well as the color theme. +### System requirements + +To run Envoy, you have to install a Java Runtime Environment (JRE) of at least version 11. +You can download an open source implementation from [here](https://jdk.java.net/15/). + +If you are running a Linux distribution, make sure that an emoji font like [Noto emoji](https://github.com/googlefonts/noto-emoji) is installed. +Most major Linux distributions like Debian, Arch and Gentoo have a Noto emoji package available inside their package repositories. + ## Server Administrator To set up an Envoy server, download the package from the release page. Because the project lacks external documentation for the moment, please refer to the Javadoc inside the source code to configure your Envoy instance. +### System requirements + +To run Envoy server, you have to install a JRE as mentioned above, as well as a database. +In development, PostgreSQL is used, which you can download from [here](https://www.postgresql.org/download/). + +Look at the file `META-INF/persistence.xml` inside `envoy-server.jar` for the database configuration. + +After creating a database and configuring the credentials, the server will initialize the necessary tables automatically. + ## Programmer Envoy is organized as a Maven project that is split into three modules.