Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-12-26 13:12:34 +01:00
Code Issues Projects Releases Wiki Activity

getting_started.rst: fix typos noticed by

Browse Source 
@nyuszika7h
This commit is contained in:
Mikaela Suomalainen 2014-08-23 11:34:39 +03:00
parent 1c812713d2
commit 56ac3c3929
1 changed files with 57 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
use/getting_started.rst
View File

@ -194,12 +194,12 @@ SASL
Note that SASL isn't supported on all networks. You can easily test if it's Note that SASL isn't supported on all networks. You can easily test if it's
supported with ``/msg SaslServ help`` and if you get response, SASL is supported with ``/msg SaslServ help`` and if you get response, SASL is
probably supprted, if you don't get reply or get error about no such nick, probably supported, if you don't get reply or get error about no such nick,
SASL isn't supported. SASL isn't supported.
SASL is widely agreed as the best method to identify to services as it SASL is widely agreed as the best method to identify to services as it
identifies you before anyone (else than IRC operators) can see that you are identifies you before anyone (other than IRC operators) can see that you
connected. To enable SASL, simply:: are connected. To enable SASL, simply::
config networks.<network>.sasl.username AccountName config networks.<network>.sasl.username AccountName
config networks.<network>.sasl.password P455w0rd config networks.<network>.sasl.password P455w0rd
@ -211,88 +211,87 @@ the real network name like ``freenode``.
CertFP CertFP
------ ------
You can test if CertFP is supported by services simply by You can test if CertFP is supported by services simply by doing
``/msg NickServ cert``. If you get error about "Insufficient parameters for ``/msg NickServ cert``. If you get an error about "Insufficient parameters
CERT", CertFP is supported and if you get error about unknown command, it's for CERT", CertFP is supported, and if you get an error about unknown
not supported. command, it's not supported.
CertFP identifies you to services using client (SSL) certificate and CertFP identifies you to services using a client (SSL) certificate and
naturally requires SSL connection. It doesn't identify you as soon as SASL, naturally requires an SSL connection. It doesn't identify you as soon as
but unlike SASL, it identifies you even when Services return from netsplit SASL, but unlike SASL, it identifies you even when services return from a
unlike any other mechanism. First you must generate certificate and netsplit, unlike any other mechanism.
the easiest method is probably using OpenSSL which you should have even on
Windows if you installed with pip.::
openssl req -nodes -newkey rsa:4096 -keyout BOT.pem -x509 -days 3650 -out BOT.pem -subj "/CN=BOT" First you must generate a certificate, and the easiest method is probably
using OpenSSL which you should have even on Windows if you installed with pip::
Now you should have file BOT.pem in the directory where you ran the command openssl req -nodes -newkey rsa:4096 -keyout <BOT>.pem -x509 -days 3650 -out <BOT>.pem -subj "/CN=<BOT>"
presumably at your home directory and you only need to tell your bot where
to find it and tell NickServ that it belongs to you. Note that you can
and should replace ``BOT`` with accountname of your bot.
You have two choices: using the same certificate on all networks::: Now you should have a ``<BOT>.pem`` file in the directory where you ran
the command, presumably your home directory and you only tell your
bot where to find it and tell NickServ that it belongs to you.
Note that you should replace ``<BOT>`` with the account name of your bot.
config protocols.irc.certfile /home/<username>/BOT.pem You have two choices, using the same certificate on all networks::
or only on one or more network where it's manually configured config protocols.irc.certfile /home/<username>/<BOT>.pem
config networks.<network>.certfile /home/<username>/BOT.pem or only on one or more network where it's manually configured::
And last you must inform the services which is your certificate config networks.<network>.certfile /home/<username>/<BOT>.pem
fingerprint which you can find out with::
openssl x509 -sha1 -noout -fingerprint -in BOT.pem | sed -e 's/^.*=//;s/://g;y/ABCDEF/abcdef/' And lastly, you must tell the services what is your certificate
fingerprint, which you can find out with::
This results to something like ``05dd01fedc1b821b796d0d785160f03e32f53fa8`` openssl x509 -sha1 -noout -fingerprint -in BOT.pem | tr -d ':' | tr 'A-Z' 'a-z'
which you tell to services with ``/msg NickServ cert add 05dd01fedc1b821b796d0d785160f03e32f53fa8`` or if your bot has different NickServ account::
This results in something like
``05dd01fedc1b821b796d0d785160f03e32f53fa8`` which you tell your bot to
tell services::
owner ircquote PRIVMSG NickServ :cert add 05dd01fedc1b821b796d0d785160f03e32f53fa8 owner ircquote PRIVMSG NickServ :cert add 05dd01fedc1b821b796d0d785160f03e32f53fa8
Or if your bot identifies as you, you can do that by yourself with::
/msg NickServ cert add 05dd01fedc1b821b796d0d785160f03e32f53fa8
Remember to replace ``05dd01fedc1b821b796d0d785160f03e32f53fa8`` with your Remember to replace ``05dd01fedc1b821b796d0d785160f03e32f53fa8`` with your
own fingerprint! Next time you connect, your bot should get identified own fingerprint! Next time your bot connects, it should get identified
automatically. automatically.
Opening the certificate a little
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``openssl req -nodes -newkey rsa:4096 -keyout BOT.pem -x509 -days 3650 -ou t BOT.pem -subj "/CN=BOT"$``
This command generates passwordless SSL certificate which is RSA key with
4096 bits and saves it to file BOT.pem. It's valid for 3650 days which
means ten years and you must generate a new certificate after that even if
it's recommended to do it sooner. Your certificate will have CN, CommonName
which shows whom it has been generated for BOT.
Server password Server password
--------------- ---------------
Many networks support identifying using ``username:password`` as server Many networks support identifying using ``username:password`` as server
password. If this is the case with your network (anything that uses password. If this is the case with your network (anything that uses a
Charybdis-like IRCd), this shold work for you. Note that this identifies charybdis-like IRCd), this should work for you. Note that this identifies
you after SASL so your real host might be seen.:: you after SASL so, your real host might be seen. To do this, simply::
config networks.<network>.password username:password config networks.<network>.password username:password
Replace ``<network>`` with the name of network, for example ``freenode`` Replace ``<network>`` with the name of network, for example ``freenode``
and username:password with your real username and password. and username:password with your real username and password.
ZNC users: since ZNC 1.0 ZNC identification format has been ZNC users: since ZNC 1.0, ZNC's identification format has been
``username/network:password`` ``username/network:password``.
Services plugin Services plugin
--------------- ---------------
Services plugin comes with Supybot and should be easy way to identify The Services plugin comes with Supybot and should be an easy way to
yourself, but SASL and username:password as server password are recommended identify your bot, but SASL and ``username:password`` as server password
over it. First start by loading Services with ``load Services`` and then are recommended over it. Start by loading Services with::
tell it what are your NickServ and ChanServ called as.::
load Services
and then tell it what NickServ and ChanServ are called::
config plugins.services.nickserv NickServ config plugins.services.nickserv NickServ
config plugins.services.chanserv ChanServ config plugins.services.chanserv ChanServ
Remember to replace NickServ/ChanServ with their real names if they have Remember to replace NickServ/ChanServ with their real names if they have a
different name on any network. Note that they must have same name on all different name on any network. Note that they must have the same name on
networks and you must have same password on all networks. all networks, and you must have the same password on all networks.
Now you can set your password:: Now you can set your password::
@ -302,11 +301,11 @@ makes the bot attempt identifying as Bot using password P455w0rd. Replace
them with your real nickname and password. Note that if you have multiple them with your real nickname and password. Note that if you have multiple
nicknames, you must run ``services password`` for them all. nicknames, you must run ``services password`` for them all.
If your bot happens to get other nickname than configured one, it doesn't If your bot happens to get a nickname that isn't configured, it won't
know to identify. You might be able to avoid this issue by loading know how to identify. You might be able to avoid this issue by loading
NickCapture, ``load NickCapture`` which attempts to regain the primary nick NickCapture, (``load NickCapture``) which attempts to regain the primary
when it's possible and when it regains the primary nick the identification nick, when it's possible, and when it regains the primary nick, the
should work. identification should work.
Loading Plugins Loading Plugins
=============== ===============