Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(829)

Unified Diff: runtime/README.md

Issue 367903008: Create a set of Dart dockerfiles (Closed) Base URL: https://github.com/dart-lang/dart_docker.git@master
Patch Set: Created 6 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« runtime/Dockerfile ('K') | « runtime/Dockerfile ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: runtime/README.md
diff --git a/runtime/README.md b/runtime/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d197914c94ae69705878f989a4c3c3836f4c03d4
--- /dev/null
+++ b/runtime/README.md
@@ -0,0 +1,54 @@
+# google/dart-runtime
+
+[`google/dart-runtime`](https://index.docker.io/u/google/dart-runtime)
proppy 2014/07/02 20:55:55 can you update the description to match the python
Søren Gjesse 2014/07/03 10:36:41 Done.
+is a [docker](https://docker.io) base image for easily running a
+[Dart](https://dartlang.org) application.
+
+It can automatically bundle a Dart application with its dependencies and
+set the default entrypoint with no additional `Dockerfile` instructions.
+
+It is based on [`google/dart`](https://index.docker.io/u/google/dart) base
+image.
+
+## Usage
+
+Create a `Dockerfile` in your Dart application directory with the following
+content:
+
+ FROM google/dart-runtime
+
+To build the a docker image tagged with `my/app` run:
+
+ docker build -t my/app .
proppy 2014/07/02 20:55:55 I would remove the my/ prefix (it is not valid)
Søren Gjesse 2014/07/03 10:36:41 Changed to my-app.
+
+To run this image in a container (assuming it is a server application
+listening in port 8080):
+
+ docker run -d -p 8080:8080 my/app
proppy 2014/07/02 20:55:55 I would remove the my/ prefix (it is not valid)
Søren Gjesse 2014/07/03 10:36:41 Changed to my-app.
+
+## Sample
+
+See the [sources](/hello) for
+[`google/dart-hello`](https://index.docker.io/u/google/dart-hello) based
+on this image.
+
+## Notes
+
+The image assumes that your application:
+
+- has a the `pubspec.yaml` and `pubspec.lock` files listing its dependencies.
+- has a file named `bin/server.dart` as the entrypoint script.
proppy 2014/07/02 20:55:55 is that standard to have a bin subdirectory in a d
Søren Gjesse 2014/07/03 10:36:41 Ye, this it the directory structure we are suggest
+- listens on port `8080`
+
+### Example directory laoyout:
+
+ bin
+ server.dart
+ packages
+ ...
+ pubspec.lock
+ pubspec.yaml
+
+When building your application docker image, `ONBUILD` triggers fetch the
+dependencies listed in `pubspec.yaml` and `pubspec.yaml` and cache them
+appropriatly.
« runtime/Dockerfile ('K') | « runtime/Dockerfile ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698