removed unused imports
[pithos] / BUILD.txt
index 2800472..ced27c2 100644 (file)
--- a/BUILD.txt
+++ b/BUILD.txt
@@ -1,3 +1,14 @@
+Short version\r
+-------------\r
+\r
+# ant install run\r
+\r
+\r
+\r
+Long version\r
+------------\r
+\r
+\r
 Prerequisites\r
 -------------\r
 \r
 Prerequisites\r
 -------------\r
 \r
@@ -6,7 +17,7 @@ Building GSS requires the following software to be installed on your system:
 - Java Development Kit version 1.6.\r
 - Apache Ant version 1.7.\r
 \r
 - Java Development Kit version 1.6.\r
 - Apache Ant version 1.7.\r
 \r
-Running GSS requires a running PostgreSQL server for storing the system's data. Setting up PostgreSQL for gss entails configuring the database to accept connections from the application server and create the appropriate database and user:\r
+Running GSS requires a running PostgreSQL server for storing the system's data. Setting up PostgreSQL for gss entails configuring the database to accept connections from the application server and creating the appropriate database and user:\r
 \r
 # create user gss with password 'gss';\r
 # create database gssdb owner gss encoding 'UTF8';\r
 \r
 # create user gss with password 'gss';\r
 # create database gssdb owner gss encoding 'UTF8';\r
@@ -17,7 +28,7 @@ Then, when the gss server is first launched, the database will be populated with
 Installing and configuring dependencies\r
 ---------------------------------------\r
 \r
 Installing and configuring dependencies\r
 ---------------------------------------\r
 \r
-Run "ant install" from the gss directory to download the various software dependencies (JBoss, GWT, etc.) and install the configuration files. The install task is something that will need be executed again only if the configuration files or dependencies change. This requirement will be explicitly mentioned in the ChangeLog after a new release.\r
+Run "ant install" from the gss directory to download the various software dependencies (JBoss, GWT, etc.) and install the configuration files. The install task is something that will need to be executed again only if the configuration files or dependencies change. This requirement will be explicitly mentioned in the ChangeLog after a new release.\r
 \r
 \r
 Building and running the server\r
 \r
 \r
 Building and running the server\r
@@ -25,7 +36,7 @@ Building and running the server
 \r
 Run "ant run" from the gss directory to build and deploy gss and start JBoss. Use Ctrl/Cmd-C to stop the server. If you want to rebuild and redeploy the service after having made changes to the source code, run "ant deploy" or "ant" without a task name, which does the same thing.\r
 \r
 \r
 Run "ant run" from the gss directory to build and deploy gss and start JBoss. Use Ctrl/Cmd-C to stop the server. If you want to rebuild and redeploy the service after having made changes to the source code, run "ant deploy" or "ant" without a task name, which does the same thing.\r
 \r
-On first launch the database will be empty. If you have successfully setup Shibboleth authentication (see the Authentication section below) you may use existing user credentials to log into the service. If the Shibboleth IdP is itself empty, visit the following URL:\r
+On first launch the database will be empty. If you have successfully setup Shibboleth authentication (see the "Authentication" section below) you may use existing user credentials to log into the service. If the Shibboleth IdP is itself empty, visit the following URL:\r
 \r
 http://127.0.0.1:8080/pithos/register\r
 \r
 \r
 http://127.0.0.1:8080/pithos/register\r
 \r
@@ -85,10 +96,10 @@ Authentication
 \r
 You need to have Shibboleth authentication set up in order to authenticate. The first step in the Shibboleth authentication process is a redirection to a WAYF (Where Are You From) server, for selecting the Identity Provider that has your credentials. You can read more about Shibboleth here: \r
 \r
 \r
 You need to have Shibboleth authentication set up in order to authenticate. The first step in the Shibboleth authentication process is a redirection to a WAYF (Where Are You From) server, for selecting the Identity Provider that has your credentials. You can read more about Shibboleth here: \r
 \r
-http://en.wikipedia.org/wiki/Shibboleth\r
+http://en.wikipedia.org/wiki/Shibboleth_(Internet2)\r
 \r
 Then point a browser to http://127.0.0.1:8080/pithos/ in order to connect to the service.\r
 \r
 \r
 Then point a browser to http://127.0.0.1:8080/pithos/ in order to connect to the service.\r
 \r
-Alternatively, for development purposes, you can use a shortcut in the server to authenticate without Shibboleth. You have to manually initialize a user entry in the database first (using SQL insert) and then set its username in the testUsername property of the jboss\conf\gss.properties configuration file. You can find it deployed in JBOSS_HOME\server\default\conf\gss.properties. The proper URL for using in this scenario is the following, which can be also found in the GWT hosted mode launch configuration:\r
+Alternatively, for development purposes, you can use a shortcut in the server to authenticate without Shibboleth. You have to register a new account (see "Building and running the server" section above) or manually initialize a user entry in the database first (using SQL insert) and then set its username in the testUsername property of the jboss\conf\gss.properties configuration file. You can find it deployed in JBOSS_HOME\server\default\conf\gss.properties. The proper URL for using in this scenario is the following, which can be also found in the GWT hosted mode launch configuration:\r
 \r
 http://127.0.0.1:8080/pithos/login?next=http://127.0.0.1:8080/pithos/\r
 \r
 http://127.0.0.1:8080/pithos/login?next=http://127.0.0.1:8080/pithos/\r