Skip to content

Commit b54c8de

Browse files
committed
Remove old names for things now the v3 docs are gone.
1 parent 8c74aa5 commit b54c8de

10 files changed

Lines changed: 33 additions & 33 deletions

File tree

docs/4/change-log-dev.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,13 @@ This page lists changes which have happened between development releases. For th
104104

105105
- Added `<options:maskinlist>` to allow saving the full user mask of a list mode setter.
106106

107-
- Added `<sslinfo:welcomemessage>` to control sending the SSL connection information message to connecting users.
107+
- Added `<sslinfo:welcomemessage>` to control sending the TLS connection information message to connecting users.
108108

109-
- Added a zero-parameter version of `/SSLINFO` to view your own SSL certificate information.
109+
- Added a zero-parameter version of `/SSLINFO` to view your own TLS certificate information.
110110

111-
- Added checks to help users migrate from v2-style SSL config.
111+
- Added checks to help users migrate from v2-style TLS config.
112112

113-
- Added support for multiple SSL fingerprints to allow migrating between hash algorithms.
113+
- Added support for multiple TLS fingerprints to allow migrating between hash algorithms.
114114

115115
- Added the `$address` variable to the alias module.
116116

docs/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ Server operators do not automatically get channel privileges by default. You can
5959

6060
- Giving yourself channel operator status using [the samode module](/4/modules/samode).
6161

62-
### Why does my server tell me "An unexpected TLS packet was received" or "error:1408F10B:SSL routines:ssl3_get_record:wrong version number:ssl/record/ssl3_record.c" when I try to connect using SSL/TLS?
62+
### Why does my server tell me "An unexpected TLS packet was received" or "error:1408F10B:SSL routines:ssl3_get_record:wrong version number:ssl/record/ssl3_record.c" when I try to connect using TLS?
6363

64-
You are trying to connect using TLS (SSL) but your server is not configured to listen for TLS (SSL) connections.
64+
You are trying to connect using TLS but your server is not configured to listen for TLS connections.
6565

66-
Check that you have a TLS (SSL) module loaded and that your bind tag has the name of a TLS (SSL) profile in `<bind:ssl>`.
66+
Check that you have a TLS module loaded and that your bind tag has the name of a TLS profile in `<bind:ssl>`.
6767

6868
If you're using v3.7.0 or newer you can also use the `inspircd-testssl` script to help diagnose this issue.
6969

docs/server/messages/capab.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ extra: |-
3838
CHANMAX | 64 | [**1205**] The maximum number of channels a user can normally join.
3939
EXTBANS | ABCDEFabcdef | [**1205**] The extended bans that exist on the remote server.
4040
GLOBOPS | 1 | [**1205**] Whether the server supports the GLOBOPS extension.
41-
IDENTMAX | 10 | [**1205**] The maximum length of a username (ident).
41+
IDENTMAX | 10 | [**1205**] The maximum length of a username.
4242
MAXAWAY | 200 | The maximum length of an away message.
4343
MAXCHANNEL | 64 | [**1206+**] The maximum number of channels a user can normally join.
4444
MAXHOST | 64 | The maximum length of a hostname.
@@ -49,7 +49,7 @@ extra: |-
4949
MAXQUIT | 255 | The maximum length of a quit message.
5050
MAXREAL | 128 | The maximum length of a real name.
5151
MAXTOPIC | 307 | The maximum length of a channel topic.
52-
MAXUSER | 10 | [**1206+**] The maximum length of a username (ident).
52+
MAXUSER | 10 | [**1206+**] The maximum length of a username.
5353
NICKMAX | 30 | [**1205**] The maximum length of a nickname.
5454
5555
If provided the extban-type field can be set to one of the following values:

docs/server/messages/fmode.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ syntax:
99
text:
1010
- <channel> <ts> <modes> [<mode-parameters>]+
1111
description: |-
12-
Changes the username (ident) of the source user to the specified value.
12+
Changes the username of the source user to the specified value.
1313
example:
1414
- description: |-
1515
Sets channel modes `n` (noextmsg) and `l` (limit) on #chan

docs/server/messages/fname.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ name: FNAME
22
source: uid
33
syntax:
44
fields:
5-
realname: The new real name (gecos) of the source user.
5+
realname: The new real name of the source user.
66
text:
77
- <realname>
88
description: |-
9-
Changes the real name (gecos) of the source user to the specified value.
9+
Changes the real name of the source user to the specified value.
1010
example:
1111
- description: |-
12-
Changes the real name (gecos) of 36DAAAAAA to "Wibble Wobble"
12+
Changes the real name of 36DAAAAAA to "Wibble Wobble"
1313
text: |-
1414
:36DAAAAAA FNAME :Wibble Wobble

docs/server/messages/ftopic.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ syntax:
1010
text:
1111
- <channel> <channel-ts> <topic-ts> [<setter>] :<new-topic>
1212
description: |-
13-
Changes the username (ident) of the source user to the specified value.
13+
Changes the username of the source user to the specified value.
1414
example:
1515
- description: |-
1616
User 36DAAAAAA changing the topic of #chan

