Merge branch 'feature/installer-fixes'

COPYING.StarSDR

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

decoder.sh → bin/decoder.sh

@@ -1,7 +1,8 @@
 #!/bin/sh
 
-ONDD_CACHE="${ONDD_DATA:=/var/spool/ondd}"
-ONDD_DATA="${ONDD_DATA:=/srv/downloads}"
+ONDD_CACHE="${ONDD_DATA:=%CACHE%}"
+ONDD_DATA="${ONDD_DATA:=%DOWNLOADS%}"
+CERT_PATH="%SHAREDIR%/ca.crt"
 
 
 usage() {
@@ -30,8 +31,6 @@ fail() {
   exit 1
 }
 
-[ "$USER" = root ] || fail "This program must be run as root"
-
 while getopts "o:c:" opt; do
   case "$opt" in
     h)
@@ -52,5 +51,7 @@ done
 
 mkdir -p "$ONDD_CACHE"
 mkdir -p "$ONDD_DATA"
+mkdir -p /tmp/run
 
-ondd -V -D /var/run/ondd.data -c "$ONDD_CACHE" -O "$ONDD_DATA"
+ondd -V -D /tmp/run/ondd.data -c "$ONDD_CACHE" -O "$ONDD_DATA" \
+  --cert-file "$CERT_PATH"

demod-presets.sh → bin/demod-presets.sh

@@ -20,7 +20,7 @@ parameters:
 supported profiles:
 
   americas  North and South Americas
-  eurasia   Europe, Africa, Middle East
+  euraf     Europe, Africa, Middle East
   apac      Asia, Pacific
 EOF
 exit 0
@@ -40,11 +40,6 @@ rundemod() {
   demod $ARGS
 }
 
-if [ "$USER" != root ]; then
-  echo "This command must be run as root"
-  exit 1
-fi
-
 [ -z "$1" ] && usage
 
 case "$1" in
@@ -64,6 +59,6 @@ case "$1" in
     updateprofiles
     ;;
   *)
-    echo "ERROR: Unknown profile"
+    echo "ERROR: Unknown profile: $1"
     usage
 esac

demod.sh → bin/demod.sh

@@ -22,20 +22,25 @@ get_radio() {
   [ "$nradios" = 1 ] && echo "$radios"
 }
 
+killmod() {
+  modname="$1"
+  lsmod | grep -q "$modname" && rmmod -f "$modname"
+}
+
 rtlsdr_demod() {
-  rmmod -f dvb_usb_rtl128xxu
+  killmod dvb_usb_rtl128xxu
   rtl_biast -b 1
   sdr100 "$@"
 }
 
 mirics_demod() {
+  killmod miri_sdr
   sdr100 "$@"
 }
 
 radio="$(get_radio)"
 
 # Sanity checks
-[ "$USER" = root ] || fail "This program must be run as root"
 [ -d "$STARSDR_PATH" ] || fail "StarSDR is not installed"
 [ -z "$radio" ] && fail "No usable radio detected"
 

docs/source/index.rst

@@ -19,7 +19,7 @@ in the works.
     encounter.
 
 ==========  ===================================================================
-version     1.0a1
+version     1.0a2
 status      unstable/draft
 ==========  ===================================================================
 

docs/source/install.rst

@@ -5,99 +5,8 @@ In this section, we will install all the necessary software and ensure the
 system is prepared to run it. The next section will discuss the programs'
 usage.
 
