X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/f9732ad8460d013c2f28363655d0d1b91894dca5..210883bcb2428ad0262a4b064c56612de0a22ef6:/README diff --git a/README b/README index 826092d447..c7a36c355b 100644 --- a/README +++ b/README @@ -1,28 +1,21 @@ -Run a web service from Arvados. +Welcome to Arvados! -usage: arv-web.py [-h] --project PROJECT [--port PORT] --image IMAGE +The main Arvados web site is + https://arvados.org -optional arguments: - -h, --help show this help message and exit - --project PROJECT Project to watch - --port PORT Local bind port - --image IMAGE Docker image to run +The Arvados public wiki is located at + https://arvados.org/projects/arvados/wiki +The Arvados public bug tracker is located at + https://arvados.org/projects/arvados/issues -This queries an Arvados project and FUSE mounts the most recently modified -collection into a temporary directory. It then runs the supplied Docker image -with the collection bind mounted to /mnt inside the container. +For support see + http://doc.arvados.org/user/getting_started/community.html -When a new collection is added to the project, or an existing project is -updated, it will detect the change, it will stop the running Docker container, -unmount the old collection, mount the new most recently modified collection, -and restart the Docker container with the new mount. +Installation documentation is located at + http://doc.arvados.org/install -The supplied Dockerfile builds a Docker image that runs Apache with /mnt as the -DocumentRoot. It is configured to run web applications based on Python WSGI, -Ruby Rack, CGI, to serve static HTML, or simply browse the contents of the -/public subdirectory of the collection using Apache's default index pages. +If you wish to build the documentation yourself, follow the instructions in +doc/README to build the documentation, then consult the "Install Guide". -To build the Docker image: - -$ docker build -t arvados/arv-web . +See COPYING for information about Arvados Free Software licenses.