Add 'apps/arv-web/' from commit 'f9732ad8460d013c2f28363655d0d1b91894dca5'
[arvados.git] / apps / arv-web / README
1 Run a web service from Arvados.
2
3 usage: arv-web.py [-h] --project PROJECT [--port PORT] --image IMAGE
4
5 optional arguments:
6   -h, --help         show this help message and exit
7   --project PROJECT  Project to watch
8   --port PORT        Local bind port
9   --image IMAGE      Docker image to run
10
11
12 This queries an Arvados project and FUSE mounts the most recently modified
13 collection into a temporary directory.  It then runs the supplied Docker image
14 with the collection bind mounted to /mnt inside the container.
15
16 When a new collection is added to the project, or an existing project is
17 updated, it will detect the change, it will stop the running Docker container,
18 unmount the old collection, mount the new most recently modified collection,
19 and restart the Docker container with the new mount.
20
21 The supplied Dockerfile builds a Docker image that runs Apache with /mnt as the
22 DocumentRoot.  It is configured to run web applications based on Python WSGI,
23 Ruby Rack, CGI, to serve static HTML, or simply browse the contents of the
24 /public subdirectory of the collection using Apache's default index pages.
25
26 To build the Docker image:
27
28 $ docker build -t arvados/arv-web .