-Download locations
-------------------
-
-Before we begin, we need to decide on where to put the downloaded files. There
-are two directories where files will be stored:
-
-- temporary cache directory for unfinished downloads
-- permanent directory for finished downloads
-
-In this guide, we will use ``/var/spool/ondd`` for temporary download cache,
-and ``/srv/downloads`` for finished downloads. Whether you go with these or
-some other locations, it is recommended you write them down for future
-reference.
-
-You can always specify these paths when starting the decoder, but if you don't
-want to keep remembering the command line options, it's easier to set the
-environment variables::
-
-    $ echo 'export ONDD_DATA="/srv/downloads"' | sudo tee -a /etc/profile
-    $ echo 'export ONDD_CACHE="/var/spool/ondd"' | sudo tee -a /etc/profile
-
-An alternative is to create an alias::
-
-    $ alias decoder='sudo /usr/local/bin/decoder -o /srv/downloads -c /var/spool/ondd'
-
-Add the above command to your ``~/.bashrc`` or whatever your shell starup
-file is. 
-
-Regardless of what method you end up using, you'll be able to run the decoder
-without extra arguments once it's installed.
-
-Installing the build tools
---------------------------
-
-The library used by the demodulator will need to be built on your machine, so
-build tools will need to be installed. On most distros, the build tools usually
-come as a single package/metapackage that are named build-essential,
-base-devel, and similar. Additionally pkg-config and development headers for
-libusb 1.0 should also be installed.
-
-Here are some ways to install them on different distros.
-
-Ubuntu/Debian and derivatives::
-
-    $ sudo apt-get install build-essential pkg-config libusb-1.0-0-dev
-
-Fedora::
-
-    $ sudo yum groupinstall "Development Tools" "Development Libraries"
-    $ sudo yum install libusb1 pkgconfig
-
-Arch Linux::
-
-    $ sudo pacman -Sy base-devel pkg-config libusb
-
-Opensuse::
-
-    $ sudo zypper install --type pattern devel_basis
-    $ sudo zypper install pkg-config libusb-1_0
-
-.. note::
-    If your distro is not covered here and you are not sure how to install the
-    build tools, try searching online for 'build-essential equivalent for <your
-    distro name here>'.
-
-Installing StarSDR
-------------------
-
-Download `StarSDR sources
-<https://github.com/Outernet-Project/StarSDR/archive/master.tar.gz>`_ and untar
-it. ::
-
-    $ wget https://github.com/Outernet-Project/StarSDR/archive/master.tar.gz -O starsdr.tar.gz
-    $ tar xvf starsdr.tar.gz
-
-To compile and install::
-
-    $ cd StarSDR-master
-    $ make installables
-    $ sudo make install
-
-.. note::
-    To uninstall, run ``sudo make uninstall`` from the ``StarSDR-master``
-    directory. You don't have to keep the original directory around to do this,
-    though. You can always untar a new tarball and uninstall.
-
-StarSDR libraries are installed in ``/usr/local/sdr.d`` by default. The library
-supports RTL-SDR radios as well as the Mirics ones. These will be automatically
-selected depending on what radio you have, so normally you don't need to do
-anything yourself.
-
-Installing the demodulator and decoder
---------------------------------------
+Installing the softtware
+------------------------
 
 Download the `Outernet demodulator/decoder kit
 <https://github.com/Outernet-Project/outernet-linux-lband/archive/master.tar.gz>`_
@@ -109,6 +18,19 @@ and untar it::
 To install::
 
     $ cd outernet-linux-lband-master
-    $ sudo ./installer.sh install
-
-
+    $ sudo ./installer.sh
+
+During installation, you will be asked to decide whether you wish to configure
+udev. By default, access to the SDR dongles is restricted to root. The udev
+rules relax these rules so that any user can acess them.
+
+You will also be asked to create the temporary download folder as well as the
+download folder. The temporary download folder is used to store incomplete
+downloads, while the download folder is the final destination for the
+downloaded files. You can chose to create these folders later by youself, or
+have the installer create them (default). 
+
+.. warning::
+    If the installer is asked to create the download folders, the created
+    folders will be world-writable (any user will have read-write access to
+    them).

docs/source/intro.rst

@@ -23,6 +23,9 @@ software work together.
     eco-system, which is predominantly open-source, the demodulator and decoder
     are closed-source freeware.
 
+The relevant license files are installed in ``/usr/local/share/outernet``
+folder by the installer.
+
 The software involved in this set-up is meant to be used as long-running
 background processes (a.k.a. daemons). Some of the programs already provide
 features that let them run as proper well-behaved daemons, while others do not.