zdm/envoy
zdm/envoy
Archived
3
Fork 0
Code Issues 22 Pull Requests Releases 1 Wiki Activity
This repository has been archived on 2021-12-05. You can view files and clone it, but cannot push or open issues or pull requests.
05ed5da41b
envoy/README.md

72 lines
2.8 KiB
Markdown
Raw Normal View History

Added README.md
2020-07-18 15:58:39 +02:00
# Envoy
Update README Split the README into a project description for users, server admins and programmers. This should be more understandable for users that are not part of the project.
2020-09-16 22:28:56 +02:00
<img src="https://git.kske.dev/repo-avatars/33-31e14133097b01b748ab361e3c3adb47" style="display: block" width="150" height="150">
Envoy is a messenger written in Java.
On this page, the project is explained for different user groups.
## Regular User
To use Envoy to join an existing server, download the client from the [release page](https://git.kske.dev/zdm/envoy/releases).
When starting it for the first time, you can register yourself at a server of your choice.
After connecting to the server, you can add other users to your contact list and send them messages.
To chat with multiple users at once, you can create a group.
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.
Link to Documentation (Wiki) in README (#110) Reviewed-on: https://git.kske.dev/zdm/envoy/pulls/110 Reviewed-by: kske <kai@kske.dev> Reviewed-by: DieGurke <maxi@kske.dev>
2020-11-27 09:36:08 +01:00
Additional info on how to use Envoy can be found [here](https://git.kske.dev/zdm/envoy/wiki) in the client section.
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 <leon@kske.dev> Reviewed-by: DieGurke <maxi@kske.dev>
2020-09-30 18:41:53 +02:00
### 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.
Update README Split the README into a project description for users, server admins and programmers. This should be more understandable for users that are not part of the project.
2020-09-16 22:28:56 +02:00
## Server Administrator
To set up an Envoy server, download the package from the release page.
Link to Documentation (Wiki) in README (#110) Reviewed-on: https://git.kske.dev/zdm/envoy/pulls/110 Reviewed-by: kske <kai@kske.dev> Reviewed-by: DieGurke <maxi@kske.dev>
2020-11-27 09:36:08 +01:00
To configure the behavior of Envoy Server, please have a look at the [documentation](https://git.kske.dev/zdm/envoy/wiki), specifically the server part.
Update README Split the README into a project description for users, server admins and programmers. This should be more understandable for users that are not part of the project.
2020-09-16 22:28:56 +02:00
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 <leon@kske.dev> Reviewed-by: DieGurke <maxi@kske.dev>
2020-09-30 18:41:53 +02:00
### 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.
Update README Split the README into a project description for users, server admins and programmers. This should be more understandable for users that are not part of the project.
2020-09-16 22:28:56 +02:00
## Programmer
Envoy is organized as a Maven project that is split into three modules.
### Client
* Sending and receiving of messages, groups, sending images and voice messages
* User interface (UI)
* Client configuration
* Advanced logging possibilities
* Tons of Events to interact with
* Detailed Javadoc to improve readability of code
### Common
* Basic datatypes
* Events sent between client and server
* Configuration API
* Logging API based on `java.util.logging`
* Envoy-specific Exception
* Useful utility classes
### Server
* Non-blocking connectivity infrastructure based on `java.nio`
* Processors to handle incoming events
* Database connectivity
Fix Typo in README (#76) Reviewed-on: https://git.kske.dev/zdm/envoy/pulls/76 Reviewed-by: kske <kai@kske.dev> Reviewed-by: DieGurke <maxi@kske.dev>
2020-10-03 14:24:03 +02:00
* Database entities
Update README Split the README into a project description for users, server admins and programmers. This should be more understandable for users that are not part of the project.
2020-09-16 22:28:56 +02:00
* Utility classes to check client version compatability and password validity
Reference in New Issue Copy Permalink