Skip to content
This repository has been archived by the owner on Aug 30, 2024. It is now read-only.

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alessiodam committed Jun 19, 2024
1 parent 9decd7c commit 7dc1143
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# NETCHAT Server, in Rust.

NETCHAT is a chatting server that uses TINET for authentication.
I've chosen to rewrite it in Rust for better performance and just because I like Rust.

The original server is [here](https://github.com/tkbstudios/netchatserver)

## How to use
Download the latest release from [here](https://github.com/tkbstudios/netchat-server-rust/releases) and run it.
It'll fetch the latest stable default config file if it's the first run.
Edit the config file carefully and start the server back up.

> Don't forget to allow the port you use (default: 2052) through your firewall if you have one.
## Security warning
> ⚠️ This server is still in rewrite progress, please do not expect a safe server yet, make sure to set up your firewall correctly to prevent attacks on your machine!
>
> Ideally, please only use this server if you know what you're doing.

0 comments on commit 7dc1143

Please sign in to comment.