mikaela.github.io/articles/guides/Limnoria.html

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" /> <!-- <meta http-equiv="refresh" content="60" /> --> <meta name="description" content="Guide for installing and using Limnoria which is actively developed fork of Supybot either from Debian package or from source and with or without root." /> <meta name="keywords" content="Supybot,Limnoria,IRC,bot,python2,git,Debian,Linux,Mint,Ubuntu,Kubuntu,Lubuntu,Xubuntu,Arch" /> <meta name="author" content="Mika Suomalainen" /> <link rel="canonical" href="http://mkaysi.github.com/articles/guides/Limnoria.html">
<title>
Installing &amp; running Limnoria.
</title>
<link rel="stylesheet" type="text/css" href="../../tyyli.css" />
</head>
<body>
<hr/>
<a href="../../sitemap/sitemap.html">Sitemap</a>
<hr/>

<h1 id="installing">Installing</h1>
<p>There are three ways to install [Limnoria] depending on your operating system. If you are on Debian-based Linux distribution e.g. [Debian], [*Ubuntu], [Linux Mint] you can install the Debian package. Or then you can install from source which should work on all other OSes too (at least Mac OS X, I don't have successful experience with Windows) and you can also install for current user only.</p>
<h2 id="with-the-debian-package">With the Debian package</h2>
<p><strong>This method requires root access.</strong></p>
<p>First become root by running</p>
<pre><code>sudo su</code></pre>
<p>Then download the Debian package. Here you have to choice do you install the stable version or testing version.</p>
<p>Replace &quot;VERSIONHERE&quot; with &quot;master&quot; to get stable version or &quot;testing&quot; to get testing version.</p>
<pre><code>wget http://compiler.progval.net/limnoria-VERSIONHERE-HEAD.deb
dpkg -i limnoria-VERSIONHERE-HEAD.deb
apt-get install -f</code></pre>
<p>The &quot;apt-get install -f&quot; tries to fix broken packages by downloading and installing missing depedencies if there are them.</p>
<h3 id="upgrading">Upgrading</h3>
<p>To upgrade just run the steps above. Remember that the Debian packages are daily builds, so they are changed every day. You can see the latest change on [compiler.progval.net]. The &quot;-HEAD&quot; packages are always the most recent version.</p>
<h2 id="from-source">From source</h2>
<p>I recommend that you have [git] installed, because it will make upgrading easier and you don't have to find the [download links] from [GitHub].</p>
<p>If you are going to do a global installation you might want to become root now, otherwise skip the next command</p>
<pre><code>sudo su</code></pre>
<p>Now download (or &quot;clone&quot;) the git repository.</p>
<pre><code>git clone git://github.com/ProgVal/Limnoria.git</code></pre>
<p>move into the cloned repository</p>
<pre><code>cd Limnoria</code></pre>
<p>and decide do you want install stable or testing version.</p>
<p>In case you want the testing version, change into the testing branch. If you want the stable version skip this.</p>
<pre><code>git checkout -b testing origin/testing</code></pre>
<p>Now if you are root and what global installation, you run</p>
<pre><code>python setup.py install</code></pre>
<p>or local installation</p>
<pre><code>python setup.py install --user</code></pre>
<p>Limnoria is now installed and you can move to configuring it.</p>
<p><strong>[Arch Linux] users (and users of other distributions which use python3 by default instead of python&quot;): REPLACE &quot;python&quot; WITH &quot;python2&quot; in all commands!</strong></p>
<h3 id="upgrading-1">Upgrading</h3>
<p>Return to the git repository or if you have removed it, follow the installation steps again.</p>
<p>Update the cloned repository by running</p>
<pre><code>git pull</code></pre>
<p>and then reinstall</p>
<pre><code>python setup.py install</code></pre>
<p>or only for current user</p>
<pre><code>python setup.py install --user</code></pre>
<hr/>

<h1 id="configuring-the-bot">Configuring the bot</h1>
<p>If you installed [Limnoria] as root, you can skip the next section and move to &quot;running Supybot-wizard&quot;.</p>
<h2 id="preparing-locally-installed-limnoria-for-use">Preparing locally installed Limnoria for use</h2>
<p>Limnoria's binaries were installed to ~/.local/bin which isn't in default $PATH. This means that you must either type the whole path always when you want to run Limnoria or add ~/.local/bin to your PATH. We do the previously mentioned.</p>
<p>You can add it to the PATH by running the following commands:</p>
<pre><code>echo &quot;PATH=$HOME/.local/bin:$PATH&quot; &gt;&gt; ~/.bashrc
echo &quot;PATH=$HOME/.local/bin:$PATH&quot; &gt;&gt; ~/.zshrc</code></pre>
<p><strong>If you type only one &quot;&gt;&quot; instead of &quot;&gt;&gt;&quot; in those commands, you will replace the content of those files with &quot;PATH=<span class="math"><em>H</em><em>O</em><em>M</em><em>E</em> / . <em>l</em><em>o</em><em>c</em><em>a</em><em>l</em> / <em>b</em><em>i</em><em>n</em>: </span>PATH&quot; instead of appending it into them.</strong></p>
<p>then run</p>
<pre><code>source .bashrc</code></pre>
<p>or with zsh</p>
<pre><code>source .zshrc</code></pre>
<p>and you should be able to run the commands without needing to type the whole PATH, so you can now move into configuring.</p>
<p><strong>NOTE: You don't need to do this again after upgrading.</strong></p>
<h2 id="running-the-supybot-wizard">Running the Supybot-wizard</h2>
<!-- vim : set ft=html -->
-												articles/guides/Limnoria: start writing Limnoria guide

											
										
										
											2012-11-04 14:27:26 +02:00
+								<!DOCTYPE html>
 								<html>
 								<head>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<meta charset="UTF-8" /> <!-- <meta http-equiv="refresh" content="60" /> --> <meta name="description" content="Guide for installing and using Limnoria which is actively developed fork of Supybot either from Debian package or from source and with or without root." /> <meta name="keywords" content="Supybot,Limnoria,IRC,bot,python2,git,Debian,Linux,Mint,Ubuntu,Kubuntu,Lubuntu,Xubuntu,Arch" /> <meta name="author" content="Mika Suomalainen" /> <link rel="canonical" href="http://mkaysi.github.com/articles/guides/Limnoria.html">
-												articles/guides/Limnoria: start writing Limnoria guide

											
										
										
											2012-11-04 14:27:26 +02:00
+								<title>
 								Installing &amp; running Limnoria.
 								</title>
-												articles/guides/Limnoria: fix CSS address

											
										
										
											2012-11-04 14:29:26 +02:00
+								<link rel="stylesheet" type="text/css" href="../../tyyli.css" />
-												articles/guides/Limnoria: start writing Limnoria guide

											
										
										
											2012-11-04 14:27:26 +02:00
+								</head>
 								<body>
 								<hr/>
 								<a href="../../sitemap/sitemap.html">Sitemap</a>
 								<hr/>
 								<h1 id="installing">Installing</h1>
-												Limnoria: add [] around what will  become links

											
										
										
											2012-11-04 14:36:50 +02:00
+								<p>There are three ways to install [Limnoria] depending on your operating system. If you are on Debian-based Linux distribution e.g. [Debian], [*Ubuntu], [Linux Mint] you can install the Debian package. Or then you can install from source which should work on all other OSes too (at least Mac OS X, I don't have successful experience with Windows) and you can also install for current user only.</p>
-												articles/guides/Limnoria: start writing Limnoria guide

											
										
										
											2012-11-04 14:27:26 +02:00
+								<h2 id="with-the-debian-package">With the Debian package</h2>
 								<p><strong>This method requires root access.</strong></p>
 								<p>First become root by running</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>sudo su</code></pre>
-												articles/guides/Limnoria: start writing Limnoria guide

											
										
										
											2012-11-04 14:27:26 +02:00
+								<p>Then download the Debian package. Here you have to choice do you install the stable version or testing version.</p>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>Replace &quot;VERSIONHERE&quot; with &quot;master&quot; to get stable version or &quot;testing&quot; to get testing version.</p>
-												articles/guides/Limnoria: start writing Limnoria guide

											
										
										
											2012-11-04 14:27:26 +02:00
+								<pre><code>wget http://compiler.progval.net/limnoria-VERSIONHERE-HEAD.deb
 								dpkg -i limnoria-VERSIONHERE-HEAD.deb
 								apt-get install -f</code></pre>
 								<p>The &quot;apt-get install -f&quot; tries to fix broken packages by downloading and installing missing depedencies if there are them.</p>
 								<h3 id="upgrading">Upgrading</h3>
 								<p>To upgrade just run the steps above. Remember that the Debian packages are daily builds, so they are changed every day. You can see the latest change on [compiler.progval.net]. The &quot;-HEAD&quot; packages are always the most recent version.</p>
-												Limnoria: add [] around what will  become links

											
										
										
											2012-11-04 14:36:50 +02:00
+								<h2 id="from-source">From source</h2>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>I recommend that you have [git] installed, because it will make upgrading easier and you don't have to find the [download links] from [GitHub].</p>
 								<p>If you are going to do a global installation you might want to become root now, otherwise skip the next command</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>sudo su</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>Now download (or &quot;clone&quot;) the git repository.</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>git clone git://github.com/ProgVal/Limnoria.git</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>move into the cloned repository</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>cd Limnoria</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>and decide do you want install stable or testing version.</p>
 								<p>In case you want the testing version, change into the testing branch. If you want the stable version skip this.</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>git checkout -b testing origin/testing</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>Now if you are root and what global installation, you run</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>python setup.py install</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>or local installation</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>python setup.py install --user</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>Limnoria is now installed and you can move to configuring it.</p>
 								<p><strong>[Arch Linux] users (and users of other distributions which use python3 by default instead of python&quot;): REPLACE &quot;python&quot; WITH &quot;python2&quot; in all commands!</strong></p>
 								<h3 id="upgrading-1">Upgrading</h3>
 								<p>Return to the git repository or if you have removed it, follow the installation steps again.</p>
 								<p>Update the cloned repository by running</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>git pull</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>and then reinstall</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>python setup.py install</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>or only for current user</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>python setup.py install --user</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<hr/>
 								<h1 id="configuring-the-bot">Configuring the bot</h1>
 								<p>If you installed [Limnoria] as root, you can skip the next section and move to &quot;running Supybot-wizard&quot;.</p>
 								<h2 id="preparing-locally-installed-limnoria-for-use">Preparing locally installed Limnoria for use</h2>
 								<p>Limnoria's binaries were installed to ~/.local/bin which isn't in default $PATH. This means that you must either type the whole path always when you want to run Limnoria or add ~/.local/bin to your PATH. We do the previously mentioned.</p>
 								<p>You can add it to the PATH by running the following commands:</p>
 								<pre><code>echo &quot;PATH=$HOME/.local/bin:$PATH&quot; &gt;&gt; ~/.bashrc
 								echo &quot;PATH=$HOME/.local/bin:$PATH&quot; &gt;&gt; ~/.zshrc</code></pre>
 								<p><strong>If you type only one &quot;&gt;&quot; instead of &quot;&gt;&gt;&quot; in those commands, you will replace the content of those files with &quot;PATH=<span class="math"><em>H</em><em>O</em><em>M</em><em>E</em> / . <em>l</em><em>o</em><em>c</em><em>a</em><em>l</em> / <em>b</em><em>i</em><em>n</em>: </span>PATH&quot; instead of appending it into them.</strong></p>
 								<p>then run</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>source .bashrc</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>or with zsh</p>
-												Limnoria: change syntax

											
										
										
											2012-11-04 15:15:06 +02:00
+								<pre><code>source .zshrc</code></pre>
-												Limnoria: type to Supybot-wizard

											
										
										
											2012-11-04 15:02:21 +02:00
+								<p>and you should be able to run the commands without needing to type the whole PATH, so you can now move into configuring.</p>
 								<p><strong>NOTE: You don't need to do this again after upgrading.</strong></p>
 								<h2 id="running-the-supybot-wizard">Running the Supybot-wizard</h2>
-												articles/guides/Limnoria: start writing Limnoria guide

											
										
										
											2012-11-04 14:27:26 +02:00
+								<!-- vim : set ft=html -->