Merge branch 'release/0.3.1'

Author: davidderus

README.md

@@ -1,8 +1,10 @@
-# ansible-rpi 0.3.0
+# ansible-rpi 0.3.1
 
 ## Purpose
 
-Make Raspberry Pi up and running in a few command
+Make Raspberry Pi up and running in a few command.
+
+Tested on a Rpi 3 B+ and a Rpi 1 B.
 
 ## Roles
 
@@ -12,7 +14,7 @@ Make Raspberry Pi up and running in a few command
   - Locale setup
   - System upgrade (*including kernel*)
   - Adding some useful packages (*curl, vim, tmux, git…*)
-  - UFW firewall rules allowing user-specified ports
+  - UFW firewall rules allowing user-specified ports and protocols
   - Logwatch for system status emails (*via SSMTP*)
   - SSH with key-only authentification
   - Custom sudo user for rpi (*thus disabling pi as Rpi sudoer*)
@@ -27,18 +29,14 @@ Make Raspberry Pi up and running in a few command
   - RPC interface for remote monitoring with optionnal SSL encryption
   - Shared downloads directory (*may be replaced by a previously configured network folder*)
 - `media_center`: Turn your Raspberry into a decent customizable media center
-  - Kodi basic installation
+  - Kodi basic installation with separate user
   - Dynamic sources creation (*may be linked to previously configured network folders*)
-  - Buffer handling
-  - Optionnal minimal Openbox setup (*when using a lite image for eg.*)
+  - Buffer handling optimized for a Raspberry
+  - Optionnal `kodi` user with `kodi-standalone` and a minimal Openbox setup
 
 ### Incoming
 
-- `swarm_node`: Run Docker containers in a Rpis Swarm
-
-### TODO
-
-- Use as an ansible module
+- `swarm_node`: Setup a Rpi as a Docker Machine and join a Docker Swarm
 
 ## Setup
 
@@ -56,7 +54,7 @@ cp variables.yml.inc host_vars/my-host.yml
 
 First update the `hosts` file to target your Rpis.
 
