summaryrefslogtreecommitdiff
path: root/docker
diff options
context:
space:
mode:
authorSteve <nilslice@gmail.com>2017-04-14 17:20:36 -0700
committerGitHub <noreply@github.com>2017-04-14 17:20:36 -0700
commit6268615c2b4590eb8a0ed47bb98d099d70aa0fba (patch)
tree73601233baf9816b8ad6a19bd1ae0fd50247cc2f /docker
parent0ab0ebb14e5794473f312f173c3a7438c1ab2bac (diff)
parent1cee00148b32a23349b9569dc6c9fba187888767 (diff)
Merge pull request #115 from krismeister/ponzu-dev
[docker] Development Dockerfile for ponzu
Diffstat (limited to 'docker')
-rw-r--r--docker/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..6b65643
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,22 @@
+# TODO: remove from here and add to wki
+
+## Ponzu Docker build
+
+Ponzu is distributed as a [docker image](https://hub.docker.com/r/ponzu/ponzu/), which aids in docker deployment. The Dockerfile in this directory is used by ponzu to generate the docker image which contains the ponzu executable.
+
+### The following are convenient commands during development of Ponzu core.
+
+#### Build the docker image. Run from the root of the project.
+```bash
+# from the root of ponzu:
+docker build -t ponzu-dev
+```
+
+#### Start the image, share the local directory and pseudo terminal (tty) into for debugging:
+```bash
+docker run -v $(pwd):/go/src/github.com/ponzu-cms/ponzu -it ponzu-dev
+pwd # will output the go src directory for ponzu
+ponzu version # will output the ponzu version
+# make an edit on your local and rebuild
+go get github.com/ponzu-cms/ponzu/...
+```