PirateIRC
/
docs
8
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Quickstart.md: markdownify a bit more

Aminda Suomalainen ⚧ 2020-12-12 15:25:12 +02:00
parent e15a70143f
commit 02b90ff0bf
Signed by: Aminda Suomalainen ⚧
GPG Key ID: 99392F62BAE30723
1 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Quickstart.md

@ -1,58 +1,57 @@
= Quickstarts = # Quickstart
The following is hints on how to get started with this network. The following is hints on how to get started with this network.
== Registration == ## Registration
Please consider registering your nickname in order to benefit of the Please consider registering your nickname in order to benefit of the
integrated bouncer and other modern features: /MSG NICKSERV REGISTER PASSWORDHERE EMAIL@EXAMPLE.NET integrated bouncer and other modern features: `/MSG NICKSERV REGISTER PASSWORDHERE EMAIL@EXAMPLE.NET`
== Login == ## Login
Login is best done by using SASL to ensure you get access to your registered Login is best done by using SASL to ensure you get access to your registered
NickName. Freenode has the most comprehensive documentation on how to enable NickName. Freenode has the most comprehensive documentation on how to enable
it at https://freenode.net/kb/answer/sasl#sasl-client-configuration it at https://freenode.net/kb/answer/sasl#sasl-client-configuration
TIP: add @identifier e.g. @PhoneClient after your username to separate the TIP: add `@identifier` e.g. `@PhoneClient` after your (SASL) username to separate the
different locations/clients and utilise client-specific playback buffers. different locations/clients and utilise client-specific playback buffers.
This will also stop repeating messages (as long as you won't change the This will also stop repeating messages (as long as you won't change the
@identifier)! `@identifier`)!
== Integrated bouncer == ## Integrated bouncer
As a registered user, should you wish, you can configure the network to As a registered user, should you wish, you can configure the network to
allow you to receive channel/private messages even when you have no clients allow you to receive channel/private messages even when you have no clients
connected. This is known as a bouncer. connected. This is known as a bouncer.
Keep your nickname connected and receiving messages: /MSG NICKSERV SET ALWAYS-ON ON Keep your nickname connected and receiving messages: `/MSG NICKSERV SET ALWAYS-ON ON`
TIP: If your client supports ZNC's Playback module, it will automatically TIP: If your client supports ZNC's Playback module, it will automatically
handle receiving only missed lines. See also https://wiki.znc.in/Playback#Supported_clients handle receiving only missed lines. See also https://wiki.znc.in/Playback#Supported_clients
for list of them and scripts. for list of them and scripts.
TIP: If you are running a relaybot, you WANT TO USE @CLIENTID IN SASL USERNAME TIP: If you are running a relaybot, you WANT TO USE `@CLIENTID` IN SASL USERNAME
to avoid repeating messages and ignore HistServ which only includes automated to avoid repeating messages and ignore `HistServ` which only includes automated
state change messages. state change messages.
== Yggdrasil access == ## Yggdrasil access
This server can be accessed through Yggdrasil network on This server can be accessed through Yggdrasil network on
irc://[201:11e5:29f8:f846:e407:e003:a681:98d2]:6667 (we cannot provide TLS `irc://[201:11e5:29f8:f846:e407:e003:a681:98d2]:6667` (we cannot provide TLS
certificate, but Yggdrasil is end-to-end encrypted and considered as a certificate, but Yggdrasil is end-to-end encrypted and considered as a
secure connection by the IRCd). secure connection by the IRCd).
== Tor access == ## Tor access
Registered Tor users can connect to the server by using SASL. Tor onion Registered Tor users can connect to the server by using SASL. Tor onion
service will be implemented in the future. service will be implemented in the future.
== Further reading == ## Further reading
The Oragono IRCd integrated documentation: /HELPOP INDEX * The Oragono IRCd integrated documentation: `/HELPOP INDEX`
On some clients the command may be: /QUOTE HELPOP INDEX * On some clients the command may be: `/QUOTE HELPOP INDEX`
or /RAW HELPOP INDEX or `/RAW HELPOP INDEX`
in order to send the command directly to server and not process it locally. in order to send the command directly to server and not process it locally.
* Nickname management: `/MSG NICKSERV HELP`
Nickname management: /MSG NICKSERV HELP * Channel management: `/MSG CHANSERV HELP`
Channel management: /MSG CHANSERV HELP * Vhost management: `/MSG HOSTERV HELP`
Vhost management: /MSG HOSTERV HELP * History management: `/MSG HISTSERV HELP`
History management: /MSG HISTSERV HELP