Update readmes, make slight code change
This commit is contained in:
parent
d839652916
commit
f69a3fb599
10
README.md
10
README.md
|
@ -1,8 +1,8 @@
|
|||
# Chookpen - A simple messaging service
|
||||
# Chookchat - A simple messaging service
|
||||
|
||||
## What is Chookpen?
|
||||
## What is Chookchat?
|
||||
|
||||
Chookpen is a lightweight, secure-ish chat server implementation focused on simplicity and real-time communication. It features user authentication, persistent message history, real-time updates via WebSockets, and supports both traditional HTTP endpoints and WebSocket connections for flexible integration. It uses very little resources on a system, often using a maximum of 20mb. Chookpen is BETA SOFTWARE, and MAY BE BUGGY! Don't expect too much.
|
||||
Chookchat is a lightweight, secure-ish chat server implementation focused on simplicity and real-time communication. It features user authentication, persistent message history and real-time updates via WebSockets. It uses very little resources on a system, often using a maximum of 20mb. Chookpen is BETA SOFTWARE, and MAY BE BUGGY! Don't expect too much.
|
||||
|
||||
## A guide to this repository
|
||||
|
||||
|
@ -25,3 +25,7 @@ The build tool for compiling Chookpen. It just works!
|
|||
The language Chookpen is coded in. How else does it work?
|
||||
|
||||
### [OpenJDK](https://openjdk.org)
|
||||
|
||||
The best way to run Chookpen. Free and open source!
|
||||
|
||||
There's also all the other various libraries I use (and these other libraries use) so check the code for those!
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Chookpen Server
|
||||
# Chookchat Server
|
||||
|
||||
Key features:
|
||||
- Real-time messaging with WebSocket support
|
||||
|
@ -41,7 +41,7 @@ To create a distribution (you don't need to run gradle build, it will do that fo
|
|||
./gradlew installDist
|
||||
```
|
||||
|
||||
To run the server, create the files `chatHistory` and `userDatabase` in the directory you're running it from, then run the script to start Chookpen.
|
||||
To run the server, create the files `chatHistory` and `userDatabase` in the directory you're running it from, then run the script to start Chookchat.
|
||||
|
||||
## API Documentation
|
||||
|
||||
|
@ -84,7 +84,7 @@ Connect to `/api/websocket` for real-time updates.
|
|||
|
||||
## Setting up HTTPS with Caddy
|
||||
|
||||
Caddy provides automatic HTTPS and serves as a reverse proxy for your Chookpen server. [Download from caddyserver.com](https://caddyserver.com/download) or from your Linux/BSD/Illumos/Haiku/TempleOS/whatever distribution's package manager.
|
||||
Caddy provides automatic HTTPS and serves as a reverse proxy for your Chookchat server. [Download from caddyserver.com](https://caddyserver.com/download) or from your Linux/BSD/Illumos/Haiku/TempleOS/whatever distribution's package manager.
|
||||
|
||||
1. Create a `Caddyfile` in your server directory:
|
||||
```
|
||||
|
|
|
@ -387,9 +387,17 @@ fun main(args: Array<String>) {
|
|||
}
|
||||
}
|
||||
.start(7070)
|
||||
try {
|
||||
if (args[0] == "-i") {
|
||||
println("Type a command for the server")
|
||||
while (1 == 1) {
|
||||
println(handleServerCommand(readln()))
|
||||
}
|
||||
} else {
|
||||
println("Interactive mode disabled, add -i to enable")
|
||||
}
|
||||
} catch (error: Exception) {
|
||||
println("Interactive mode disabled, add -i to enable")
|
||||
}
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user