readme update

Fri, 23 Jun 2017 20:36:19 -0400

author
Meredith Howard <mhoward@roomag.org>
date
Fri, 23 Jun 2017 20:36:19 -0400
changeset 77
0e0bfcf9ffb7
parent 76
9c024e39a565
child 78
fe6ef0cccdf1
child 82
ae08d6315368

readme update

README.md file | annotate | diff | comparison | revisions
--- a/README.md
+++ b/README.md
@@ -1,27 +1,34 @@
-
-
 # Devbox playbook
 
 This is a playbook that installs dev tools and DE tools I like to have around 
 and sets up some other preferences like repositories, and drops in my dotfiles. 
 It's best-tested on Debian, but has some cases for OSX and FreeBSD too.
 
-The `gui_enabled` var controls whether or not to install graphical tools.
+# Interesting Variables
+
+## `gui_enabled`
+
+Boolean. Install and configure GUI tools, or with vim, choose between `gtk` and
+`nox`.
+
+## `disable_stock_users`
+
+Boolean.  Disable stock users like `pi` or `pine64`.
 
 # Running
 
 ## Push
 
-1. Create inventory file with target host.
+1. Create inventory file with target host, maybe extra vars
 2. If we can ssh as root with key, use `-u root`.  If we can sudo, use `-bK`.
-3. GUI box? `-e gui_enabled=true`
-4. `ansible-playbook -i $inventory $args local.yml`
+3. `ansible-playbook -i $inventory $args local.yml`
+4. After the first run, `ansible` management user is created.
 
 ## Pull
 
 1. Install `ansible`, `git`
 2. `echo -e '[localhost]\nlocalhost ansible_connection=local' >> /etc/ansible/hosts`
-2. `ansible-pull -U https://github.com/merrilymeredith/devbox-ansible.git`
+3. `ansible-pull -U https://github.com/merrilymeredith/devbox-ansible.git`
 
 ### cloud-init
 
@@ -38,4 +45,3 @@ runcmd:
 # TODO
 
 - Make pull config install cron entry?
-- Debian 8 ansible is still 1.7 lol

mercurial