Skip to content

Commit

Permalink
update references to oragono.yaml to reflect new name of default.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
slingamn committed Jun 14, 2020
1 parent c0f020d commit a6e2b5a
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ archives:
- README
- CHANGELOG.md
- oragono.motd
- oragono.yaml
- default.yaml
- conventional.yaml
- docs/*
- languages/*.yaml
Expand Down
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ ADD . /go/src/github.com/oragono/oragono/

# modify default config file so that it doesn't die on IPv6
# and so it can be exposed via 6667 by default
run sed -i 's/^\(\s*\)\"127.0.0.1:6667\":.*$/\1":6667":/' /go/src/github.com/oragono/oragono/oragono.yaml
run sed -i 's/^\s*\"\[::1\]:6667\":.*$//' /go/src/github.com/oragono/oragono/oragono.yaml
run sed -i 's/^\(\s*\)\"127.0.0.1:6667\":.*$/\1":6667":/' /go/src/github.com/oragono/oragono/default.yaml
run sed -i 's/^\s*\"\[::1\]:6667\":.*$//' /go/src/github.com/oragono/oragono/default.yaml

# make sure submodules are up-to-date
RUN git submodule update --init
Expand Down Expand Up @@ -40,7 +40,7 @@ EXPOSE 6667/tcp 6697/tcp
RUN mkdir -p /ircd-bin
COPY --from=build-env /go/bin/oragono /ircd-bin
COPY --from=build-env /go/src/github.com/oragono/oragono/languages /ircd-bin/languages/
COPY --from=build-env /go/src/github.com/oragono/oragono/oragono.yaml /ircd-bin/oragono.yaml
COPY --from=build-env /go/src/github.com/oragono/oragono/default.yaml /ircd-bin/default.yaml

COPY distrib/docker/run.sh /ircd-bin/run.sh
RUN chmod +x /ircd-bin/run.sh
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ test:
./.check-gofmt.sh

smoke:
oragono mkcerts --conf ./oragono.yaml || true
oragono run --conf ./oragono.yaml --smoke
oragono mkcerts --conf ./default.yaml || true
oragono run --conf ./default.yaml --smoke
2 changes: 1 addition & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ assorted IRCv3 support.

Copy the example config file to ircd.yaml with a command like:

$ cp oragono.yaml ircd.yaml
$ 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.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ To go through the standard installation, download the latest release from this p
Extract it into a folder, then run the following commands:

```sh
cp oragono.yaml ircd.yaml
cp default.yaml ircd.yaml
vim ircd.yaml # modify the config file to your liking
oragono mkcerts
```
Expand Down Expand Up @@ -84,7 +84,7 @@ You'll need an [up-to-date distribution of the Go language for your OS and archi

## Configuration

The default config file [`oragono.yaml`](oragono.yaml) helps walk you through what each option means and changes. The configuration's intended to be sparse, so if there are options missing it's either because that feature isn't written/configurable yet or because we don't think it should be configurable.
The default config file [`default.yaml`](default.yaml) helps walk you through what each option means and changes.

You can use the `--conf` parameter when launching Oragono to control where it looks for the config file. For instance: `oragono run --conf /path/to/ircd.yaml`. The configuration file also stores where the log, database, certificate, and other files are opened. Normally, all these files use relative paths, but you can change them to be absolute (such as `/var/log/ircd.log`) when running Oragono as a service.

Expand Down
2 changes: 1 addition & 1 deletion conventional.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ server:
# This version of the config provides a public plaintext listener on
# port 6667 for testing and compatibility with legacy applications.
# We recommend disabling this listener in a production setting
# and replacing it with loopback-only listeners (see oragono.yaml):
# and replacing it with loopback-only listeners (see default.yaml):
":6667":

# The standard SSL/TLS port for IRC is 6697. This will listen on all interfaces:
Expand Down
2 changes: 1 addition & 1 deletion distrib/docker/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ cd /ircd

# make config file
if [ ! -f "/ircd/ircd.yaml" ]; then
awk '{gsub(/path: languages/,"path: /ircd-bin/languages")}1' /ircd-bin/oragono.yaml > /tmp/ircd.yaml
awk '{gsub(/path: languages/,"path: /ircd-bin/languages")}1' /ircd-bin/default.yaml > /tmp/ircd.yaml

# change default oper passwd
OPERPASS=$(< /dev/urandom tr -dc _A-Z-a-z-0-9 | head -c20)
Expand Down
4 changes: 2 additions & 2 deletions docs/MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ To get started with Oragono on Windows:

1. Make sure you have the [latest release](https://github.com/oragono/oragono/releases/latest) downloaded.
1. Extract the zip file to a folder.
1. Copy and rename `oragono.yaml` to `ircd.yaml`.
1. Copy and rename `default.yaml` to `ircd.yaml`.
1. Open up `ircd.yaml` using any text editor, and then save it once you're happy.
1. Open up a `cmd.exe` window, then `cd` to where you have Oragono extracted.
1. Run `oragono.exe mkcerts` if you want to generate new self-signed SSL/TLS certificates (note that you can't enable STS if you use self-signed certs).
Expand All @@ -111,7 +111,7 @@ To get started with Oragono on macOS, Linux, or on a Raspberry Pi:

1. Make sure you have the [latest release](https://github.com/oragono/oragono/releases/latest) for your OS/distro downloaded.
1. Extract the tar.gz file to a folder.
1. Copy and rename `oragono.yaml` to `ircd.yaml`.
1. Copy and rename `default.yaml` to `ircd.yaml`.
1. Open up `ircd.yaml` using any text editor, and then save it once you're happy.
1. Open up a Terminal window, then `cd` to where you have Oragono extracted.
1. Run `./oragono mkcerts` if you want to generate new self-signed SSL/TLS certificates (note that you can't enable STS if you use self-signed certs).
Expand Down

0 comments on commit a6e2b5a

Please sign in to comment.