!DO NOT MERGE! Stripped branch

README.md

@@ -9,69 +9,77 @@ Git management is handled via [etckeeper](http://etckeeper.branchable.com/)
 
 New servers added to the pool will also have this configuration to give users an equal experience.
 
+## Requirements ##
+
+  * Debian 7+
+
 ## Contribution ##
 
-You can "Fork" and "Pull Request" any changes you would like to see on our
-servers.
+Making changes to this repo will require a running #! [shell server](https://github.com/hashbang/shell-server).
 
-If you would like to have particular package installed in #! shell servers, add it to packages.txt and send a pull request.
-While we accept most pull requests, packages that require X11 as dependency will not be merged.
+An easy way to set this up locally is by running our latest shell-server 
+[Docker image](https://hub.docker.com/r/hashbang/shell-server/).
 
-## Requirements ##
+A command like the following can get you going with a local development server:
 
-  * Debian 7+
+```
+docker run -d \
+  -v /sys/fs/cgroup:/sys/fs/cgroup:ro \
+  -v $PWD:/etc-git \
+  -v $HOME/.gitconfig:/root/.gitconfig:ro \
+  --name shell-server \
+  --cap-add SYS_ADMIN \
+  hashbang/shell-server
+```
+
+From here you can enter this environment with:
+
+```
+docker exec -it shell-server bash
+```
+
+In this environment you can make updates and install packages with ```apt-get```.
+Changes will automatically be committed and pushed to your working shell-etc
+checkout by etckeeper. Assuming you chose to mount your .gitconfig above, the
+changes should be attributed correctly as you.
+
+Any changes made to /etc without apt-get will need to be committed/pushed in
+place, which should be reflected in your local checkout as well.
+
+When you are ready to contribute your changes upstream, please push to a branch
+or a fork and make a pull request.
+
+Note: the above workflow is only suitable for making very basic changes like
+new package installations etc. If you want to do something more complex that
+requires interaction with a user database, etc, please consider using our
+end-to-end local development setup, documented here: [hashbang/hashbang](https://github.com/hashbang/hashbang)
+
+### GPG signing ###
+
+If you prefer to GPG sign your commits, a couple of options exist.
+
+#### Manual ####
+
+You can manually sign your most recent commit before pushing with:
+
+```
+git commit -S --amend
+```
+
+#### Automatic ####
+
+Assuming you use git auto-signing and have ssh-agents set up properly,
+you can opt to expose your gpg/ssh sockets by adding the following arguments
+to your docker run command:
 
-## Installation ##
-
-1. Adjust partitions to match fstab.sample
-
-    To do this on a VPS (Super hacky but works):
-
-    1. Go to the "Virtual Console" feature in your provider.
-    2. Reboot to Grub bootloader screen
-    3. Hit <Enter> on first boot option
-    4. Add ```break=premount``` to the end of the kernel line
-    5. <Ctrl-X> to boot
-    6. Copy rootfs files into ram
-      ```
-      mkdir /mnt
-      modprobe ext4
-      mount /dev/sda1 /mnt
-      cp -R /mnt/* /
-      umount /dev/sda1
-      ```
-    7. Shrink rootfs and create /home partition
-      ```
-      e2fsck -f /dev/sda1
-      resize2fs /dev/sda1 20G
-      echo "d
-      1
-      n
-      p
-      1
-
-      +20G
-      w
-      n
-      p
-      2
-
-
-      " | fdisk /dev/sda1
-      ```
-    8. Reboot
-
-    9. Adjust fstab to match: [fstab.sample](https://raw.githubusercontent.com/hashbang/shell-etc/master/fstab.sample)
-
-    10. Reboot
-
-2. Run setup script
-
-    ```bash
-    ssh $INSTANCE_IP
-    wget https://raw.githubusercontent.com/hashbang/shell-etc/master/setup.sh
-    bash setup.sh
-    ```
+```
+...
+  -v $HOME/.gitconfig:/root/.gitconfig:ro \
+  -v $HOME/.gnupg:/root/.gnupg \
+  -v $SSH_AUTH_SOCK:/root/.ssh-agent \
+  -e SSH_AUTH_SOCK=/root/.ssh-agent \
+...
+```
 
 ## Notes ##