GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-22 03:49:27 +01:00
Code Issues Projects Releases Wiki Activity

tweak some manual language

Browse Source
This commit is contained in:
Shivaram Lingamneni 2020-06-18 13:56:47 -04:00
parent 3662698f87
commit 76b534476a
2 changed files with 5 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README
View File

@ -25,8 +25,7 @@ Copy the example config file to ircd.yaml with a command like:
$ cp default.yaml ircd.yaml $ cp default.yaml ircd.yaml
Modify the config file as you like. In particular, the `connection-throttling` and Modify the config file as you like.
`connection-limits` sections are working looking over and tuning for your network's needs.
To generate passwords for opers and connect passwords, you can use this command: To generate passwords for opers and connect passwords, you can use this command:

15
README.md
View File

@ -42,16 +42,17 @@ If you want to take a look at a running Oragono instance or test some client cod
* [IRCv3 support](https://ircv3.net/software/servers.html) * [IRCv3 support](https://ircv3.net/software/servers.html)
* a heavy focus on developing with [specifications](https://oragono.io/specs.html) * a heavy focus on developing with [specifications](https://oragono.io/specs.html)
## Installation ## Quick start guide
To go through the standard installation, download the latest release from this page: https://github.com/oragono/oragono/releases/latest Download the latest release from this page: https://github.com/oragono/oragono/releases/latest
Extract it into a folder, then run the following commands: Extract it into a folder, then run the following commands:
```sh ```sh
cp default.yaml ircd.yaml cp default.yaml ircd.yaml
vim ircd.yaml # modify the config file to your liking vim ircd.yaml # modify the config file to your liking
oragono mkcerts oragono mkcerts
oragono run # server should be ready to go!
``` ```
**Note:** See the [productionizing guide in our manual](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#productionizing) for recommendations on how to run a production network, including obtaining valid TLS certificates. **Note:** See the [productionizing guide in our manual](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#productionizing) for recommendations on how to run a production network, including obtaining valid TLS certificates.
@ -102,14 +103,6 @@ oragono genpasswd
With this, you receive a blob of text which you can plug into your configuration file. With this, you receive a blob of text which you can plug into your configuration file.
## Running
After this, running the server is easy! Simply run the below command and you should see the relevant startup information pop up.
```sh
oragono run
```
### How to register a channel ### How to register a channel
1. Register your account with `/NS REGISTER <password>` 1. Register your account with `/NS REGISTER <password>`