Update README.md
This commit is contained in:
parent
55d69d96c1
commit
f9adf66d3b
37
README.md
37
README.md
@ -1,3 +1,38 @@
|
||||
# Gocirc
|
||||
|
||||
a lightweight IRC server written in Golang
|
||||
a lightweight IRC server written in Golang
|
||||
|
||||
## setup
|
||||
1. cloning the repository
|
||||
```
|
||||
git clone ssh://git@git-ssh.anarchists.space:222/meer/Gocirc.git
|
||||
cd Gocirc
|
||||
```
|
||||
2. compiling the server
|
||||
```
|
||||
chmod +x build.sh
|
||||
./build.sh
|
||||
```
|
||||
|
||||
3. setting up configuration file
|
||||
example JSON config
|
||||
```JSON
|
||||
{
|
||||
"port": 6667,
|
||||
"webapiport": 7880,
|
||||
"motd": "<motd file>",
|
||||
"enableserverpassword": true,
|
||||
"serverpassword": "YOUR_SERVERPASSWORD",
|
||||
"channels": [
|
||||
{
|
||||
"channel": "#main",
|
||||
"description": "the main channel"
|
||||
}
|
||||
],
|
||||
"ops": [
|
||||
"admin"
|
||||
]
|
||||
}
|
||||
```
|
||||
change values as needed
|
||||
|
||||
Loading…
Reference in New Issue
Block a user