ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-09 18:49:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update links to point to the upcoming v4 docs.

Browse Source 
[skip alpine ci]
[skip macos ci]
[skip windows ci]
[skip ubuntu ci]
This commit is contained in:
Sadie Powell 2022-05-18 16:49:20 +01:00
parent 3cc24014a7
commit 844a3505e9
5 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,4 +1,4 @@
### Important Notice ## Important Notice
The `master` branch contains the latest unstable development code. If you are running a server then you probably want to use a v3 release for now. You can obtain this from [the releases page](https://github.com/inspircd/inspircd/releases/latest) or by running `git checkout $(git describe --abbrev=0 --tags insp3)` if you are installing from Git. The `master` branch contains the latest unstable development code. If you are running a server then you probably want to use a v3 release for now. You can obtain this from [the releases page](https://github.com/inspircd/inspircd/releases/latest) or by running `git checkout $(git describe --abbrev=0 --tags insp3)` if you are installing from Git.
@ -24,7 +24,7 @@ If you encounter any bugs then [please file an issue](https://github.com/inspirc
## Installation ## Installation
Most InspIRCd users running a UNIX-like system build from source. A guide about how to do this is available on [the InspIRCd docs site](https://docs.inspircd.org/3/installation/source). Most InspIRCd users running a UNIX-like system build from source. A guide about how to do this is available on [the InspIRCd docs site](https://docs.inspircd.org/4/installation/source).
Building from source on Windows is generally not recommended but [a guide is available](https://github.com/inspircd/inspircd/blob/master/win/README.txt) if you wish to do this. Building from source on Windows is generally not recommended but [a guide is available](https://github.com/inspircd/inspircd/blob/master/win/README.txt) if you wish to do this.

8
docs/conf/inspircd.conf.example
View File

@ -66,7 +66,7 @@
# Variables may be redefined and may reference other variables. # # Variables may be redefined and may reference other variables. #
# Value expansion happens at the time the tag is read. # # Value expansion happens at the time the tag is read. #
# # # #
# See https://docs.inspircd.org/3/configuration/#define for a list of # # See https://docs.inspircd.org/4/configuration/#define for a list of #
# predefined config variables. # # predefined config variables. #
<define name="bindip" value="1.2.2.3"> <define name="bindip" value="1.2.2.3">
<define name="localips" value="&bindip;/24"> <define name="localips" value="&bindip;/24">
@ -138,9 +138,9 @@
# to the name of a custom <sslprofile> tag that you have defined. See the # to the name of a custom <sslprofile> tag that you have defined. See the
# docs page for the TLS module you are using for more details: # docs page for the TLS module you are using for more details:
# #
# GnuTLS: https://docs.inspircd.org/3/modules/ssl_gnutls#sslprofile # GnuTLS: https://docs.inspircd.org/4/modules/ssl_gnutls#sslprofile
# mbedTLS: https://docs.inspircd.org/3/modules/ssl_mbedtls#sslprofile # mbedTLS: https://docs.inspircd.org/4/modules/ssl_mbedtls#sslprofile
# OpenSSL: https://docs.inspircd.org/3/modules/ssl_openssl#sslprofile # OpenSSL: https://docs.inspircd.org/4/modules/ssl_openssl#sslprofile
# #
# You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
# for GnuTLS and ssl_mbedtls for mbedTLS. # for GnuTLS and ssl_mbedtls for mbedTLS.

8
docs/conf/links.conf.example
View File

@ -60,9 +60,9 @@
# when making an outbound connection to the server. See the docs page for # when making an outbound connection to the server. See the docs page for
# the TLS module you are using for more details: # the TLS module you are using for more details:
# #
# GnuTLS: https://docs.inspircd.org/3/modules/ssl_gnutls#sslprofile # GnuTLS: https://docs.inspircd.org/4/modules/ssl_gnutls#sslprofile
# mbedTLS: https://docs.inspircd.org/3/modules/ssl_mbedtls#sslprofile # mbedTLS: https://docs.inspircd.org/4/modules/ssl_mbedtls#sslprofile
# OpenSSL: https://docs.inspircd.org/3/modules/ssl_openssl#sslprofile # OpenSSL: https://docs.inspircd.org/4/modules/ssl_openssl#sslprofile
# #
# You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
# for GnuTLS and ssl_mbedtls for mbedTLS. The server port that you # for GnuTLS and ssl_mbedtls for mbedTLS. The server port that you
@ -71,7 +71,7 @@
# fingerprint: If defined, this option will force servers to be # fingerprint: If defined, this option will force servers to be
# authenticated using TLS certificate fingerprints. See # authenticated using TLS certificate fingerprints. See
# https://docs.inspircd.org/3/modules/spanningtree for more information. # https://docs.inspircd.org/4/modules/spanningtree for more information.
# This will require a TLS link for both inbound and outbound connections. # This will require a TLS link for both inbound and outbound connections.
#fingerprint="" #fingerprint=""

26
docs/conf/modules.conf.example
View File

@ -10,7 +10,7 @@
# # # #
# By default, ALL modules are commented out. You must uncomment them # # By default, ALL modules are commented out. You must uncomment them #
# or add lines to your config to load modules. Please refer to # # or add lines to your config to load modules. Please refer to #
# https://docs.inspircd.org/3/modules for a list of modules and # # https://docs.inspircd.org/4/modules for a list of modules and #
# each modules link for any additional conf tags they require. # # each modules link for any additional conf tags they require. #
# # # #
# ____ _ _____ _ _ ____ _ _ _ # # ____ _ _____ _ _ ____ _ _ _ #
@ -564,7 +564,7 @@
# #
# You can also define a custom codepage. For details on how to do this # You can also define a custom codepage. For details on how to do this
# please refer to the docs site: # please refer to the docs site:
# https://docs.inspircd.org/3/modules/codepage # https://docs.inspircd.org/4/modules/codepage
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Common channels module: Adds user mode +c, which, when set, requires # Common channels module: Adds user mode +c, which, when set, requires
@ -840,7 +840,7 @@
#<module name="dnsbl"> #<module name="dnsbl">
# # # #
# For configuration options please see the docs page for dnsbl at # # For configuration options please see the docs page for dnsbl at #
# https://docs.inspircd.org/3/modules/dnsbl. You can also use one or # # https://docs.inspircd.org/4/modules/dnsbl. You can also use one or #
# more of the following example configs for popular DNSBLs: # # more of the following example configs for popular DNSBLs: #
# # # #
# DroneBL (https://dronebl.org) # # DroneBL (https://dronebl.org) #
@ -1034,7 +1034,7 @@
# #
#-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
# # # #
# See https://docs.inspircd.org/3/modules/hostchange for help. # # See https://docs.inspircd.org/4/modules/hostchange for help. #
# # # #
#<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com"> #<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
#<hostchange mask="*root@*" action="addnick" prefix="example/users/"> #<hostchange mask="*root@*" action="addnick" prefix="example/users/">
@ -1445,7 +1445,7 @@
#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
# # # #
# mysql is more complex than described here, see the docs for more # # mysql is more complex than described here, see the docs for more #
# info: https://docs.inspircd.org/3/modules/mysql # # info: https://docs.inspircd.org/4/modules/mysql #
# #
#<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2"> #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
@ -1595,7 +1595,7 @@
# # # #
# Much of override's configuration relates to your oper blocks. # # Much of override's configuration relates to your oper blocks. #
# For more information on how to allow opers to override, see: # # For more information on how to allow opers to override, see: #
# https://docs.inspircd.org/3/modules/override # # https://docs.inspircd.org/4/modules/override #
# # # #
# noisy - If enabled, all oper overrides will be announced # # noisy - If enabled, all oper overrides will be announced #
# via channel notice. # # via channel notice. #
@ -1740,7 +1740,7 @@
#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
# # # #
# pgsql is more complex than described here, see the docs for # # pgsql is more complex than described here, see the docs for #
# more: https://docs.inspircd.org/3/modules/pgsql # # more: https://docs.inspircd.org/4/modules/pgsql #
# #
#<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" tls="yes"> #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" tls="yes">
@ -2199,7 +2199,7 @@
#-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
# # # #
# ssl_gnutls is too complex to describe here, see the docs: # # ssl_gnutls is too complex to describe here, see the docs: #
# https://docs.inspircd.org/3/modules/ssl_gnutls # # https://docs.inspircd.org/4/modules/ssl_gnutls #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# TLS info module: Allows users to retrieve information about other # TLS info module: Allows users to retrieve information about other
@ -2231,7 +2231,7 @@
#-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
# # # #
# ssl_mbedtls is too complex to describe here, see the docs: # # ssl_mbedtls is too complex to describe here, see the docs: #
# https://docs.inspircd.org/3/modules/ssl_mbedtls # # https://docs.inspircd.org/4/modules/ssl_mbedtls #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# OpenSSL TLS module: Adds support for TLS connections using OpenSSL, # OpenSSL TLS module: Adds support for TLS connections using OpenSSL,
@ -2243,7 +2243,7 @@
#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
# # # #
# ssl_openssl is too complex to describe here, see the docs: # # ssl_openssl is too complex to describe here, see the docs: #
# https://docs.inspircd.org/3/modules/ssl_openssl # # https://docs.inspircd.org/4/modules/ssl_openssl #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Strip color module: Adds channel mode +S that strips color codes and # Strip color module: Adds channel mode +S that strips color codes and
@ -2273,7 +2273,7 @@
#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
# # # #
# sqlite is more complex than described here, see the docs for more # # sqlite is more complex than described here, see the docs for more #
# info: https://docs.inspircd.org/3/modules/sqlite3 # # info: https://docs.inspircd.org/4/modules/sqlite3 #
# #
#<database module="sqlite" hostname="/full/path/to/database.db" id="anytext"> #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
@ -2286,7 +2286,7 @@
#-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
# # # #
# sqlauth is too complex to describe here, see the docs: # # sqlauth is too complex to describe here, see the docs: #
# https://docs.inspircd.org/3/modules/sqlauth # # https://docs.inspircd.org/4/modules/sqlauth #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# SQL oper module: Allows you to store oper credentials in an SQL # SQL oper module: Allows you to store oper credentials in an SQL
@ -2300,7 +2300,7 @@
# # # #
# dbid - Database ID to use (see SQL modules). # # dbid - Database ID to use (see SQL modules). #
# # # #
# See also: https://docs.inspircd.org/3/modules/sqloper # # See also: https://docs.inspircd.org/4/modules/sqloper #
# # # #
#<sqloper dbid="1"> #<sqloper dbid="1">

10
tools/testssl
View File

@ -73,7 +73,7 @@ It seems like the server endpoint you specified is not reachable! Make sure that
* If you are using a firewall incoming connections on TCP port $port are allowed. * If you are using a firewall incoming connections on TCP port $port are allowed.
* The endpoint your server is listening on is not local or private. * The endpoint your server is listening on is not local or private.
See https://docs.inspircd.org/3/configuration/#ltbindgt for more information. See https://docs.inspircd.org/4/configuration/#ltbindgt for more information.
EOM EOM
exit 1; exit 1;
} }
@ -91,7 +91,7 @@ It seems like the server dropped the connection before sending anything! Make su
* The endpoint you specified is actually your IRC server. * The endpoint you specified is actually your IRC server.
* If you are using a firewall incoming data on TCP port $port are allowed. * If you are using a firewall incoming data on TCP port $port are allowed.
See https://docs.inspircd.org/3/configuration/#ltbindgt for more information. See https://docs.inspircd.org/4/configuration/#ltbindgt for more information.
EOM EOM
exit 1; exit 1;
} elsif ($data =~ /[A-Z:@]/) { } elsif ($data =~ /[A-Z:@]/) {
@ -116,9 +116,9 @@ It appears that the server endpoint is using plaintext! Make sure that:
See the following links for more information: See the following links for more information:
https://docs.inspircd.org/3/modules/ssl_gnutls/#configuration https://docs.inspircd.org/4/modules/ssl_gnutls/#configuration
https://docs.inspircd.org/3/modules/ssl_mbedtls/#configuration https://docs.inspircd.org/4/modules/ssl_mbedtls/#configuration
https://docs.inspircd.org/3/modules/ssl_openssl/#configuration https://docs.inspircd.org/4/modules/ssl_openssl/#configuration
EOM EOM
exit 1; exit 1;
} }