From e15a70143ff9e99bc9a0f934ae60ca95c51a2b36 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Sat, 12 Dec 2020 15:21:33 +0200 Subject: [PATCH] import Quickstart.md --- Quickstart.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/Quickstart.md b/Quickstart.md index 5e0583e..c24f78b 100644 --- a/Quickstart.md +++ b/Quickstart.md @@ -1 +1,58 @@ -moment \ No newline at end of file += Quickstarts = + +The following is hints on how to get started with this network. + +== Registration == + +Please consider registering your nickname in order to benefit of the +integrated bouncer and other modern features: /MSG NICKSERV REGISTER PASSWORDHERE EMAIL@EXAMPLE.NET + +== Login == + +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 +it at https://freenode.net/kb/answer/sasl#sasl-client-configuration + +TIP: add @identifier e.g. @PhoneClient after your username to separate the + different locations/clients and utilise client-specific playback buffers. + This will also stop repeating messages (as long as you won't change the + @identifier)! + +== Integrated bouncer == + +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 +connected. This is known as a bouncer. + +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 + handle receiving only missed lines. See also https://wiki.znc.in/Playback#Supported_clients + for list of them and scripts. +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 + state change messages. + +== Yggdrasil access == + +This server can be accessed through Yggdrasil network on +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 +secure connection by the IRCd). + +== Tor access == + +Registered Tor users can connect to the server by using SASL. Tor onion +service will be implemented in the future. + +== Further reading == + +The Oragono IRCd integrated documentation: /HELPOP INDEX +On some clients the command may be: /QUOTE HELPOP INDEX +or /RAW HELPOP INDEX +in order to send the command directly to server and not process it locally. + +Nickname management: /MSG NICKSERV HELP +Channel management: /MSG CHANSERV HELP +Vhost management: /MSG HOSTERV HELP +History management: /MSG HISTSERV HELP