Skip to content

Commit a8e8f99

Browse files
committed
Mark the starttls module as deprecated.
1 parent b187cf8 commit a8e8f99

2 files changed

Lines changed: 32 additions & 1 deletion

File tree

docs/3/modules/starttls.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/3/modules/starttls.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: starttls
2+
3+
description: |-
4+
This module provides the IRCv3 `tls` client capability.
5+
6+
configuration:
7+
- name: starttls
8+
description: |-
9+
The `<starttls>` tag defines settings about how the starttls module should behave. This tag can only be defined once.
10+
attributes:
11+
- name: provider
12+
type: Text
13+
required: false
14+
default: null
15+
description: |-
16+
The name of the TLS profile to use for STARTTLS clients.
17+
details: ""
18+
example: |-
19+
```xml
20+
<starttls provider="gnutls">
21+
```
22+
23+
client_caps:
24+
- name: '[tls](https://ircv3.net/specs/extensions/tls.html)'
25+
description: |-
26+
Allows plaintext connections to upgrade to TLS.

docs/4/modules/starttls.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
name: starttls
22

3+
introduction: |-
4+
!!! warning ""
5+
This module is deprecated and will be removed in the next major version of InspIRCd.
6+
7+
This capability has been deprecated by IRCv3. It is recommended that you use [the ircv3_sts module](/4/modules/ircv3_sts) instead.
8+
39
description: |-
410
This module provides the IRCv3 `tls` client capability.
511

0 commit comments

Comments
 (0)