Skip to content

Commit

Permalink
tweak some manual language
Browse files Browse the repository at this point in the history
  • Loading branch information
slingamn committed Jun 18, 2020
1 parent 3662698 commit 76b5344
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 13 deletions.
3 changes: 1 addition & 2 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ Copy the example config file to ircd.yaml with a command like:

$ cp default.yaml ircd.yaml

Modify the config file as you like. In particular, the `connection-throttling` and
`connection-limits` sections are working looking over and tuning for your network's needs.
Modify the config file as you like.

To generate passwords for opers and connect passwords, you can use this command:

Expand Down
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
* 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:

```sh
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 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.
Expand Down Expand Up @@ -102,14 +103,6 @@ oragono genpasswd

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

1. Register your account with `/NS REGISTER <password>`
Expand Down

0 comments on commit 76b5344

Please sign in to comment.