-I recommend using an up-to-date Raspbian Lite image.
+I recommend using an up-to-date [Raspbian Lite image](https://downloads.raspberrypi.org/raspbian_lite_latest).
 
 Make sure that the Rpi is SSHable (**latest raspbian lite images come with SSH
 disabled by default, creating a file with name "ssh" in boot partition is

roles/common/tasks/firewall.yml

@@ -1,7 +1,7 @@
 ---
 
 - name: Allow specific ports connections
-  ufw: rule=allow port={{ item }} proto=tcp
+  ufw: rule=allow port={{ item.port }} proto={{ item.proto }}
   with_items:
     - "{{ allowed_ports }}"
 

roles/download_server/tasks/main.yml

@@ -53,8 +53,4 @@
   notify: Restart aria2
 
 - name: Enable aria2 daemon on boot
-  service: name=aria2 enabled=true state=started
-
-- service:
-    name: aria2
-    state: restarted
+  service: name=aria2 enabled=true state=restarted

roles/media_center/defaults/main.yml

@@ -1,5 +1,4 @@
 kodi_apt_repo: "deb http://pipplware.pplware.pt/pipplware/dists/jessie/main/binary /"
-kodi_user_dir: /home/{{ rpi_user_name }}/.kodi
 openbox_config_dir: /home/{{ rpi_user_name }}/.config/openbox
 
 # Arrays of filepaths
@@ -14,4 +13,5 @@ with_kodi_buffering: False
 kodi_read_buffer_factor: 20
 kodi_buffer_size: 139460608
 
-with_kodi_desktop: False
+kodi_username: kodi
+kodi_user_dir: "/home/{{ kodi_username }}/.kodi"

roles/media_center/handlers/main.yml

@@ -0,0 +1,4 @@
+---
+
+- name: Restart kodi
+  service: name=kodi state=restarted

roles/media_center/tasks/base.yml

@@ -0,0 +1,24 @@
+---
+
+# See https://www.raspberrypi.org/documentation/configuration/config-txt.md
+- name: Setup custom config.txt
+  template: src=system/config.txt.j2 dest=/boot/config.txt owner=root group=root mode=0755
+  register: update_config
+
+- name: Create 99-input.rules
+  template: src=system/input-rules dest=/etc/udev/rules.d/99-input.rules owner=root group=root mode=0644
+
+- name: Create 10-permissions.rules
+  template: src=system/permissions-rules dest=/etc/udev/rules.d/10-permissions.rules owner=root group=root mode=0644
+
+- name: Rebooting Rpi
+  shell: sleep 2 && shutdown -r now "Ansible updates triggered"
+  async: 1
+  poll: 0
+  ignore_errors: true
+  when: update_config|changed
+
+- name: Waiting for server to come back
+  local_action: wait_for host={{ inventory_hostname }} state=started delay=30 timeout=300
+  become: false
+  when: update_config|changed

roles/media_center/tasks/desktop.yml

@@ -15,11 +15,11 @@
     - gmrun
     - gnome-terminal
 
-- name: Create openbox config directory
+- name: "Create openbox config directory for {{ rpi_user_name }}"
   file: path="{{ openbox_config_dir }}" owner="{{ rpi_user_name }}" group="{{ rpi_user_name }}" state=directory
   register: create_openbox_config
 
-- name: Setting up default Openbox config
+- name: "Setting up default Openbox config for {{ rpi_user_name }}"
   shell: cp /etc/xdg/openbox/* "{{ openbox_config_dir }}"
   become: yes
   become_user: "{{ rpi_user_name }}"

roles/media_center/tasks/kodi.yml

@@ -0,0 +1,49 @@
+---
+
+- name: Add Kodi 16 Custom Repo
+  apt_repository: repo={{ kodi_apt_repo }}
+
+- name: Add Kodi Repo Key
+  apt_key:
+    url: "http://pipplware.pplware.pt/pipplware/key.asc"
+    state: present
+
+- name: Update APT package cache
+  apt: update_cache=yes cache_valid_time=3600
+
+- name: Install Kodi
+  apt: state=installed pkg=kodi force=yes
+
+- name: Add new user for media center
+  user:
+    name: "{{ kodi_username }}"
+    comment: "Kodi session"
+    password: "{{ kodi_password_hash }}"
+    groups: cdrom,audio,video,plugdev,users,dialout,dip,input,netdev,{{ rpi_shared_group }}
+    state: present
+    append: yes
+
+- name: "Create openbox config directory for {{ kodi_username }}"
+  file: path="/home/{{ kodi_username }}/.config/openbox" owner="{{ kodi_username }}" group="{{ kodi_username }}" state=directory
+
+- name: Enforce Kodi opening in standalone mode
+  lineinfile: dest="/home/{{ kodi_username }}/.config/openbox/autostart"
+              regexp="^/usr/bin/kodi-standalone"
+              line="/usr/bin/kodi-standalone &"
+              create=yes
+              state=present
+  become: yes
+  become_user: "{{ kodi_username }}"
+
+- name: Create current user configuration directories
+  file: path={{ item }} state=directory owner={{ kodi_username }} group={{ kodi_username }} mode=0755
+  with_items:
+    - "{{ kodi_user_dir }}"
+    - "{{ kodi_user_dir }}/userdata"
+
+- name: Build sources file
+  template: src=kodi/sources.xml.j2 dest="{{ kodi_user_dir }}/userdata/sources.xml" owner={{ kodi_username }} group={{ kodi_username }} mode=0600
+
+- name: Enable buffering
+  template: src=kodi/advancedsettings.xml.j2 dest="{{ kodi_user_dir }}/userdata/advancedsettings.xml" owner={{ kodi_username }} group={{ kodi_username }} mode=0600
+  when: with_kodi_buffering

roles/media_center/tasks/main.yml

@@ -1,54 +1,5 @@
 ---
 
-# See https://www.raspberrypi.org/documentation/configuration/config-txt.md
-- name: Setup custom config.txt
-  template: src=system/config.txt.j2 dest=/boot/config.txt owner=root group=root mode=0755
-  register: update_config
-
-- name: Create 99-input.rules
-  template: src=system/input-rules dest=/etc/udev/rules.d/99-input.rules owner=root group=root mode=0644
-
-- name: Create 10-permissions.rules
-  template: src=system/permissions-rules dest=/etc/udev/rules.d/10-permissions.rules owner=root group=root mode=0644
-
-- name: Rebooting Rpi
-  shell: sleep 2 && shutdown -r now "Ansible updates triggered"
-  async: 1
-  poll: 0
-  ignore_errors: true
-  when: update_config|changed
-
-- name: Waiting for server to come back
-  local_action: wait_for host={{ inventory_hostname }} state=started delay=30 timeout=300
-  become: false
-  when: update_config|changed
-
-- name: Add Kodi 16 Custom Repo
-  apt_repository: repo={{ kodi_apt_repo }}
-
-- name: Add Kodi Repo Key
-  apt_key:
-    url: "http://pipplware.pplware.pt/pipplware/key.asc"
-    state: present
-
-- name: Update APT package cache
-  apt: update_cache=yes cache_valid_time=3600
-
-- name: Install Kodi
-  apt: state=installed pkg=kodi force=yes
-
-- name: Create current user configuration directories
-  file: path={{ item }} state=directory owner={{ rpi_user_name }} group={{ rpi_user_name }} mode=0755
-  with_items:
-    - "{{ kodi_user_dir }}"
-    - "{{ kodi_user_dir }}/userdata"
-
-- name: Build sources file
-  template: src=kodi/sources.xml.j2 dest="{{ kodi_user_dir }}/userdata/sources.xml" owner={{ rpi_user_name }} group={{ rpi_user_name }} mode=0600
-
-- name: Enable buffering
-  template: src=kodi/advancedsettings.xml.j2 dest="{{ kodi_user_dir }}/userdata/advancedsettings.xml" owner={{ rpi_user_name }} group={{ rpi_user_name }} mode=0600
-  when: with_kodi_buffering
-
+- include: base.yml
 - include: desktop.yml
-  when: with_kodi_desktop
+- include: kodi.yml

variables.yml.inc

@@ -49,9 +49,10 @@ ssh_custom_banner: True
 # Firewall
 
 allowed_ports:
-  - 22
-  - 6800 # Aria2 Daemon port
-# - 8070 # Kodi Remote Connection
+  - { port: 22, proto: 'tcp' }
+  - { port: 6800, proto: 'tcp' } # Aria2 Daemon port
+# - { port: 8070, proto: 'tcp' } # Kodi HTTPServer Connection
+# - { port: 9777, proto: 'udp' } # Kodi EventServer Connection
 
 # Wifi handling (disabled by default)
 
@@ -113,6 +114,6 @@ with_vim: True
 # kodi_read_buffer_factor: 20
 # kodi_buffer_size: 139460608
 
-# with_kodi_desktop installs a minimal OpenBox desktop based on
-# https://www.prahladyeri.com/blog/2016/02/minimal-debian-desktop-setup.html
-# with_kodi_desktop: True
+# Kodi session name and password are updatable (_default password is `kodi`_)
+# kodi_username: kodi
+# kodi_password_hash: $6$iLBM8EeXOMRMb0I3$gRrJmyVcCeMl.JT7DKLG1XIYDl6/qq6FB99t.IO2Hy87ykxKLSZ0GUVqK/.N7N5gfQMJHiBAAApCM.geeia1z.