some fixes, mostly to the readme

Author: progrium

.gitignore

@@ -0,0 +1 @@
+build

Dockerfile

@@ -3,6 +3,7 @@ MAINTAINER Jeff Lindsay <progrium@gmail.com>
 
 ADD ./build/logspout /bin/logspout
 
+ENV DOCKER unix:///tmp/docker.sock
 ENV ROUTESPATH /mnt/routes
 VOLUME /mnt/routes
 

Makefile

@@ -5,6 +5,10 @@ build/container: build/logspout Dockerfile
 build/logspout: *.go
 	go build -o build/logspout
 
+release:
+	docker tag logspout progrium/logspout
+	docker push progrium/logspout
+
 .PHONY: clean
 clean:
 	rm -rf build

README.md

@@ -1,28 +1,46 @@
 # logspout
 
-A log router and HTTP interface for Docker container log streams, made to run inside Docker. Besides the routes you make, it's a stateless log appliance. It's not meant for managing log files or looking at history, just a means to get your logs out to live somewhere else, where they belong.
+A log router for Docker container log streams that runs entirely inside Docker. It attaches to all containers on a host, then routes their logs wherever you want. Other than the routes you make, it's a stateless log appliance. It's not meant for managing log files or looking at history, just a means to get your logs out to live somewhere else, where they belong.
 
-## Getting and running
+## Getting logspout
 
 Logspout is a (very small) Docker container, so you can just pull it from the index:
 
 	$ docker pull progrium/logspout
 
-When running logspout, it exposes port 8000 and needs two mounts. The first is the Docker Unix socket. The second is a directory to persist routes. We mount both with `-v`:
+### Using logspout
 
-	$ docker run -d -P \
-		-v=/var/run/docker.sock:/var/run/docker.sock \
-		-v=/var/lib/logspout:/mnt/routes \
+#### Route all logs to remote syslog
+
+The simplest way to use logspout is to just take all logs and ship to a remote syslog. Just pass a default syslog target URI as the command. Also, we always mount the Docker Unix socket with `-v` to `/tmp/docker.sock`:
+
+	$ docker run -v=/var/run/docker.sock:/tmp/docker.sock progrium/logspout syslog://logs.papertrailapp.com:55555
+
+Logs will be tagged with the container name. The hostname will be the hostname of the logspout container, so you probably want to set it to the hostname of the host by adding `-h $HOSTNAME`.
+
+#### Inspect log streams using curl
+
+Whether or not you run it with a default routing target, if you publish it's port 8000, you can connect with curl to see your local aggregated logs in realtime.
+
+	$ docker run -d -p 8000:8000 \
+		-v=/var/run/docker.sock:/tmp/docker.sock \
 		progrium/logspout
+	$ curl $(docker port `docker ps -lq` 8000)/logs
+
+You should see a nicely colored stream of all your container logs. You can also filter by name, ID, log type, and more. Or you can get JSON objects, or you can upgrade to WebSocket and get JSON logs in your browser.
+
+See [Streaming Endpoints](#streaming-endpoints) for more details.
+
+#### Create custom routes via HTTP
+
+Along with streaming endpoints, logspout also exposes a `/routes` resource to create and manage routes. 
 
-Both need to be mounted in these specific paths inside the container, but where you keep the routes on the host could be anywhere. It could also be a regular Docker volume. If you don't mount a volume at `/mnt/routes`, it will only store routes in memory.
+	$ curl $(docker port `docker ps -lq` 8000)/logs -X POST \
+		-d '{"source": {"filter": "db", "types": ["stderr"]}, target": {"type": "syslog", "addr": "logs.papertrailapp.com:55555"}}'
 
-You can optionally pass an argument to install a catch-all route in the form `<type>://<addr>`. For example, to route all logs via syslog to `192.168.1.111:514`, run like this:
+That example creates a new syslog route to [Papertrail](https://papertrailapp.com) of only `stderr` for containers with `db` in their name. 
 
-	$ docker run -d -P \
-		-v=/var/run/docker.sock:/var/run/docker.sock \
-		-v=/var/lib/logspout:/mnt/routes \
-		progrium/logspout syslog://192.168.1.111:514
+By default, routes are ephemeral. But if you mount a volume to `/mnt/routes`, they will be persisted to disk. 
 
 ## HTTP API
 

attacher.go

@@ -33,7 +33,7 @@ func NewAttachManager(client *docker.Client) *AttachManager {
 		assert(client.AddEventListener(events), "attacher")
 		for msg := range events {
 			debug("event:", msg.ID[:12], msg.Status)
-			if msg.Status == "create" {
+			if msg.Status == "start" {
 				go m.attach(msg.ID[:12])
 			}
 		}

logspout.go

@@ -193,8 +193,7 @@ func main() {
 			return http.StatusBadRequest, "Bad request: " + err.Error()
 		}
 
-		// TODO: validate
-
+		// TODO: validate?
 		router.Add(route)
 
 		w.Header().Add("Content-Type", "application/json")