pifi 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0b52109a7d2e0f8ce6fa62b9c87a13079966c6d9cdc4d88bdfb76245e3fad95
-  data.tar.gz: 7250d4469717c956e0fbb81d066fa3a12ac22f934d6cbfbcb69f74a769dde09c
+  metadata.gz: 9e438554830dd34a08a8bbd6c1b50147bd3a57fcd83375ff650ac2e250d13af5
+  data.tar.gz: 5994a88287ab9c58f799cec839f7a2d84d5f2ba849002faba2475769176c6fe0
 SHA512:
-  metadata.gz: c03d08825762b9a79f93359aa42150a77dbc9d3f7133773bf3e2e974827413693ba47c304a8b78a9e050d1648aa45be98b62b623b70053b8b0ac375f51798f46
-  data.tar.gz: d851d8ba1e665ed37620f9ebee9c78d0dee371ebbf0ea80d6835f2e3b04b756ba4554d416ed6544c684e8d1a0c2044a8180a735589bcd282dc160d083b3a9275
+  metadata.gz: fcdd705b344569802b03a03cc0447c8c0b2b6b1dbf2256ba01cf659f46ed2efc901537ea02cf02841610d613e584442c047589fc2a2609bb1fb3bd53327ee0ec
+  data.tar.gz: 843cc7461a81904893dfc052451849eedf3aa36197ede2b2f6cc0dba60b97e6df3f697e9941f6b5f2088af3b14bfd0cf5c30f7f434ed5366a764dcfc4c3411a8

data/INSTALL.md

@@ -21,10 +21,11 @@ $ sudo systemctl start mpd && sudo systemctl enable mpd
 $ sudo gem install pifi --no-ri --no-rdoc
 ```
 
-4. To run PiFi, you'll need a list of radios at `/etc/pifi_streams.json`. Paste this for now:
+4. To run PiFi, you'll need a list of radios at `/etc/pifi/streams.json`. Paste this for now:
 
 ```
-sudo wget https://raw.githubusercontent.com/rccavalcanti/pifi-radio/master/docs/pifi_streams.json.sample -O /etc/pifi_streams.json
+$ sudo mkdir -p /etc/pifi
+$ sudo wget https://raw.githubusercontent.com/rccavalcanti/pifi-radio/master/docs/streams.json.sample -O /etc/pifi/streams.json
 ```
 
 Later, you can edit that JSON file [as described here](README.md#list-of-streams).
@@ -34,8 +35,8 @@ Later, you can edit that JSON file [as described here](README.md#list-of-streams
 Download a sample and edit [following the documentation](README.md#pifi-configuration):
 
 ```
-$ sudo wget https://raw.githubusercontent.com/rccavalcanti/pifi-radio/master/docs/pifi.json.sample -O /etc/pifi.json
-$ sudo -e /etc/pifi.json
+$ sudo wget https://raw.githubusercontent.com/rccavalcanti/pifi-radio/master/docs/config.json.sample -O /etc/pifi/config.json
+$ sudo -e /etc/pifi/config.json
 ```
 
 **Done!** You can now run PiFi with `pifi` and reach it at `http://DEVICE_IP:3000`. Type `pifi -h` to check the options available.
@@ -59,3 +60,7 @@ $ sudo -e /etc/systemd/system/pifi.service
 ```
 
 **Done!** Now you can start PiFi with `sudo systemctl start pifi`. For running at boot, enter `sudo systemctl enable pifi`.
+
+## Advanced deployments
+
+If you need something different from this, [check this document](docs/install_tips.md).

data/README.md

@@ -67,20 +67,37 @@ Although PiFi tries to be minimal, there are some neat features, such as:
 
 ## Installation
 
-While PiFi was imagined for the Pi, it should run on any computer with:
+While PiFi was imagined for the Pi, it should run on any computer with Ruby and MPD.
 
-- Ruby and a few gems
-- MPD
+Install it with:
 
-[Check the installation guide](INSTALL.md).
+```
+$ sudo gem install pifi --no-ri --no-rdoc
+```
+
+Place a list of streams at `/etc/pifi/streams.json`:
+
+```
+$ sudo mkdir -p /etc/pifi
+$ sudo wget https://raw.githubusercontent.com/rccavalcanti/pifi-radio/master/docs/streams.json.sample -O /etc/pifi/streams.json
+```
+
+Make sure MPD is running and start PiFi:
+
+```
+$ sudo systemctl start mpd
+$ pifi
+```
+
+For more detailed steps, [check the installation guide](INSTALL.md).
 
 ## Configuration
 
 ### List of streams
 
-PiFi needs a list of the radios you want to listen. [A example is available here](docs/pifi_streams.json.sample).
+PiFi needs a list of the radios you want to listen. [A example is available here](docs/streams.json.sample).
 
-The list is read by default from `/etc/pifi_streams.json`. You can change this path [creating a configuration file](#pifi-configuration).
+The list is read by default from `/etc/pifi/streams.json`. You can change this path [creating a configuration file](#pifi-configuration).
 
 To keep it simple, the list of streams is just a JSON file with key-value pairs, where the key is the station name, and the value is the streaming URL. For example:
 
@@ -105,15 +122,15 @@ If you want to arrange the stations in categories, add a pair with the category
 
 It's now completely optional to have a configuration file for PiFi. You only need one if you want something different from the defaults.
 
-The path is `/etc/pifi.json` and these are the options:
+The path is `/etc/pifi/config.json` and these are the options:
 
 | Key             | Default                  | Description                                                                                                       |
 | --------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------- |
 | `mpd_host`      | `127.0.0.1`              | MPD host.                                                                                                         |
 | `mpd_port`      | `6600`                   | MPD port.                                                                                                         |
 | `mpd_password`  | `""` (none)              | MPD password.                                                                                                     |
-| `streams_file`  | `/etc/pifi_streams.json` | Path to the JSON file containing the streams.                                                                     |
-| `streamsp_file` | `""` (none)              | Path to JSON file containing additional streams. These will be shown only to the devices listed on `special_ips`. |
+| `streams_path`  | `/etc/pifi/streams.json` | Path to the JSON file containing the streams.                                                                     |
+| `streams_path_priv` | `""` (none)              | Path to JSON file containing additional streams. These will be shown only to the devices listed on `special_ips`. |
 | `special_ips`   | `""` (none)              | The IPs of the devices to show additional streams.                                                                |
 | `play_local`    | `false`                  | Set it to `true` if you want PiFi to play songs from your local library. This shows the "Random" button.          |
 | `serve_static`  | `true`                   | If we should serve static resources. Set it to `false` if your web server is already doing it.                    |
@@ -121,8 +138,9 @@ The path is `/etc/pifi.json` and these are the options:
 If you want to change any of these options, download the sample file and edit it to your needs:
 
 ```
