From 17b3eb6967b944e8e500190d57c79978c1f9fd57 Mon Sep 17 00:00:00 2001 From: drebs Date: Mon, 6 Jun 2016 21:21:04 -0300 Subject: [doc] improve docker script docs --- scripts/docker/files/setup-env.sh | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'scripts/docker/files/setup-env.sh') diff --git a/scripts/docker/files/setup-env.sh b/scripts/docker/files/setup-env.sh index 1df1c825..d5aeab7d 100755 --- a/scripts/docker/files/setup-env.sh +++ b/scripts/docker/files/setup-env.sh @@ -3,6 +3,17 @@ # Clone soledad repository and install soledad dependencies needed to run # client and server in a test environment. # +# In details, this script does the following: +# +# - clone a series of python package repositories into /var/local/soledad. +# - install dependencies for those packages from the requirements files in +# each of the repositories, using python wheels when possible. +# - install the python packages in development mode +# +# The cloned git repositories might have a remote configured and a branch +# checked out on runtime, before a server, client or test instance is actually +# run. Check the other scripts in this directory. +# # This script is meant to be copied to the docker container and run after # system dependencies have been installed. -- cgit v1.2.3