X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7d4e2529d04c3649ffecdce7a9e1f9835387454d..0ad0ce519da703b3f13c0ad8a74ea8235b7d90e5:/README diff --git a/README b/README index 733d522352..c7a36c355b 100644 --- a/README +++ b/README @@ -1,30 +1,21 @@ -Sample Arvados web service. +Welcome to Arvados! -usage: arv-web-example.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. This allows you to browse the mounted collection with Apache's -default index page. +If you wish to build the documentation yourself, follow the instructions in +doc/README to build the documentation, then consult the "Install Guide". - -Suggestions for extension: - -Configure the container to use mod_passenger (for an example, -arvados/docker/passenger/Dockerfile) and include both your web app and your -data in your collection. \ No newline at end of file +See COPYING for information about Arvados Free Software licenses.