-$ sudo wget https://raw.githubusercontent.com/rccavalcanti/pifi-radio/master/docs/pifi.json.sample -O /etc/pifi.json
-$ sudo -e /etc/pifi.json
+$ sudo mkdir -p /etc/pifi
+$ sudo wget https://raw.githubusercontent.com/rccavalcanti/pifi-radio/master/docs/config.json.sample -O /etc/pifi/config.json
+$ sudo -e /etc/pifi/config.json
 ```
 
 ## Usage

data/docs/install_tips.md

@@ -0,0 +1,41 @@
+# Advanced installation tips
+
+Here I list some tips on more advanced PiFi deployments.
+
+## Running on port 80
+
+You may want to access PiFi without typing a port, as in `http://pi.local` or `http://pifi.local`.
+
+For this, you can install a web server, such as Nginx, Apache or Lighttpd, and set up a reverse proxy. As the precise configuration varies between each of them, please check their documentation.
+
+## Serving static resources from your web server
+
+If you set your web server to reverse proxy PiFi, you may also use it to serve PiFi static assets. This possibly brings some performance gains.
+
+On PiFi configuration, set `serve_static` to false.
+
+On your web server, the exact steps depend on your configuration. You will probably need to set the root of the virtual server to PiFi's static assets directory. This is `${PIFI_DIR}/lib/pifi/public`. Refer to the next section for tips on how to find your `${PIFI_DIR}`. Refer to the documentation of your web server for details.
+
+## Finding PiFi directory
+
+This largely depends on how you installed PiFi and your distro.
+
+- If you installed it with `sudo gem install pifi` on Raspbian, this should be `/var/lib/gems/*/gems/pifi-*`.
+- If you installed with the `gem` command, run `gem environment` and check the paths below "Gem paths".
+- If you are completely lost, you can always run `find / -iname "pifi*" 2>/dev/null`
+
+## Configuring Thin directly
+
+The `pifi` command exposes most Rack CLI options, but you may want to access more advanced configurations from Thin (the application server PiFi uses).
+
+To achieve this, instead of invoking `pifi`, run `thin` and pass PiFi's `config.ru` and the `-e production` flag. The former is located at `${PIFI_DIR}/config.ru`.
+
+For example, if you want to run PiFi on a socket instead of a port:
+
+```
+$ thin start -R ${PIFI_DIR}/config.ru -e production --socket /var/run/pifi/pifi.sock
+```
+
+## Using other application server
+
+If for some reason you don't want to use Thin as the application server, simply run the one you want and pass a `production` flag and the path for PiFi's config.ru (`${PIFI_DIR}/config.ru`).

data/lib/pifi/controllers/application_controller.rb

@@ -5,7 +5,7 @@ require "sinatra/base"
 module PiFi
   class ApplicationController < Sinatra::Base
     set ConfigGetter.new.config
-    set :streams, StreamsGetter.new(settings.streams_file, settings.streamsp_file).streams
+    set :streams, StreamsGetter.new(settings.streams_path, settings.streams_path_priv).streams
 
     set :root, File.expand_path("../../", __FILE__)
 

data/lib/pifi/lib/config_getter.rb

@@ -4,13 +4,13 @@ module PiFi
   class ConfigGetter
     include Utils
 
-    PATH = "/etc/pifi.json"
+    PATH = "/etc/pifi/config.json"
     DEFAULT_KEYS = {
       "mpd_host" => "127.0.0.1",
       "mpd_port" => "6600",
       "mpd_password" => "",
-      "streams_file" => "/etc/pifi_streams.json",
-      "streamsp_file" => "",
+      "streams_path" => "/etc/pifi/streams.json",
+      "streams_path_priv" => "",
       "special_ips" => "",
       "play_local" => false,
       "serve_static" => true

data/lib/pifi/lib/streams_getter.rb

@@ -28,7 +28,7 @@ module PiFi
     def check_paths
       raise ArgumentError, "Streams file not found at '#{@path_pub}'" unless File.file?(@path_pub)
       if ! @path_priv.empty? && ! File.file?(@path_priv)
-        warn "Additional streams file not found at '#{@path_priv}'"
+        warn "Private streams file not found at '#{@path_priv}'"
         @path_priv = ""
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pifi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Rafael Cavalcanti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-22 00:00:00.000000000 Z
+date: 2019-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -87,12 +87,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- INSTALL.md
+- "./INSTALL.md"
+- "./README.md"
 - LICENSE
-- README.md
 - bin/pifi
 - config.ru
 - docs/icon/license.pdf
+- docs/install_tips.md
 - lib/pifi.rb
 - lib/pifi/controllers/application_controller.rb
 - lib/pifi/controllers/index_controller.rb