Merge pull request #480 from holta/master

clarifs in medium.localvars, default_vars.yml, runansible, 2-common/tasks/iiab_ini.yml, network/tasks/squid.yml, moodle/tasks/main.yml, sugarizer/tasks/main.yml, cups/tasks/main.yml, calibre/tasks/main.yml, nextcloud/tasks/*.yml, kalite/tasks/*.yml, README-historical.md

README-historical.md

@@ -34,8 +34,8 @@ Please read the `installation`_ documentation.
 
 See the `XSCE project`_ for more information about the project.
 
-.. _XSCE wiki: https://github.com/XSCE/iiab/wiki
+.. _XSCE wiki: https://github.com/XSCE/xsce/wiki
-.. _installation: https://github.com/XSCE/iiab/wiki/XSCE-Installation
+.. _installation: https://github.com/XSCE/xsce/wiki/XSCE-Installation
 .. _ansible: http://www.ansibleworks.com/
 .. _ansible documentation: http://www.ansibleworks.com/docs/
 .. _XSCE project: http://schoolserver.org/

roles/2-common/tasks/iiab_ini.yml

@@ -14,7 +14,7 @@
     - option: 'iiab_dir'
       value: '{{ iiab_dir }}'
 
-- name: add version section
+- name: Add version section
   ini_file: dest='{{ iiab_config_file }}'
             section=version
             option='{{ item.option }}'

roles/calibre/tasks/main.yml

@@ -6,13 +6,13 @@
     mode=0755
   when: ansible_distribution == "CentOS"
 
-- name: Install Calibre
+- name: Install Calibre (CentOS)
   shell: "{{ downloads_dir }}/calibre-installer.py >> /dev/null"
   args:
     creates: /usr/bin/calibre-uninstall
   when: calibre_install and ansible_distribution == 'CentOS'
 
-- name: Install Calibre rpms
+- name: Install Calibre (OS's other than CentOS)
 # the fedora rpm arm version, though older, takes care of dependencies, and exists
   package:  name={{ item }}
             state=present
@@ -20,7 +20,7 @@
     - calibre
   when: calibre_install and ansible_distribution != 'CentOS'
 
-- name: Create Calibre service(s) and support scripts
+- name: Create calibre-serve.service and calibre.conf
   template: backup=no
             src={{ item.src }}
             dest={{ item.dest }}
@@ -52,7 +52,7 @@
            state=stopped
   when: not calibre_enabled
 
-- name: Add Calibre to service list
+- name: Add 'calibre-serve' to service list
   ini_file: dest='{{ service_filelist }}'
             section=calibre
             option='{{ item.option }}'

roles/cups/tasks/main.yml

@@ -1,5 +1,5 @@
 # administer this service by browsing to localhost:631
-- name: get the CUPS package installed
+- name: Get the CUPS package installed
   package: name={{ item }}
            state=present
   with_items:
@@ -8,7 +8,7 @@
   tags:
     - download
 
-- name: Put our own config file in place, to permit local lan admin
+- name: Put our own config file in place, to permit local LAN admin
   template: dest=/etc/cups/cupsd.conf
             src=cupsd.conf
 
@@ -22,7 +22,7 @@
         state=link
   when: cups_enabled and is_debuntu
 
-- name: Enable services for cups
+- name: Enable services for CUPS (OS's other than Fedora 18)
   service: name={{ item }}
            state=started
            enabled=yes
@@ -31,17 +31,17 @@
     - cups-browsed
   when: cups_enabled and not is_F18
 
-- name: Enable services for cups for XO laptops
+- name: Enable services for CUPS (Fedora 18, for XO laptops)
   service: name=cups
            state=started
            enabled=yes
   when: cups_enabled and is_F18
 
-- name: Permit headless admin of CUPS -- only works when cups daemon is running
+- name: Permit headless admin of CUPS -- only works when CUPS daemon is running
   shell: "cupsctl --remote-admin"
   when: cups_enabled
 
-- name: Disable services for cups
+- name: Disable services for CUPS (OS's other than Fedora 18)
   service: name={{ item }}
           state=stopped
           enabled=no
@@ -50,13 +50,13 @@
     - cups-browsed
   when: not cups_enabled and not is_F18
 
-- name: Disable services for cups for XO laptops
+- name: Disable services for CUPS (Fedora 18, for XO laptops)
   service: name=cups
            state=stopped
            enabled=no
   when: not cups_enabled and is_F18
 
-- name: add cups to service list
+- name: Add 'cups' to service list
   ini_file: dest={{ service_filelist }}
             section=cups
             option={{ item.option }}
@@ -65,7 +65,7 @@
     - option: name
       value: '"Common UNIX Printing System (CUPS)"'
     - option: description
-      value: '"CUPS  is a modular printing system  which allows a computer to act as a print server. A computer running CUPS is a host that can accept print jobs from client computers, process them, and send them to the appropriate printer."'
+      value: '"CUPS is a modular printing system  which allows a computer to act as a print server. A computer running CUPS is a host that can accept print jobs from client computers, process them, and send them to the appropriate printer."'
     - option: installed
       value: "{{ cups_install }}"
     - option: enabled

roles/kalite/tasks/enable.yml

@@ -1,18 +1,18 @@
 # By the time we get here we should have ka-lite of some version
 # And the systemd unit files should be defined
 
-- name: Enable kalite-serve service
+- name: Enable 'kalite-serve' service
   service: name=kalite-serve
            enabled=yes
            state=started
 
-- name: Disable kalite-serve service
+- name: Disable 'kalite-serve' service
   service: name=kalite-serve
            enabled=no
            state=stopped
   when: not kalite_enabled
 
-# Since Fedora 18 we don't have a separate unit fiile for kalite-cron
+# Since Fedora 18 we don't have a separate unit file for kalite-cron
 
 - name: Disable kalite cron server F18
   service: name=kalite-cron

roles/kalite/tasks/install-f18.yml

@@ -1,6 +1,6 @@
 # This is for Fedora 18, assumed to be an XO
 
-- name: Install dependent packages F18
+- name: Install dependent packages (Fedora 18)
   package: name={{ item }}
            state=present
   with_items:
@@ -8,35 +8,35 @@
     - expect
   when: is_F18
 
-- name: Install dependent pip packages F18
+- name: Install dependent pip packages (Fedora 18)
   pip: name=selenium
-  when: internet_available  and is_F18
+  when: internet_available and is_F18
 
-- name: Determine if kalite is already downloaded
+- name: Determine if KA Lite is already downloaded
   stat: path={{ downloads_dir }}/ka-lite
   register: kalite
 
-- name: Download the latest kalite repo
+- name: Download the latest KA Lite repo
   git: repo={{ kalite_repo_url }}
        dest={{ downloads_dir }}/ka-lite
        depth=1
        version="0.13.x"
   ignore_errors: yes
-  when: internet_available  and kalite.stat.exists is defined and not kalite.stat.exists
+  when: internet_available and kalite.stat.exists is defined and not kalite.stat.exists
 
-- name: Create iiab-kalite user and password F18
+- name: Create iiab-kalite user and password (Fedora 18)
   user: name={{ kalite_user }}
         password={{ kalite_password_hash }}
         update_password=on_create
 
-- name: Create kalite_root directory F18
+- name: Create kalite_root directory (Fedora 18)
   file: path={{ kalite_root }}
         owner=root
         group=root
         mode=0755
         state=directory
 
-- name: Copy the kalite repo into place F18
+- name: Copy the KA Lite repo into place (Fedora 18)
   command: "rsync -at {{ downloads_dir }}/ka-lite/ {{ kalite_root }}"
 
 - name: Make kalite_user owner
@@ -54,7 +54,7 @@
             group={{ kalite_user }}
             mode=0644
 
-- name: Create kalite service(s) and support scripts
+- name: Create kalite-serve & kalite-cron services, and iiab_cronservectl.sh
   template: backup=no
             src={{ item.src }}
             dest={{ item.dest }}

roles/kalite/tasks/install.yml

@@ -1,6 +1,6 @@
 # This is for an OS other than Fedora 18
 
-- name: Install missing packages required for kalite startup
+- name: Install missing packages required for KA Lite startup
   package: name={{ item }}
            state=present
   with_items:
@@ -10,7 +10,7 @@
   get_url: url={{ kalite_requirements }} dest={{ pip_packages_dir }}/kalite.txt
   when: internet_available
 
-- name: Install ka-lite dependencies with pip
+- name: Install KA Lite dependencies with pip (debuntu)
   pip: requirements={{ pip_packages_dir }}/kalite.txt
        virtualenv={{ kalite_venv }}
        virtualenv_site_packages=no
@@ -19,7 +19,7 @@
 #       extra_args="--disable-pip-version-check"
   when: internet_available and is_debuntu
 
-- name: Install ka-lite with pip
+- name: Install KA Lite with pip (OS's other than debuntu) 
   pip: name=ka-lite-static
        version={{ kalite_version }}
        virtualenv={{ kalite_venv }}
@@ -29,7 +29,7 @@
 #       extra_args="--disable-pip-version-check"
   when: internet_available and is_debuntu
 
-- name: Install ka-lite dependencies with pip
+- name: Install KA Lite dependencies with pip (debuntu)
   pip: requirements={{ pip_packages_dir }}/kalite.txt
        virtualenv={{ kalite_venv }}
        virtualenv_site_packages=no
@@ -37,7 +37,7 @@
 #       extra_args="--disable-pip-version-check"
   when: internet_available and not is_debuntu
 
-- name: Install ka-lite with pip
+- name: Install KA Lite with pip (OS's other than debuntu)
   pip: name=ka-lite-static
        version={{ kalite_version }}
        virtualenv={{ kalite_venv }}
@@ -46,7 +46,7 @@
 #       extra_args="--disable-pip-version-check"
   when: internet_available and not is_debuntu
 
-- name: Default is to have cronserve started with kalite
+- name: Default is to have cronserve started with KA Lite
   set_fact:
      job_scheduler_stanza: ""
 
@@ -55,7 +55,7 @@
      job_scheduler_stanza: "--skip-job-scheduler "
   when: not kalite_cron_enabled
 
-- name: Create kalite service(s) and support scripts
+- name: Create 'kalite-serve' service, kalite.sh and kalite.conf
   template: backup=no
             src={{ item.src }}
             dest={{ item.dest }}

roles/kalite/tasks/main.yml

@@ -2,17 +2,17 @@
 
 # Assume all XOs are F18 and nothing else is
 
-- name: Calc kalite db file name F18
+- name: Calc KA Lite db file name (Fedora 18)
   set_fact:
      kalite_db_name: "{{ kalite_root }}/kalite/database/data.sqlite"
   when: is_F18
 
-- name: Calc kalite db file name
+- name: Calc KA Lite db file name (OS's other than Fedora 18)
   set_fact:
      kalite_db_name: "{{ kalite_root }}/database/data.sqlite"
   when: not is_F18
 
-- name: See if kalite is already configured
+- name: See if KA Lite is already configured
   stat: path="{{ kalite_db_name }}"
   register: kalite_installed
 
@@ -34,7 +34,7 @@
 
 - include_tasks: enable.yml
 
-- name: Add kalite to service list
+- name: Add 'kalite-serve' to service list
   ini_file: dest='{{ service_filelist }}'
             section=kalite
             option='{{ item.option }}'
@@ -43,7 +43,7 @@
     - option: name
       value: kalite
     - option: description
-      value: '"KA-Lite is a server to present Khan Academy videos offline and to download them."'
+      value: '"KA Lite is a server to present Khan Academy videos offline and to download them."'
     - option: path
       value: "{{ kalite_root }}"
     - option: server_name

roles/kalite/tasks/setup-f18.yml

@@ -1,11 +1,11 @@
 # This is for Fedora 18, assumed to be an XO
 
-- name: Run the setup using kalite manage F18
+- name: Run the setup using 'kalite manage' (Fedora 18)
   command: "/usr/bin/su {{ kalite_user }} -c '{{ kalite_root }}/bin/kalite manage setup --username={{ kalite_user }} --password={{ kalite_password }} --noinput'"
   async: 900
   poll: 10
 
-- name: Finish setup by running kalite start F18
+- name: Finish setup by running 'kalite start' (Fedora 18)
   command: "/usr/bin/su {{ kalite_user }} -c '{{ kalite_root }}/bin/kalite start'"
   async: 900
   poll: 10

roles/kalite/tasks/setup.yml

@@ -7,7 +7,7 @@
         mode=0755
         state=directory
 
-- name: Run the setup using kalite manage
+- name: Run the setup using 'kalite manage'
   command: "{{ kalite_program }} manage setup --username={{ kalite_admin_user }} --password={{ kalite_admin_password }} --noinput"
   environment:
      KALITE_HOME: "{{ kalite_root }}"

roles/moodle/tasks/main.yml

@@ -21,11 +21,11 @@
     - php{{ php_version }}-cli
   when: is_debuntu
 
-- name: php-zip debian 8-9 changed name
+- name: php-zip name for Debian 9 or Ubuntu
   package: name=php{{ php_version }}-zip
   when: is_debian_9 or is_ubuntu
 
-- name: php-zip debian 8-9 changed name
+- name: php-zip name for Debian 8
   package: name=php-pclzip
   when: is_debian_8
 

roles/network/tasks/squid.yml

@@ -98,6 +98,6 @@
     - option: name
       value: dansguardian
     - option: description
-      value: '"DansGuardian searches web content for obectionable references and denies access when found."'
+      value: '"DansGuardian searches web content for objectionable references and denies access when found."'
     - option: enabled
       value: "{{ dansguardian_enabled }}"

roles/nextcloud/tasks/main.yml

@@ -9,14 +9,14 @@
 # but we use the tar file to get the latest version
 
 - name: Get the Nextcloud software
-  get_url: url={{ nextcloud_dl_url }}/{{ nextcloud_src_file }}  dest={{ downloads_dir }}/{{ nextcloud_src_file }}
+  get_url: url={{ nextcloud_dl_url }}/{{ nextcloud_src_file }} dest={{ downloads_dir }}/{{ nextcloud_src_file }}
   when: internet_available
   async: 900
   poll: 15
   tags:
     - download
 
-- name: Ubuntu and Debian treat names differently
+- name: Ubuntu and Debian treat names differently (Debian)
   package: name={{ item }} state=present
   with_items:
     - libapache2-mod-php{{ php_version }}
@@ -24,7 +24,7 @@
     - php{{ php_version }}-zip
   when: is_debian
 
-- name: Ubuntu and Debian treat names differently
+- name: Ubuntu and Debian treat names differently (Ubuntu)
   package: name={{ item }} state=present
   with_items:
     - libapache2-mod-php
@@ -33,7 +33,7 @@
     - php-mbstring
   when: is_ubuntu
 
-- name: Install list of packages for debuntu
+- name: Install list of packages (debuntu)
   package: name={{ item }} state=present
   with_items:
     - php{{ php_version }}-gd
@@ -44,7 +44,7 @@
     - php{{ php_version }}-mcrypt
   when: is_debuntu
 
-- name: Install list of packages
+- name: Install list of packages (redhat)
   package: name={{ item }} state=present
   with_items:
     - php
@@ -58,14 +58,14 @@
 #    - php-imagick
   when: is_redhat
 
-- name: Copy it to permanent location /opt
+- name: Copy it to permanent location /opt (OS's other than Fedora 18)
   unarchive: src={{ downloads_dir }}/{{ nextcloud_src_file }}
              dest={{ nextcloud_prefix }}
              creates={{ nextcloud_prefix }}/nextcloud/version.php
   when: not is_F18
 
 # ansible 1.4.1 does not have "creates"
-- name: Copy it to permanent location /opt
+- name: Copy it to permanent location /opt (Fedora 18)
   unarchive: src={{ downloads_dir }}/{{ nextcloud_src_file }}
              dest={{ nextcloud_prefix }}
   when: is_F18
@@ -75,7 +75,7 @@
         state=directory
   when: is_centos
 
-- name: Add autoconfig file
+- name: Add autoconfig file (CentOS)
   template: src=autoconfig.php.j2
             dest={{ nextcloud_prefix }}/nextcloud/config/autoconfig.php
             owner={{ apache_user }}

roles/nextcloud/tasks/nextcloud_enabled.yml

@@ -1,10 +1,10 @@
  # This should go in computed_network.yml, but here for now
-- name: Compute nextcloud listen ip addr for nextcloud.conf
+- name: Compute Nextcloud listen ip addr for nextcloud.conf
   set_fact:
      nextcloud_required_ip: "{{ ansible_default_ipv4.network }}/{{ ansible_default_ipv4.netmask }}"
   when: ansible_default_ipv4.network is defined
 
-- name: Enable nextcloud by copying template to httpd config
+- name: Enable Nextcloud by copying template to httpd config
   template: src=nextcloud.conf.j2
             dest=/etc/{{ apache_config_dir }}/nextcloud.conf
             owner=root
@@ -12,7 +12,7 @@
             mode=0644
   when: nextcloud_enabled
 
-- name: Enable nextcloud
+- name: Enable Nextcloud
   file: path=/etc/apache2/sites-enabled/nextcloud.conf
         src=/etc/apache2/sites-available/nextcloud.conf
         state=link
@@ -23,18 +23,18 @@
         state=absent
   when: not nextcloud_enabled and is_redhat
 
-- name: Restart apache, so it picks up the new aliases
+- name: Restart Apache, so it picks up the new aliases
   service: name={{ apache_service }} state=restarted
 
 # the install wizard does not succeed if already installed
-- name: Determine if nextcloud is installed
+- name: Determine if Nextcloud is installed
   shell: >
          sudo -u {{ apache_user }} php
          '{{ nextcloud_prefix }}/nextcloud/occ' status |
          gawk '/installed:/ { print $3 }'
   register: returned
 
-- name: Run nextcloud initial install wizard
+- name: Run Nextcloud initial install wizard
   shell: >
          cd {{ nextcloud_prefix }}/nextcloud;
          sudo -u {{ apache_user }}  php occ maintenance:install
@@ -46,13 +46,13 @@
          --admin-pass "{{ nextcloud_admin_password }}"
   when: nextcloud_enabled and returned.stdout == "false"
 
-- name: allow access from all hosts and ips
+- name: Allow access from all hosts and ips
   command: php '{{ nextcloud_prefix }}/nextcloud/occ' config:system:set trusted_domains 1 --value=*
   become: true
   become_user: "{{ apache_user }}"
   when: nextcloud_enabled and returned.stdout == "false"
 
-- name: Determine if nextcloud user exists already
+- name: Determine if Nextcloud user exists already
   shell: >
          sudo -u {{ apache_user }} php
          '{{ nextcloud_prefix }}/nextcloud/occ' user:list |
@@ -60,7 +60,7 @@
   register: returned_count
 
 # nextcloud wants to make users rather than just mysql users and not done
-- name: create the default user
+- name: Create the default user
   shell: >
         su -s /bin/sh {{ apache_user }} -c
         'OC_PASS={{ nextcloud_user_password }};

roles/sugarizer/tasks/main.yml

@@ -93,6 +93,6 @@
        - option: name
          value: Sugarizer
        - option: description
-         value: '"The Sugar Learning Platform is a leading learning platform that began in the famous One Laptop Per Child project. Sugarizer is a web implementation of that platform."'
+         value: '"The Sugar Learning Platform began with the famous One Laptop Per Child project, written in Python. Sugarizer is the new HTML/JavaScript implementation of Sugar, usable in most all browsers."'
        - option: enabled
          value: "{{ sugarizer_enabled }}"

runansible

@@ -11,15 +11,15 @@ if [ ! -f ./vars/local_vars.yml ]; then
 
     case $OS in
         OLPC | fedora)
-        cp ./vars/olpc.localvars ./vars/local_vars.yml
+            cp ./vars/olpc.localvars ./vars/local_vars.yml
-        ;;
+            ;;
         centos | debian | ubuntu | raspbian)
-        cp ./vars/medium.localvars ./vars/local_vars.yml
+            cp ./vars/medium.localvars ./vars/local_vars.yml
-        ;;
+            ;;
         *)
-        echo "IIAB supports raspbian, debian, ubuntu, centos, and OLPC - exiting now..."
+            echo "IIAB supports raspbian, debian, ubuntu, centos, and OLPC - exiting now..."
-        exit 1
+            exit 1
-        ;;
+            ;;
     esac
 fi
 

vars/default_vars.yml

@@ -26,9 +26,20 @@ service_filelist: "{{ iiab_config_file }}"
 disregard_network: False  # use cache or error out if cache does not exist
 
 # Users and Passwords
-# obtain a password hash with - python -c 'import crypt; print crypt.crypt("<plaintext>", "$6$<salt>")'
+
+# Uncomment the following if you don't want iiab_admin_user (by default
+# iiab-admin) to be auto-created in roles/iiab-admin/tasks/main.yml
+# Also disables sudo-based verification of published passwords.
+
+# no_admin: ""
+
+# If no_admin variable is established above (its actual value is IGNORED) also
+# set iiab_admin_user (below) to an existing Linux user that has sudo access.
+# This is the username you'll use to login to Admin Console @ http://box/admin
 
 iiab_admin_user: iiab-admin
+
+# Obtain a password hash with: python -c 'import crypt; print crypt.crypt("<plaintext>", "$6$<salt>")'
 iiab_admin_passw_hash: $6$xsce51$D.IrrEeLBYIuJkGDmi27pZUGOwPFp98qpl3hxMwWV4hXigFGmdSvy3s/j7tn6OnyTTLmlV7SsN0lCUAFzxSop.
 
 # Languages

vars/medium.localvars

@@ -6,6 +6,18 @@
 
 # Original Idea: branch github.com/xsce/xsce-local for your deployment
 
+# Users and Passwords
+
+# Uncomment the following if you don't want iiab_admin_user (by default
+# iiab-admin) to be auto-created in roles/iiab-admin/tasks/main.yml
+# Also disables sudo-based verification of published passwords.
+
+# no_admin: ""
+
+# If no_admin variable is established above (its actual value is IGNORED) also
+# set iiab_admin_user (below) to an existing Linux user that has sudo access.
+# This is the username you'll use to login to Admin Console @ http://box/admin
+
 iiab_admin_user: iiab-admin
 
 # Obtain a password hash with: python -c 'import crypt; print crypt.crypt("<plaintext>", "$6$<salt>")'
@@ -35,6 +47,7 @@ iiab_gateway_enabled: False
 # Make this False to disable http://box/common/services/power_off.php button:
 allow_apache_sudo: True
 
+# Stages 3 & 4 must be run (using iiab-install or runtags) if changing these:
 squid_install: False
 squid_enabled: False