Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-29 07:49:39 +01:00
Code Issues Projects Releases Wiki Activity
268 Commits 2 Branches 0 Tags 723 KiB
64c444e025
Commit Graph

120 Commits

Author SHA1 Message Date
Mikaela Suomalainen
4ce8fa9a28 install.rst: fix Windows installation 
Closes ProgVal/Limnoria#927 for us, I believe.
 2014-12-01 18:29:10 +02:00
Mikaela Suomalainen
88d605535e install: rewrite Windows instructions 2014-11-30 13:54:11 +02:00
Valentin Lorentz
e87852b0a9 Merge pull request #21 from Mkaysi/capabilities 
use/capabilities.rst: try to explain how to use...
 2014-11-21 23:45:03 +01:00
Mikaela Suomalainen
83b0fde4d7 identifying_to_services.rst: fix cert add 
NickServ is usually server-side alias on all networks that also checks that we are sending message to Services and if we aren't, the sending is aborted. Try it with `/quote NickServ help` or even `/allserv quote NickServ help`.
 2014-11-16 11:03:42 +02:00
Mikaela Suomalainen
fc457ea763 httpserver.rst: add comments on listen & https 2014-11-15 21:39:39 +02:00
Mikaela Suomalainen
ce314c39a8 Update identifying_to_services.rst 
2014-10-20 17:10:58+0300 < Mikaela> too early merge, now it says Certificate FingerPrint fingerprint
 2014-10-20 17:12:23 +03:00
