tweemux 1.2.0 → 1.3.0

data/.gemspec

@@ -9,8 +9,8 @@ Working.gemspec(
   #:description => Working.readme_snippet(/== Usage/, /== TODO/),
   :description => 'tweemux host; tweemux at some_machine; plus some more stuff',
   :version => Tweemux::VERSION,
-  :authors => %w(☈king),
-  :email => 'rking-tweemux@sharpsaw.org',
-  :github => 'rking/tweemux',
+  :authors => %w(☈king Ogredude Spaceghost),
+  :email => 'muchmux@sharpsaw.org',
+  :github => 'PeopleAdmin/tweemux',
   :deps => %w(),
 )

data/MacSetup.md

@@ -0,0 +1,77 @@
+Here are the steps to set up a `tweemux host`-capable OS X box.
+
+# One-time setup
+
+First go to the System Preferences
+(⌘ + `Space` → `sys<enter>`, or Apple menu → System Preferences)
+
+![Screenshot of the Apple menu](doc-img/osx/apple-menu.jpg)
+
+You'll need to find the "Sharing" section. On OS X Lion it's under the 3rd
+heading, "Internet & Wireless"
+
+![Screenshot of the "System Preferences" window, pointing at "Sharing"](doc-img/osx/prefs-sharing.jpg)
+
+On the left you'll see a list of services. In the middle is one that says
+"Remote Login", and underneath the hood it is actually good ol' sshd.
+
+![Screenshot of the "Sharing" window](doc-img/osx/remote-login.png)
+
+
+You can do this next part one of two ways: keep adding to the "Only these
+users" list, or just add them all. It's your call, but in my opinion it's OK to
+just do "All users" and then be sure to only add user accounts that are also
+people you trust to SSH in. After all, if they can log in locally, what's the
+big deal if they can log in remotely?
+
+![Screenshot of "All users" radio button selected](doc-img/osx/all-users-radio.png)
+
+
+Now, you should be set to add your first user.
+
+# Per-guest setup
+
+Ask your buddy for their preferred Unix username (that is, what does it say
+when they run `echo $USER` at a terminal?)
+
+While you're at it ask what their Github username is, for use in the `tweemux
+hubkey` step later on.
+
+Now go back to System Preferences, this time to "System → Users & Groups", or
+"System → Accounts" if on Leopard.
+
+![Screenshot of the "System Preferences" window, pointing at "Users & Groups"](doc-img/osx/prefs-users.jpg)
+
+First unlock n00b mode. You know what you're doing.
+
+![Screenshot of the Padlock unlocking](doc-img/osx/unlock-n00b-mode.jpg)
+
+Add a new user by clicking on the little `[+]` near the bottom left.
+
+![Screenshot of the "Users & Groups" window, pointing at the tiny plus](doc-img/osx/add-user.png)
+
+Then:
+
+![Screenshot of Create Account steps](doc-img/osx/create-user.jpg)
+
+Clicking the key brings up the Password Assistant. Use it to set a large random
+password: copy the generated password from the Suggestion field and paste it
+into the two password fields. We won't need to keep track of this password,
+since all authentication will be done with SSH keys.
+
+If you're working with a user that doesn't have public SSH keys (i.e., they
+don't have a working Github account), then you can always fall back to password
+access. But you have to make fun of them every time they login, so they learn
+to not be lame. =P
+
+![Screenshot of Password Assistant](doc-img/osx/password-assistant.png)
+
+At this point you're on track for the remainder of
+[Host Setup](https://github.com/peopleadmin/tweemux#host-usage).
+
+Quickref for those who already read that doc:
+
+tweemux hubkey unixuser github: githubuser # to get their pubkeys
+tweemux forward … # to get a public port
+tweemux host # to start the shareable session
+tweemux log # to watch them come in. Now you can have them `tweemux on …`

data/README.md

@@ -25,10 +25,9 @@ For starters:
 
     gem install tweemux
 
-Then, create the user on your machine (this varies. On decent Unices, it's
-`adduser` or `useradd`. On OS X you can either get an [adduser-like
-script](https://raw.github.com/sharpsaw/mac-dots/master/bin/adduser) or do it
-through the System Preferences GUI).
+Then, create the user on your machine. This process varies.
+* On decent Unices, it's `adduser` or `useradd` then perhaps a bit of tinkering with `/etc/ssh/sshd_config` (rking uses [this script](https://raw.github.com/sharpsaw/linux-dots/master/bin/brogrammer) to cover both of those tasks)
+* On OS X, we've prepared a [Sweet MacSetup doc](MacSetup.md) (thanks @[Ogredude](https://github.com/ogredude))
 
 Now, you can install the 'keyholes' for this user from Github. This means they
 will be able to get in without manually typing a password, just like when they
@@ -38,9 +37,11 @@ will be able to get in without manually typing a password, just like when they
     # or, if their Unix username is their Github username, there's a shorthand:
     tweemux hubkey rking
 
-Now, they'll need a route to your sshd port. If you're on a machine behind a
-firewall, you have these options: Use a VPN, directly open a port, use a host
-on the Internet, or SSH port forward. Tweemux provides a tool for this last one:
+Now, for perhaps the trickiest part: they'll need a route to your sshd port.
+See the [Routing](#Routing) section below for more details, but the short story is: if you're on a
+machine behind a firewall (and most home and business users are), you have
+these options: Use a VPN, directly open a port, use a host on the Internet, or
+SSH port forward. Tweemux provides a tool for this last one:
 
 In this example, sharpsaw.org is a machine that is not behind the firewall:
 
@@ -48,8 +49,14 @@ In this example, sharpsaw.org is a machine that is not behind the firewall:
 
 Then, after your pair can get to your SSHD socket, finally:
 
-    tweemux host
-    # (now they're ready to `tweemux on <yourhost> <your-port>`)
+    tweemux host # starts the shareable session
+    tweemux log # Optional step: watch the ssh logs for them to come in
+
+Now they're ready to `tweemux on <yourhost> <your-port>` !
+
+Keep in mind that most of this setup is one-time or per-user. After you get it
+going, you just rock along with a `tweemux forward…` and `tweemux host` then
+they `tweemux on`. Not much more than that!
 
 ## Going Further
 
@@ -72,13 +79,13 @@ Now you're down to just:
 
     tweemux on smh
 
-## Details about "Route to your sshd port", above
+## Routing
 
 Your options are:
 * VPN. If you're on a business network with your pair, you probably can already `ping` each other's machines. Easy stuff, then.
 * Directly open a port, such as going to your router config (perhaps at http://10.0.0.1 ?) and setting it to pass the external IP (see `curl ifconfig.me` or http://whatismyip.com ) through to your local box. This is smpler once you get it set up, as long as your location is stable and you have control over the router.
 * Use a machine on the Internet, that you both ssh into that. Can work very well, but the big downside is that you now have two lagged users rather than only one.
-* SSH port forward. This is my favorite, but the downside is that you have to have access to a shell account somewhere public.
+* SSH port forward. This is my favorite, but the downside is that you have to have access to a shell account somewhere public. This is where `tweemux forward local 22 from somebox.com 2323` comes in.
 
 ## No Public Box?
 
@@ -92,25 +99,31 @@ There are a few solutions:
 
 - *Use inline comments* to type back and forth. Properly configured shells can also allow you to prefix with a `#` and say whatever you want. The downside is that only one person can be typing at any one time. A custom that helps is if you type what you're saying, then leave a trailing `#` with no space after it to indicate that you're done and waiting on your pair to type. This is a bit crufty, but some people are shy and only want to do the tmux share.
 - *Use IRC*. If you make a tmux pane and connect it to IRC (or some other text-based chat), both local users plus that shared session can all join the same channel. This provides the person that isn't driving the keyboard to switch to their local chat window and type something for the other person to see. (TODO: build this in as a tweemux feature).
