inspircd / inspircd-docs

InspIRCd documentation.

About

InspIRCd is a modular C++ Internet Relay Chat (IRC) server for UNIX-like and Windows systems.

Supported Platforms

InspIRCd is supported on the following platforms:

• Most recent BSD variants using the Clang 5+ or GCC 7+ compilers and the GNU toolchains (Make, etc).

• Most recent Linux distributions using the Clang 5+ or GCC 7+ compilers and the GNU toolchain.

• The most recent three major releases of macOS using the AppleClang 10, Clang 5+, or GCC 7+ (not LLVM-GCC) compilers and the GNU toolchain.

• Windows 10 build 17061 or newer using the MSVC 19.15+ (Visual Studio 15.8 2017) compiler and CMake 3.20 or newer.

Other platforms and toolchains may also work but are not officially supported by the InspIRCd team. Generally speaking if you are using a reasonably modern UNIX-like system you should be able to build InspIRCd on it. If you can not and you wish to submit a patch we are happy to accept it as long as it is not extremely large.

If you encounter any bugs then please file an issue.

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.

Building from source on Windows is generally not recommended but a guide is available if you wish to do this.

If you are running on Debian 12/13, RHEL 8/9, Ubuntu 22.04/24.04, or Windows 10+ binary packages are available from the downloads page.

Some distributions ship an InspIRCd package in their package managers. We generally do not recommend the use of such packages as in the past distributions have made broken modifications to InspIRCd and not kept their packages up to date with essential security updates.

License

InspIRCd is licensed under version 2 of the GNU General Public License.

External Links

• Website
• Documentation
• GitHub
• Social Media
• Support IRC channel — #inspircd on irc.chatspike.net
• Development IRC channel — #inspircd.dev on irc.chatspike.net
• InspIRCd test network — testnet.inspircd.org

inspircd-docs's Issues

MariaDB support?

Hello, is there any particular reason MariaDB is not mentioned as supported, or could it be added to the documentation? https://docs.inspircd.org/3/modules/mysql/

Document cross-module dependencies better

Update SILENCE docs

There are some flags missing.

Also, it would be great to add an example of how to add/remove a SILENCE but not all flags or how to add an exception.

user modes for oper an user

helo anyone can help..
already look at inspird web site and other website.. but i cant found details bout user mode for oper/ircop and for normal user..

For example mode for ircop /mode +q or etc.. where i can get info / knowlegde bout that all.. coz at inspircd website not explain details.. just look lazy people whom write very simple..

Content error: Configuration Documentation

Description
There is a content error in the online configuration documentation.

Steps to reproduce the issue:

1. View configuration documentation.
2. Navigate to ""
3. Notice the error

Describe the results you received:
The section for badnick contains the description of the previous entry.

Describe the results you expected:
The description of the appropriate section appearing.

Additional information you deem important (e.g. issue happens only occasionally):

Output of ./bin/inspircd --version:

Complete and fully tested install instructions for major releases.

Description
Complete and fully tested install instructions for major releases.

Why this would be useful
This would reduce frustration and increase adoption.

My people will run tests to confirm instructions work properly.
Please always include the solution when closing a bug report.

Document the InspIRCd server-to-server protocol

We currently do not have any documentation for the InspIRCd server to server protocol. I am working on this but it is taking a while so this is a tracking issue to monitor the progress on it.

Add more useful snippets

We now have a page for documenting useful config snippets: https://docs.inspircd.org/3/configuration/useful-snippets/

We should expand this with more useful tips.

Suggestions are appreciated.

Missing Information

It seems that the migration away from wiki has lost a lot of information, an example is the +/-P channel mode. It's not documented under channel modes. Another example is the configuration for the filter module is missing the include directive.

Create a Beginner's Guide to Writing Custom Modules

There is great interest in starting to write your own modules for IRCD, but there is no practical knowledge, only a little knowledge of the C++ programming language. It would be useful to have a more detailed guide on writing modules from scratch with good examples for each value or instructional videos.

While on mobile, some links on the main page are behind a hidden element making them unclickable

While on mobile, some links on the main page are behind a hidden element making them unclickable.

