zdm/envoy
zdm/envoy
Archived
3
Fork 0
Code Issues 22 Pull Requests Releases 1 Wiki Activity

Add System Requirements to README #71

Merged
kske merged 2 commits from readme-system-requirements into develop 2020-09-30 18:41:54 +02:00
Conversation 0 Commits 2 Files Changed 1 +17
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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.
delvh commented 2020-09-30 11:45:32 +02:00
Outdated
Review
Copy Link

Maybe it would be better to change the Noto emoji part into a link to download the font (with Noto emoji as the displayed text)

Maybe it would be better to change the `Noto emoji` part into a link to download the font (with Noto emoji as the displayed text)
kske commented 2020-09-30 12:51:08 +02:00
Outdated
Review
Copy Link

We could do that, however the preferred way of installing the font would be to use the distribution's package manager. As far as I know, Noto emoji is available as a package on all major Linux distributions.

We could do that, however the preferred way of installing the font would be to use the distribution's package manager. As far as I know, Noto emoji is available as a package on all major Linux distributions.
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.