Mikaela Suomalainen
24aa8027de use/identifying_to_services: rewording 
I don't recommend anything anymore there, network operators do that now
(ask at \#freenode and they will suggest SASL as reads at
https://freenode.net/faq.shtml#identify ).

Also mention that SASL is SASL PLAIN and to use SASL EXTERNAL you simply
configure CertFP + explain difference between the two mechanisms.
 2014-10-20 17:06:52 +03:00
Mikaela Suomalainen
c1fab4dd3c use/httpserver.rst: add nginx reverse proxy 2014-10-15 09:24:03 +03:00
Mikaela Suomalainen
70b7e80937 use/supybot-botchk: fix OS X compatibility 
There are also people using Supybot on OS X and it requires the locale
to be xx_XX.UTF-8.

According to @nyuszika7h, this also works on Linux.
 2014-09-25 15:46:42 +03:00
Mikaela Suomalainen
e3cc8d6178 use/identifying_to_services: add missing <>... 
...around BOT in the line which gets fingerprint id to tell to services for
certfp.
 2014-09-16 18:25:05 +03:00
Mikaela Suomalainen
d568adcfd3 use/configuration.rst: fix typo 2014-09-03 16:11:15 +03:00
Valentin Lorentz
a5f9e2ac10 Merge pull request #26 from Mkaysi/getting_started 
use/getting_started.rst: talk more about hostmasks
 2014-09-02 20:23:36 +02:00
Mikaela Suomalainen
055b3da711 Separate getting_started & identifying_to_services 2014-09-02 21:22:18 +03:00
Valentin Lorentz
ec6d01d05a Merge pull request #23 from Mkaysi/nickauth 
use/getting_started.rst: mention that NickAuth...
 2014-09-02 20:21:00 +02:00
Mikaela Suomalainen
74798772ac use/supybot-botchk.rst: document supybot-botchk 
and update .gitignore which was missing some other directories too.
 2014-09-02 20:43:51 +03:00
Mikaela Suomalainen
f620c14293 use/gettin_started.rst: talk more about hostmasks 
Adding strict hostmask isn't the only option, you can use wildcards and
the most used wildcards are now explained.

* any nick with specific ident (*!ident@host)
    * server which doesn't have bots, but has multiple users
* anything with specific host (*!*@host)
    * cloaks/vhosts
 2014-08-31 12:17:10 +03:00
Mikaela Suomalainen
66b1b2c976 use/getting_started.rst: mention that NickAuth... 
...identify you automatically.
 2014-08-30 18:15:16 +03:00
Mikaela Suomalainen
1a9b139758 use/install.rst: remove accidental $s 
My Vimrc makes Vim show $ where line changes and I had accidentally
copy-pasted it to places where it doesn't belong.
 2014-08-30 16:37:08 +03:00
Mikaela Suomalainen
e84dedb108 install.rst: put part about testing in italics 2014-08-29 20:14:26 +03:00
Mikaela Suomalainen
41f0419874 use/capabilities.rst: try to explain how to use... 
...capabilities.
 2014-08-28 16:31:03 +03:00
Mikaela Suomalainen
fc486ed212 Use gender neutral pronouns 2014-08-28 14:43:41 +03:00
Mikaela Suomalainen
56ac3c3929 getting_started.rst: fix typos noticed by 
@nyuszika7h
 2014-08-23 12:11:22 +03:00
Mikaela Suomalainen
1c812713d2 use/getting_started.rst: explain four methods... 
...to identify to Services.

Did this get a little too verbose? I think that this did, but I need
help making this a little less verbose and CertFP requires verbosity.
 2014-08-22 10:04:15 +03:00
Mikaela Suomalainen
4675ba1c96 doc/use/install: some updates 
* mention that .rpm package is also available

* note that Windows users should run global installation commands with
Administrator rights and also remove `sudo` from beginnings of lines.

* note that pip should be upgraded if it fails to do any of the
installation commands when git is installed.
 2014-08-21 20:10:07 +03:00
Mikaela Suomalainen
05d701cc48 use/getting_started.rst: replace pastebinit wit... 
h curl

curl is more often installed than pastebinit and is widely used and
might be installed by default on some systems (I believe Fedora 20 is
one of these).
 2014-08-06 11:37:15 +03:00
Mikaela Suomalainen
6123e4b79f use/install.rst: use sudo 
With help from \#supybot I understood that telling user to add `sudo` in
front of every command isn't very user-friendly.

If someone has root and is logged in as root, they know to remove the
`sudo` part and if they don't, but they have `sudo` installed,
everything works directly and `sudo` doesn't even ask for password.
 2014-07-30 08:54:16 +03:00
Mikaela Suomalainen
625d6939ce use/httpserver.rst: multiple updates 
* Update config variables
    * add favicon
    * host is nowadays known as hosts4
    * add hosts6
    * move keepalive above port as that is how it appears in the bot too
    * specify that HTTPd might require port change, not HTTP
    * HTTPd might not work if port is too low = port is under 1024
* Apache is in front of Supybot's HTTPd, not behind.
 2014-07-27 15:03:12 +03:00
Mikaela Suomalainen
8fcf3a8ea9 faq: update to Limnoria 
* There is no umode +E at freenode, it's +R.
* Limnoria does support proxies.
* Our issue tracker is at GitHub and even Supybot moved away from SF.
* Plugins might be case-sensitive.
 2014-07-26 13:46:03 +03:00
Mikaela Suomalainen
94f921dee2 configuration: add warning about editing registry 
and uncomment the section.
 2014-07-25 21:48:16 +03:00
Mikaela Suomalainen
e0854141b7 doc/use/configuration.rst: multiple changes 
* remove references to editing the config file by hand
* update `config list supybot` from Limnoria
* mention `config setdefault` instead of nesting `config default`
* update config search op
* comment `Editing the Configuration Values by Hand`
 2014-07-25 21:12:32 +03:00
Mikaela Suomalainen
712522d5c6 doc/getting_started.rst: document GPG and NickAuth 2014-07-25 14:12:27 +03:00
Mikaela Suomalainen
092d250dd1 use/index.rst: remove reference to nonexistant ... 
...document "use/plugins/index".
 2014-06-30 23:09:27 +03:00
Mikaela Suomalainen
7eb9f6fd3a use/install.rst: simplify installation/upgrading 
--upgrade does nothing if everything is installed and up-to-date.
Otherwise it installs or upgrades.
 2014-06-30 15:25:11 +03:00
Valentin Lorentz
3e20778d1b Fix syntax. 2014-06-27 17:25:04 +00:00
Valentin Lorentz
3b7e71588a Remove the install guide section for using Git. 2014-06-27 17:23:39 +00:00
Valentin Lorentz
c3a66de93c Fix typoes. 2014-06-27 17:19:04 +00:00
Mikaela Suomalainen
bb525b0f44 install.rst: Do changes suggested by @ProgVal & add upgrading with pip. 2014-06-27 20:02:15 +03:00
Mikaela Suomalainen
9203441915 install.rst: fix typo. 2014-06-27 19:51:22 +03:00
Mikaela Suomalainen
32fa8b28c7 install.rst: fix clode blocks with help from @ProgVal 2014-06-27 19:41:45 +03:00
Mikaela Suomalainen
4b2fb3951b install.rst: fix things with help from @ProgVal . 2014-06-27 19:32:36 +03:00
Mikaela Suomalainen
fa1d6bfeb0 install.rst: add pip 2014-06-27 18:23:55 +03:00
Valentin Lorentz
cf36da527d Document capabilities on the plugin side. 2014-01-20 11:54:27 +01:00
Valentin Lorentz
2fd3e11376 Document html templates customization on the user side. 2014-01-20 10:32:00 +01:00
Valentin Lorentz
514b430879 Document SIGHUP. 2014-01-20 10:27:16 +01:00
Valentin Lorentz
69c14633ba Merge import/ in other directories (develop/ and use/). 2014-01-20 09:31:22 +01:00
Valentin Lorentz
c999f4a7cd Update list of dependencies. 2013-11-17 01:04:03 +01:00
Valentin Lorentz
8092e96ad6 Document supybot.commands. 2013-02-01 18:51:03 +01:00
Valentin Lorentz
4a1d9259d9 Remove list of third-party plugins. 2013-02-01 18:45:59 +01:00
Valentin Lorentz
0cf36f7f8d Remove plugins docs. 2013-01-31 19:33:47 +01:00
Valentin Lorentz
07478653f2 use/install.rst: Add link to build.progval.net. 2012-11-05 11:41:06 +01:00
Valentin Lorentz
3cae0c1064 use/install.rst: Explain how to switch to the 'testing' branch. 2012-10-23 18:38:14 +02:00
Valentin Lorentz
a396d8bf77 Replace 'Supybot' by 'Limnoria' in the install guide (as Limnoria is actually installed). 2012-06-28 17:58:13 +02:00
Mika Suomalainen
844592f281 use/install.rst: Remove the mentioning of PYTHONPATH. 
It's not required with "python setup.py install --user".
 2012-04-01 10:37:49 +03:00
Mika Suomalainen
0a3eeecafc use/install.rst: Advise to use "python setup.py install --user". 2012-03-31 18:16:34 +03:00
Valentin Lorentz
707f874440 Add description for Protector 2011-11-01 13:32:41 +01:00
Valentin Lorentz
b31137d33e Include unofficial.inc in plugin doc which need it. 2011-10-29 13:29:17 +02:00
Valentin Lorentz
1cb25b34a0 Fix use/plugins/unofficial.inc. 2011-10-29 13:22:40 +02:00
Valentin Lorentz
5146e9f10c Fix hierarchy (and compilation warnings) for many plugins. 2011-10-29 13:19:46 +02:00
Valentin Lorentz
eafcaa63c3 Add a bunch of plugins from ProgVal/Supybot-plugins, and add configuration doc for others. 2011-10-29 12:39:38 +02:00
Valentin Lorentz
f0b2a20305 Misc: Sort commands (and fix bug with hierarchy). 2011-10-29 09:54:29 +00:00
Valentin Lorentz
2169f3aced Massive import of all generated configuration doc. 2011-10-28 22:49:04 +02:00
Valentin Lorentz
1cc32e522c AutoMode: Add documentation. 2011-10-28 18:50:09 +02:00
Valentin Lorentz
6704ef5d60 Move the imported files and add HTTP server doc. 2011-07-01 19:03:35 +02:00
Valentin Lorentz
2fb02fdb83 Add a reference to wikipedia.rst in use/plugins/index.rst 2011-06-30 16:20:51 +02:00
Valentin Lorentz
129d61db76 Too many changes to list them. 2011-06-29 19:17:50 +02:00
Valentin Lorentz
bd2fdf30f2 Add forgotten files 2011-06-29 09:33:59 +02:00
Valentin Lorentz
b17bd0fac6 Review and update the layout. 2011-06-28 17:29:38 +02:00
Valentin Lorentz
2ce465adcd Fix plugin docs. 2011-06-28 08:13:53 +02:00
Valentin Lorentz
506278f454 Generate all plugin docs. 2011-06-28 08:11:32 +02:00
Valentin Lorentz
8e48e80012 Start to write documentation. 2011-06-27 11:19:15 +02:00