docs/server/messages/nick.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ syntax:
77
text:
88
- <nick> <ts>
99
description: |-
10-
Changes the username (ident) of the source user to the specified value.
10+
Changes the username of the source user to the specified value.
1111
example:
1212
- description: |-
1313
Changes the nickname of 36DAAAAAA to Sadie

docs/tutorials/enable-tls.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: How to enable TLS (SSL) on your IRC network
2+
title: How to enable TLS on your IRC network
33
---
44

55
!!! note ""
66
This page is a work in progress. If you find any part of it to be unclear [please open an issue](https://github.com/inspircd/docs/issues/new).
77

8-
## How to enable TLS (SSL) on your IRC network
8+
## How to enable TLS on your IRC network
99

10-
### Building a TLS (SSL) module
10+
### Building a TLS module
1111

12-
If you are building from source you will need to enable a TLS (SSL) module. Your current options are:
12+
If you are building from source you will need to enable a TLS module. Your current options are:
1313

1414
- [ssl_gnutls](/4/modules/ssl_gnutls) &mdash; requires [the GnuTLS library](https://gnutls.org).
1515
- [ssl_openssl](/4/modules/ssl_openssl) &mdash; requires [the OpenSSL library](https://www.openssl.org).
@@ -18,24 +18,24 @@ You will also need to install [pkg-config](https://www.freedesktop.org/wiki/Soft
1818

1919
If you have these installed before running `./configure` then the appropriate modules will be enabled automatically. If you are installing after building InspIRCd or they were not automatically enabled for some reason you can build them with `./configure --enable-extras module-name-here` and then `make install`.
2020

21-
### Acquiring a TLS (SSL) certificate and key
21+
### Acquiring a TLS certificate and key
2222

23-
If you have not already acquired a TLS (SSL) certificate and key you will need to do so. The recommended method of acquiring these files is an ACME client like [Certbot](https://certbot.eff.org/). You can acquire this from either your system package manager or from pip. See [the Certbot installation instructions](https://certbot.eff.org/instructions?ws=other&os=pip) for more information on how to install and configure Certbot. Alternatives to Certbot include [Dehydrated](https://github.com/dehydrated-io/dehydrated), [acme.sh](https://github.com/acmesh-official/acme.sh), and [many others](https://letsencrypt.org/docs/client-options/).
23+
If you have not already acquired a TLS certificate and key you will need to do so. The recommended method of acquiring these files is an ACME client like [Certbot](https://certbot.eff.org/). You can acquire this from either your system package manager or from pip. See [the Certbot installation instructions](https://certbot.eff.org/instructions?ws=other&os=pip) for more information on how to install and configure Certbot. Alternatives to Certbot include [Dehydrated](https://github.com/dehydrated-io/dehydrated), [acme.sh](https://github.com/acmesh-official/acme.sh), and [many others](https://letsencrypt.org/docs/client-options/).
2424

25-
InspIRCd ships with a script called `deploy-ssl.sh` that you can customise for use as a post-deploy hook to automatically reload your TLS (SSL) profiles when your TLS (SSL) certificate and key are updated. Generally this should not require much tweaking but you should check it just in case. If you are using this you should also make sure that your IRC server has [the sslrehashsignal module](/4/modules/sslrehashsignal) loaded (see below).
25+
InspIRCd ships with a script called `deploy-ssl.sh` that you can customise for use as a post-deploy hook to automatically reload your TLS profiles when your TLS certificate and key are updated. Generally this should not require much tweaking but you should check it just in case. If you are using this you should also make sure that your IRC server has [the sslrehashsignal module](/4/modules/sslrehashsignal) loaded (see below).
2626

27-
### Loading and configuring a TLS (SSL) module
27+
### Loading and configuring a TLS module
2828

29-
First you must add a `<module>` tag for the name of the TLS (SSL) module you want to use. e.g. to use the `ssl_gnutls` module use `<module name="ssl_gnutls">`.
29+
First you must add a `<module>` tag for the name of the TLS module you want to use. e.g. to use the `ssl_gnutls` module use `<module name="ssl_gnutls">`.
3030

31-
Once this is added you need to create a TLS (SSL) profile. The syntax of these depend on the TLS (SSL) module that you are using.
31+
Once this is added you need to create a TLS profile. The syntax of these depend on the TLS module that you are using.
3232

3333
- [ssl_gnutls](/4/modules/ssl_gnutls#sslprofile)
3434
- [ssl_openssl](/4/modules/ssl_openssl#sslprofile)
3535

3636
You should note down the value of `<sslprofile:name>` as you will need this in the next step.
3737

38-
Now you have a TLS (SSL) profile you can create [a `<bind>` tag](/4/configuration/#bind) with the `sslprofile` key set to the name you specified in `<sslprofile:name>`. This might vary depending on your configuration but it will look something like this:
38+
Now you have a TLS profile you can create [a `<bind>` tag](/4/configuration/#bind) with the `sslprofile` key set to the name you specified in `<sslprofile:name>`. This might vary depending on your configuration but it will look something like this:
3939

4040
```xml
4141
<bind address="*"
@@ -44,18 +44,18 @@ Now you have a TLS (SSL) profile you can create [a `<bind>` tag](/4/configuratio
4444
type="clients">
4545
```
4646

47-
Once you have added this you should restart your server or run `/REHASH` followed by `/REHASH -ssl` as a server operator to reload both your configuration and your TLS (SSL) profiles.
47+
Once you have added this you should restart your server or run `/REHASH` followed by `/REHASH -ssl` as a server operator to reload both your configuration and your TLS profiles.
4848

4949
### Diagnosing issues
5050

5151
InspIRCd ships with a tool named `inspircd-testssl` on binary installations and `./tools/testssl` on source installations. You can run this to diagnose any problems with your server configuration.
5252

5353
### Common mistakes
5454

55-
In older versions of InspIRCd you configured TLS (SSL) by setting `<bind:ssl>` to the name of a TLS (SSL) module and configuring the TLS (SSL) certificate and key in `<gnutls>`, `<mbedtls>`, or `<openssl>`. Configuring TLS (SSL) in this way is deprecated and will not work if you have a TLS (SSL) profile defined. It is strongly recommended that you do not use this method as it has been removed in the development branch.
55+
In older versions of InspIRCd you configured TLS by setting `<bind:ssl>` to the name of a TLS module and configuring the TLS certificate and key in `<gnutls>`, `<mbedtls>`, or `<openssl>`. Configuring TLS in this way is deprecated and will not work if you have a TLS profile defined. It is strongly recommended that you do not use this method as it has been removed in the development branch.
5656

57-
In v3 TLS (SSL) certificates are not reloaded by default on a regular config rehash. You need to use `/REHASH -ssl` to reload TLS (SSL) certificates or load [the sslrehashsignal module](/4/modules/sslrehashsignal) and send SIGUSR1 to your IRC server. You can also set `<gnutls onrehash="yes">`, `<mbedtls onrehash="yes">`. or `<openssl onrehash="yes>` to reload your TLS (SSL) certificates on rehash.
57+
In v3 TLS certificates are not reloaded by default on a regular config rehash. You need to use `/REHASH -ssl` to reload TLS certificates or load [the sslrehashsignal module](/4/modules/sslrehashsignal) and send SIGUSR1 to your IRC server. You can also set `<gnutls onrehash="yes">`, `<mbedtls onrehash="yes">`. or `<openssl onrehash="yes>` to reload your TLS certificates on rehash.
5858

59-
Certbot provides multiple TLS (SSL) certificate files. If you are getting client errors about missing intermediary certificates you have probably used `cert.pem` as your certificate instead of `fullchain.pem`.
59+
Certbot provides multiple TLS certificate files. If you are getting client errors about missing intermediary certificates you have probably used `cert.pem` as your certificate instead of `fullchain.pem`.
6060

6161
InspIRCd ships with the `inspircd-genssl` tool that allows you to generate a self-signed certificate and key. You can use these for testing your server but you should not use them in production as they do not provide much security over using a plaintext connection and do not work with all clients. This tool will be removed in a future release.

docs/tutorials/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ title: Tutorials
88

99
## Tutorials
1010

11-
- [How to enable TLS (SSL) on your IRC network](/tutorials/enable-tls)
11+
- [How to enable TLS on your IRC network](/tutorials/enable-tls)
1212
- [How to install and configure InspIRCd](/4/installation)
1313
- [How to prevent spam on your IRC network](/tutorials/prevent-spam)

docs/tutorials/prevent-spam.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ If you want a softer option you can also use [the muteban module](/4/modules/mut
6060
/MODE #channel +b mute:unauthed:*!*@*.linodeusercontent.com
6161
```
6262

63-
### Require TLS (SSL)
63+
### Require TLS
6464

65-
Some IRC spambots are very poorly written and do not support TLS (SSL). You can break these bots by requiring TLS (SSL) on your IRC network. This also has the benefit of preventing your users from having their chats snooped on. To do this you can either disable your plaintext listeners entirely or better still use the IRCv3 STS (Strict Transport Security) feature to redirect users of modern clients to your TLS (SSL) port.
65+
Some IRC spambots are very poorly written and do not support TLS. You can break these bots by requiring TLS on your IRC network. This also has the benefit of preventing your users from having their chats snooped on. To do this you can either disable your plaintext listeners entirely or better still use the IRCv3 STS (Strict Transport Security) feature to redirect users of modern clients to your TLS port.
6666

6767
```xml
6868
# These can go anywhere in your configuration

0 commit comments

Comments
 (0)