Browse files

add popcorn-client install documentation

  • Loading branch information...
1 parent 112b65a commit 80d11f012916b94e02343f91079eeae5312b94da @mapleoin committed Sep 20, 2012
Showing with 85 additions and 1 deletion.
  1. +76 −0 popcorn/templates/download.html
  2. +1 −1 popcorn/templates/index.html
  3. +1 −0 popcorn/templates/layout.html
  4. +7 −0 popcorn/views.py
View
76 popcorn/templates/download.html
@@ -0,0 +1,76 @@
+{% extends "layout.html" %}
+
+{% block content %}
+{% filter textile %}
+
+h2. Installing
+
+The popcorn client is a simple python script which runs on a pre-determined interval. It collects data from the local RPM database and then sends a POST request to the popcorn server.
+
+h3. openSUSE
+
+Downloading and installing the __popcorn__ is easy if you're an openSUSE user as we maintain an OBS repository with the packaged client.
+
+Add the repository for your openSUSE version:
+
+h4. Factory
+
+pre. zypper ar http://download.opensuse.org/repositories/home:/axitkhurana/openSUSE_Factory/home:axitkhurana.repo
+
+h4. 12.1
+
+pre. zypper ar http://download.opensuse.org/repositories/home:/axitkhurana/openSUSE_12.1/home:axitkhurana.repo
+
+h4. 11.4
+
+pre. zypper ar http://download.opensuse.org/repositories/home:/axitkhurana/openSUSE_11.4/home:axitkhurana.repo
+
+
+Then install popcorn:
+
+pre. zypper install popcorn
+
+The popcorn client will then run in the background and make new submissions once every 7 days.
+
+You can run it manually as well if you prefer; just run @popcorn@ from the command line. The output should look like this:
+
+pre. $ popcorn
+Submission received. Thanks!
+
+
+h3. Fedora, RHEL, Mandriva, SLES, CentOS
+
+We build packages in OBS for all the above distributions, but they are currently not as well tested as the openSUSE packages. You can choose your distribution package version from this "List of repositories":https://build.opensuse.org/project/repositories?project=home%3Aaxitkhurana and then *Go to download repository@ and add the repository to your system manually.
+
+You then have to install popcorn using your distribution's package manager. The package's name is *popcorn*. Then run the popcorn:
+
+pre. $ popcorn
+Submission received. Thanks!
+
+
+h3. Sources
+
+If you just want to run popcorn manually, that's also easy. You'll need to have the @rpm-python@ package installed first.
+
+Then just download the python script and the configuration script:
+
+pre. wget https://raw.github.com/openSUSE/popcorn/master/client/popcorn
+$ wget https://github.com/openSUSE/popcorn/blob/master/client/popcorn.conf
+
+Place the configuration script in the @/etc@ directory:
+
+pre. mv popcorn.conf /etc
+
+And run popcorn:
+
+pre. $ ./popcorn
+Submission received. Thanks!
+
+If you got an error, we'd like to "hear about it":https://github.com/openSUSE/popcorn/issues/new.
+
+You should be able to see the data which was sent to the popcorn server in popcorn's log at @/var/log/popcorn.log@.
+
+
+
+{% endfilter %}
+{% endblock %}
View
2 popcorn/templates/index.html
@@ -50,7 +50,7 @@
h3(#how-you-can-help). How you can help
-The best way to help right now (and the easiest) if you're an RPM-based Linux distribution user is to *install popcorn-client* and then forget about it. It will send us the data we need to make your distribution better for you.
+The best way to help right now (and the easiest) if you're an RPM-based Linux distribution user is to "install popcorn-client":/download and then forget about it. It will send us the data we need to make your distribution better for you.
If you're a developer you might want to check out "the sources":http://github.com/opensuse/popcorn and hack something on the server. It's mostly python under an MIT License. Look for bugs in our "issue tracker"https://github.com/opensuse/popcorn/issues or think up new features. We're really open to contributions even if you're not so experienced.
View
1 popcorn/templates/layout.html
@@ -29,6 +29,7 @@
<li><a href="#">Submissions</a></li>
</ul>
<li class="divider"></li>
+ <li><a href="/download">Download</a></li>
<li><a href="#">FAQ</a></li>
<li><a href="#">Contribute</a></li>
<li><a href="#">Contact</a></li>
View
7 popcorn/views.py
@@ -202,3 +202,10 @@ def distro_doc():
def api():
"""Document the popcorn API"""
pass
+
+
+@app.route('/download')
+@render(template='download.html')
+def download():
+ """Document the popcorn client installation procedure"""
+ pass

0 comments on commit 80d11f0

Please sign in to comment.