-- *Use voice*. A much more powerful way to work. You "can" use Skype, but it's a commercial product and is continuously flaky. A better alternative is to sign up for a [SIP account](https://ekiga.net/), then get a [SIP client](https://en.wikipedia.org/wiki/List_of_SIP_software#Clients). For Linux, I use (Ekiga)[https://en.wikipedia.org/wiki/Ekiga), and for OS X I use [Telephone.app](http://www.tlphn.com/). Don't forget, if you can't get the Internetty stuff to work, there's always calling each other on cell phones.
+- *Use voice*. A much more powerful way to work.
+  * You "can" use Skype, but it's a commercial product and is continuously flaky.
+  * There is also the Google Chat alternative, which is nice in some ways, but also ties you to a commercial entity.
+  * A better alternative is to sign up for a [SIP account](https://ekiga.net/), then get a [SIP client](https://en.wikipedia.org/wiki/List_of_SIP_software#Clients). For Linux, I use (Ekiga)[https://en.wikipedia.org/wiki/Ekiga), and for OS X I use [Telephone.app](http://www.tlphn.com/).
+  * Don't forget, if you can't get the Internetty stuff to work, there's always calling each other on cell phones.
 
 ## TODO
 
 # PeopleAdmin/tweemux open issues
-* 18: Rogue Mode 3
-* 17: Mention Google Voice/Hangouts 1
-* 16: Promote regular tmux session to tweemux
-* 15: Guest usage to connect to a different socket path
-* 14: Add pseudo_restart of 'retry'
-* 13: $TERM
-* 12: Mosh possible
-* 11: Basics of Tmux
-*  8: Port fw without ssh [enhancement] [question]
-*  7: adduser/useradd call [enhancement]
-*  6: Mac setup instructions [easy-peasy] [Mac]
-*  5: log [enhancement] [easy-peasy] [must-have]
-*  4: brew install someurl [Mac]
-*  1: --help and help [easy-peasy] [must-have]
+  27: `tweemux` with no commandline arguments produces ugly error.
+  25: 1.8 + System-wide install
+  23: `tweemux host` from within session should upgrade to shareable
+  22: Provide higher-level window/font sync functionality
+  21: 'tweemux capabilities at ___'
+  19: If tmux isn't in the path when you SSH in, nothing will work. 5
+  18: Rogue Mode 3
+  17: Mention Google Voice/Hangouts 1
+  16: Promote regular tmux session to tweemux
+  15: Guest usage to connect to a different socket path
+  14: Add pseudo_restart of 'retry'
+  12: Mosh possible
+  11: Basics of Tmux
+   8: Port fw without ssh [enhancement] [question]
+   7: adduser/useradd call [enhancement]
+   4: brew install someurl [Mac]
 
 ## Thanks to
 

data/lib/tweemux.rb

@@ -19,9 +19,10 @@ class Tweemux
     end
 
     def understand args
+      args = ['Help'] if args.empty?
       args = ['Version'] if args.first[/^--?v/i]
+      args = ['Help'] if args.first[/^-/]
       # dash args are out of fashion!
-      args = ['Help'] if args.empty? or args.first[/^-/]
       action = args.shift
       klass = Tweemux::Action.const_get action.capitalize
       klass.new args

data/lib/tweemux/version.rb

@@ -1,3 +1,3 @@
 class Tweemux
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,11 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tweemux
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
 - ☈king
+- Ogredude
+- Spaceghost
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -16,7 +18,7 @@ description: ! 'For Remote Pair Programming: A handy script to create-or-join a
 
 
   tweemux host; tweemux at some_machine; plus some more stuff'
-email: rking-tweemux@sharpsaw.org
+email: muchmux@sharpsaw.org
 executables:
 - tweemux
 extensions: []
@@ -27,9 +29,19 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
+- MacSetup.md
 - README.md
 - Rakefile
 - bin/tweemux
+- doc-img/osx/add-user.png
+- doc-img/osx/all-users-radio.png
+- doc-img/osx/apple-menu.jpg
+- doc-img/osx/create-user.jpg
+- doc-img/osx/password-assistant.png
+- doc-img/osx/prefs-sharing.jpg
+- doc-img/osx/prefs-users.jpg
+- doc-img/osx/remote-login.png
+- doc-img/osx/unlock-n00b-mode.jpg
 - img/tweemux.blend
 - img/tweemux.png
 - lib/tweemux.rb
@@ -59,7 +71,7 @@ files:
 - test/tweemux/action/version_test.rb
 - test/tweemux/action_test.rb
 - test/tweemux_test.rb
-homepage: https://github.com/rking/tweemux
+homepage: https://github.com/PeopleAdmin/tweemux
 licenses: []
 post_install_message: 
 rdoc_options: []