Move to RST

LICENSE.md → LICENSE.rst

@@ -1,7 +1,8 @@
-# License (Simplified BSD)
+License (Simplified BSD)
+========================
 
-Copyright (c) Pinry Contributors
-All rights reserved.
+| Copyright (c) Pinry Contributors
+| All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

README.rst

@@ -0,0 +1,75 @@
+docker-pinry
+============
+
+A nice and easy way to get a pinry instance up and running using docker. For
+help on getting started with docker see the `official getting started guide`_.
+For more information on Pinry and a demo check out it's `website`_.
+
+
+Building docker-pinry
+---------------------
+
+Running this will build you a docker image with the latest version of both
+docker-pinry and pinry itself::
+
+  git clone https://github.com/pinry/docker-pinry.git
+  cd docker-pinry
+  docker build -t pinry/pinry .
+
+
+Running docker-pinry
+--------------------
+
+Running the start command for the first time will setup your production secret
+key, database and static files. It is important that you decide what port you
+want and what location on the host machine you wish to store your files. If this
+is the only thing running on your system and you wish to make it public without
+a proxy then you can set ``-p=80:80``. The setting ``-p=10000:80`` assumes you
+are wanting to proxy to this isntance using something like nginx. Also note that
+you must have your host mount directory created first (``mkdir -p /mnt/pinry``)::
+
+  sudo docker run -d=true -p=10000:80 -v=/mnt/pinry:/data pinry/pinry /start
+
+If it's the first run it'll take a few seconds but it will print out your
+container ID which should be used to start and stop the container in the future
+using the commands::
+
+  sudo docker start <container_id>
+  sudo docker stop <container_id>
+
+
+Notes on the run commands
+`````````````````````````
+
+* ``-v`` is the volume you are mounting ``-v=host_dir:docker_dir``
+* ``pinry/pinry`` is simply what I called my docker build of this image
+* ``-d=true`` allows this to run cleanly as a daemon, remove for debugging
+* ``-p`` is the port it connects to, ``-p=host_port:docker_port``
+
+
+Why include nginx and not just map to uwsgi directly?
+-----------------------------------------------------
+
+Because uwsgi/django can't serve static files very well and it is unwise to do
+so for security reasons. I built this so that people can have a full hosted
+solution in a container. If you have a host machine running nginx then of course
+there is no point to run nginx in the container as well, you can simply disable
+nginx, map uwsgi to a port and then set your host machine's nginx to display
+your media and static files since that directory is shared between the container
+and host.
+
+
+Why use sqlite3?
+----------------
+
+Because it has a very low resource cost and most pinry websites are small
+personal ones. Why have a full on database for that? If you need more power
+than you can easily modify the `pinry/settings/production.py` to point to a
+stronger database solution.
+
+
+.. Links
+
+.. _`offical getting started guide`: http://www.docker.io/gettingstarted/
+.. _`website`: http://getpinry.com/
+