From 172698dfb2117fc330cf44b02f4830ff028b2288 Mon Sep 17 00:00:00 2001 From: James Lu Date: Sat, 4 Jun 2016 18:47:23 -0700 Subject: [PATCH] docs: add FAQ, refresh TOC --- docs/README.md | 3 ++- docs/faq.md | 26 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 docs/faq.md diff --git a/docs/README.md b/docs/README.md index 9ffb0e9..c8064da 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,5 +4,6 @@ This folder contains general documentation for PyLink IRC services. ## Contents -- [Opering with PyLink Relay](pylink-opers.md) +- [PyLink FAQ (Frequently Asked Questions)](faq.md) +- [PyLink Relay Tutorial & Oper Guide](pylink-opers.md) - [Developer documentation](technical/) \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..6f009ea --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,26 @@ +# PyLink FAQ + +### Does everyone need to install PyLink Relay for it to work? + +**No!** Only the link administrator needs to host a PyLink instance, as each can connect to multiple networks. Everyone else only needs to add a link block on their IRCd. + +InterJanus-style links between PyLink daemons are not supported yet; see https://github.com/GLolol/PyLink/issues/99 for progress regarding that. + +### Does PyLink support Clientbot relay like Janus? + +Not yet; see https://github.com/GLolol/PyLink/issues/144. + +### What are PyLink Relay's benefits over Janus? + +In no particular order: +- More complete support for modern IRCds (UnrealIRCd 4.x, InspIRCd 2.0, charybdis 4, Nefarious IRCu, etc.). +- Built upon a flexible, maintainable codebase. +- Cross platform (*nix and Windows). +- Proper protocol negotiation: better support for channel modes (+fjMOR, etc.), nick length limits, and WHOIS. + +### I turned autoconnect for PyLink on, and now I'm getting errors! + +PyLink does not support inbound connections - much like Atheme or Anope, it only connects outwards to IRCds. (If you don't understand what this means, it means you should turn autoconnect OFF for PyLink) + +### I get errors like "ImportError: No module named 'yaml'" when I start PyLink +- You are missing dependencies - re-read https://github.com/GLolol/PyLink#dependencies. \ No newline at end of file