archat-server/README.md

26 lines
1007 B
Markdown
Raw Normal View History

2024-04-17 14:40:14 +00:00
# 🔀 Archat
*This application in in alpha stage, some features may not be working correctly or there may be bugs*
Simple P2P server (and client - for testing purposes only, client for end user is written in Electron - you can
get it [there](https://github.com/DamianLaczynski/archat-client).
2024-04-17 14:39:41 +00:00
## Starting
You can use these commands to start client and/or server:
2024-05-28 21:53:12 +00:00
```bash
go run . --run client --waddr X.X.X.X:Y --uaddr X.X.X.X:Y
# for example:
go run . --run client --waddr krzyzanowski.dev:8080 --uaddr krzyzanowski.dev:8081
2024-04-17 14:39:41 +00:00
```
Note that server should be started **before** running client.
2024-05-28 21:53:12 +00:00
```bash
go run . --run server --waddr X.X.X.X:Y --uaddr X.X.X.X:Y
# for example:
go run . --run server --waddr krzyzanowski.dev:8080 --uaddr krzyzanowski.dev:8081
2024-04-17 14:39:41 +00:00
```
2024-05-28 21:53:12 +00:00
`--waddr` and `--uaddr` options are optional, default values are respectively `:8080` and `:8081` (which is a short form of `localhost:8080` and `localhost:8081`)
`--run` option is mandatory and may take value of either `client` or `server`