This is also reproducible on the PC by simply resizing the window to mimic a mobile device/small screen.

Browser: Firefox 69.0.3

Links that become unclickable in mobile view:
General: Security Advisories
General: Versioning Policy
InspIRCd 2: Modules
InspIRCd 2: SNOMasks

Migrate to the github-pages action

Currently we use GitHub Actions to push to the gh-pages branch when commits to the master branch are made.

There's now a first party action for pushing directly to pages so we should use that instead.

https://github.com/actions/upload-pages-artifact

https://github.com/actions/deploy-pages

more setup tutorials for major cloud computing services

Description
with AWS, Google Cloud, and Microsoft Azure. People can now run serves in the cloud. yet there are no tutorials on setting up inspircd on any of these major platforms

Why this would be useful
The number of people moving to these platforms is massive and proper tutorials on how to use inspircd on these platforms would increase inspircd's usage.

Solution
step by step turorials for each of these platforms AWS, Google Cloud, and Microsoft Azure should be made.

Numeric config fields should specify their minimum/maximum lengths

e.g. Number (5-10)

This would make it easier for people to know what the valid values are.

Add an overview of changes in v4

The current v4 changelog isn't very useful for people who are upgrading as it doesn't give people a summary of all of the changes in the release. We should add a new docs page with a more higher level overview of the changes.

I've started work on this over here but it would be good to have some help with suggestions for what should be in it as its a big task.

Virtual Host Servers... is it possible to have multiple servers with 1 ip, 1 instance running

I was wondering if it was possible for me to set up different servers with the 1 ip and 1 server, like Virtual Hosts.

Document server operator privileges

Currently only core server operator privileges are documented.

https://docs.inspircd.org/3/configuration/#class

We should document all of the ones added by modules with some magic to add them to the core page like with <bind:hook> etc.

Either <connect:allow> or <connect:deny> is required or connect class is not suitable

If you create a config like shown in the following example,

inspircd-docs/docs/3/configuration/_connect.yml

Lines 159 to 183 in a436883

	Defines a TLS (SSL) only connect class and then a general connect class to inherit from:
	```xml
	<connect name="Secure"
	parent="Main"
	port="6697">
	<connect name="Main"
	allow="*"
	commandrate="1000"
	fakelag="on"
	globalmax="3"
	hardsendq="1M"
	limit="5000"
	localmax="3"
	maxchans="30"
	maxconnwarn="no"
	pingfreq="120"
	recvq="8K"
	resolvehostnames="yes"
	softsendq="8192"
	threshold="10"
	timeout="10"
	uniqueusername="no">
	```

you will see the following message in debug mode when a client connects on port 6697:

Tue May 23 2023 03:20:42 CONNECTCLASS: The Secure connect class is not suitable as neither <connect:allow> nor <connect:deny> are set
Tue May 23 2023 03:20:42 CONNECTCLASS: Checking the Main connect class ...
Tue May 23 2023 03:20:42 CONNECTCLASS: The Main connect class is suitable for 007AAAAAF ([email protected])

In other words: The example doesn't work. Looks like either <connect:allow> or <connect:deny> is always required.

Tested with version 3.16.0 [Vendor].

Prepare docs for generating the help config from them.

Some changes we need to make before this change:

• Add an oper_only bool field to the commands section of the YAML.
• Merge example_commands into the commands section under each module.
• Convert the core command data from Markdown to YAML.

docs.inspircd.org is down

Document the existence of the pkgsrc package

The InspIRCd packages in pkgsrc are developed by @Niacat who is a previous contributor that monitors InspIRCd development closely and updates it immediately after release. I think this means it meets the requirement to be mentioned as a blessed way to install InspIRCd especially considering that pkgsrc is portable to many platforms.

@Niacat has expressed an interest in writing this up so this is a tracking issue to monitor the work on that.

`<connect:reason>` has type "Number" in `docs/3/configuration`

It should, presumably, instead be "Text".

`<files>` and `<execfiles>` are missing from `docs/3/configuration`

The user is left to guess and piece together the syntax and semantics of these tags from clues scattered throughout the example config file, while there is no mention of them in the primary reference.