Getting Started

ProjectCards is a client-server application. You must install the server on one machine. On all the other machines, you just install the client. You can install both the server and the client on the same machine.

Minimum requirement (Client/Server)

The minimum requirements are based on those of Java 6. So your OS must support Java 6 and it is recommended to have 128 mb of memory for Windows and 64 MB for Linux.

Starting ProjectCards for the First Time

If the client is on the same machine as the server, use "localhost" for the server name. The server is installed on port number 51630 by default. If you have specified a different port while installing the server, make sure all of your users are informed of the port number used.

Initial user/password

Once you have installed the application, login with the default username "admin" and the password "projectcards".


Choose the instructions you need

Windows
Eclipse
Linux
Mac

Installation instructions

Windows

Windows

First installation (client and server)

  1. Download and run the full installer
  2. Follow instructions and customize for your installation
  3. Enjoy!

Client-only installer (to deploy to other clients)

  1. Download and run the client-only installer
  2. Follow instructions and customize for your installation
  3. Enjoy!

Update

If you are updating the client or the server from a previous version, a quicker way is to download the upgrade installer.

eclipse

Eclipse

Client plugin

Download the plugin and copy the jar file to the plugins directory of your Eclipse installation (ECLIPSE_HOME/plugins).

linux

Linux Server

The variety of Linux distributions and desktop choices makes it a little more difficult to supply a simple installer.
We are planning a packaging solution for a future release.
So, we tried to be as explicit as we can. But you must be ready to adapt the following instructions to your particular installation.
We will greatly appreciate any tips you can give us to improve this page and the installation process.

linux

Linux Debian distribution

  1. Install the latest Tomcat 
    sudo apt-get install tomcat6
  2. Dowload and extract the server installation somewhere (PCARDS_INSTALL) 
    tar xzvf projectcards-server-x.x.x.tar.gz
  3. Install the web application into Tomcat's webapps directory (${CATALINA_BASE}/webapps) 
    sudo cp PCARDS_INSTALL/projectcards.war /var/lib/tomcat6/webapps
  4. Install the context file into Tomcat's (${CATALINA_BASE}/conf/Catalina/localhost) 
    sudo cp PCARDS_INSTALL/projectcards.xml /var/lib/tomcat6/conf/Catalina/localhost
  5. Configure the ProjectCardsDataPath value in the projectcards.xml file, specifying where ProjectCards saves its data.
    Example: change value="/srv/projectcards-projects" to the proper path on your server. 
    sudo vi /var/lib/tomcat6/conf/Catalina/localhost/projectcards.xml
    NOTE: tomcat6 user must have read/write access to the data directory. You might have to do this: 
    sudo chown tomcat6\: /srv/projectcards-projects/
  6. Install the server libraries into Tomcat's lib directory (${CATALINA_HOME}/lib). 
    sudo cp -t /usr/share/tomcat6/lib PCARDS_INSTALL/tomcat-lib/*.jar
  7. (Optional) The default port of Tomcat is 8080. If you want to change the default port, edit and save the server.xml file 
    sudo vi /etc/tomcat6/server.xml
    Replace:
    Connector port="8080"    WITH    Connector port="51630"
  8. (Optional) By default, Tomcat automatically expands and deploys new contexts from the .war files in the /webapps directory. In production servers, it is highly recommended to disable the auto-deploy feature. If you want to do so, edit and save the server.xml file, in the <Host> element. 
    sudo vi /etc/tomcat6/server.xml
    Replace:
    unpackWARs="true" autoDeploy="true"    WITH    unpackWARs="false"  autoDeploy="false"
  9. Restart Tomcat's server 
    sudo /etc/init.d/tomcat6 restart
  10. Test the ProjectCards web services by accessing the 'http://localhost:8080/projectcards/ProjectProvider' page. You should see the WSDL description for the ProjectCards' web services.
  11. Enjoy!
linux

Linux Client

Minimum requirements : The client requires GTK and Java 6 must be installed.

  1. Download and extract the client installation
  2. To run ProjectCards using GTK, run ./projectcards.sh
  3. To run ProjectCards using GTK-PPC or on Linux 64 bits, run ./setup.sh, select the desired platform, run ./projectcards.sh

NOTE: You can adjust the path towards your desired java executable in the .sh scripts. By default, it simply calls "java" with no path information.

linux

Enabling Linux server reports

  1. Dowload and extract the server installation somewhere (PCARDS_INSTALL) 
    tar xzvf projectcards-server-x.x.x.tar.gz
  2. Install the web reports into Tomcat's webapps directory (${CATALINA_BASE}/webapps) 
    sudo cp -r PCARDS_INSTALL/pc-reports /var/lib/tomcat6/webapps
  3. Install the reports context file into Tomcat's (${CATALINA_BASE}/conf/Catalina/localhost) 
    sudo cp PCARDS_INSTALL/pc-reports.xml /var/lib/tomcat6/conf/Catalina/localhost
    NOTE: tomcat6 user must have read/write access to the report's directory. You might have to do this: 
    sudo chown -R tomcat6\: /var/lib/tomcat6/webapps/pc-reports
  4. Configure reports in ProjectCards client
    • Start ProjectCards Client and open a project
    • Go to menu Manage > Configure server tasks
    • Check 'Enable Report Generation Task'
    • Set the report path. Example: /var/lib/tomcat6/webapps/pc-reports
  5. Consult your reports at http://localhost:8080/pc-reports
mac

Mac Client

  1. Make sure you have GTK and Java 6 installed.
  2. Download and extract the client installation file
  3. run ./setup.sh
  4. Select 'Mac' as the desired platform

NOTE: You can adjust the path towards your desired java executable in the .sh scripts. By default, it simply calls "java" with no path information.

mac

Mac Server

  1. Make sure Macports is installed(http://www.macports.org/)
  2. Dowload and extract the server installation somewhere (PCARDS_INSTALL) 
    tar xzvf projectcards-server-x.x.x.tar.gz
  3. Install the latest Tomcat6 : 
    sudo port -b install tomcat6
  4. Install the web application into Tomcat's webapps directory (${CATALINA_BASE}/webapps) : 
    sudo cp PCARDS_INSTALL/projectcards.war /opt/local/share/java/tomcat6/webapps
  5. Install the context file into Tomcat's (${CATALINA_BASE}/conf/Catalina/localhost) 
    sudo cp PCARDS_INSTALL/projectcards.xml /opt/local/share/java/tomcat6/conf/Catalina/localhost
  6. Configure the ProjectCardsDataPath value in the projectcards.xml file, specifying where ProjectCards saves its data.
    Example: change value="/srv/projectcards-projects" to the proper path on your server. 
    sudo vi /opt/local/share/java/tomcat6/conf/Catalina/localhost/projectcards.xml
    NOTE: tomcat6 user must have read/write access to the data directory. You might have to do this: 
    sudo chown _www:_www /opt/local/projectcards-projects/
  7. Install the server libraries into Tomcat's lib directory (${CATALINA_HOME}/lib). 
    sudo cp -t /opt/local/share/java/tomcat6/lib PCARDS_INSTALL/tomcat-lib/*.jar
  8. (Optional) The default port of Tomcat is 8080. If you want to change the default port, edit and save the server.xml file 
    sudo vi /opt/local/share/java/tomcat6/conf/server.xml
    Replace:
    Connector port="8080"    WITH    Connector port="51630"
  9. (Optional) By default, Tomcat automatically expands and deploys new contexts from the .war files in the /webapps directory. In production servers, it is highly recommended to disable the auto-deploy feature. If you want to do so, edit and save the server.xml file, in the <Host> element. 
    sudo vi /etc/tomcat6/server.xml
    Replace:
    unpackWARs="true" autoDeploy="true"    WITH    unpackWARs="false"  autoDeploy="false"
  10. Restart Tomcat's server 
    sudo /opt/local/share/java/tomcat6/bin/tomcatctl restart
  11. Test the ProjectCards web services by accessing the 'http://localhost:8080/projectcards/ProjectProvider' page. You should see the WSDL description for the ProjectCards' web services. Note : Remember to use port 51630 instead of 8080 if you changed it.
  12. Enjoy!
mac

Enabling Mac server reports

  1. Dowload and extract the server installation somewhere (PCARDS_INSTALL) 
    tar xzvf projectcards-server-x.x.x.tar.gz
  2. Install the web reports into Tomcat's webapps directory (${CATALINA_BASE}/webapps) 
    sudo cp -r PCARDS_INSTALL/pc-reports /opt/local/share/java/tomcat6/webapps
  3. Install the reports context file into Tomcat's (${CATALINA_BASE}/conf/Catalina/localhost) 
    sudo cp PCARDS_INSTALL/pc-reports.xml /opt/local/share/java/tomcat6/conf/Catalina/localhost
    NOTE: tomcat6 user must have read/write access to the report's directory. You might have to do this: 
    sudo chown _www:_www /opt/local/share/java/tomcat6/webapps/pc-reports
  4. Configure reports in ProjectCards client
    • Start ProjectCards Client and open a project
    • Go to menu Manage > Configure server tasks
    • Check 'Enable Report Generation Task'
    • Set the report path. Example: /opt/local/share/java/tomcat6/webapps/pc-reports
  5. Consult your reports at http://localhost:8080/pc-reports

User's guide

Our User's guide is your best source of information. If you have any suggestion on how to improve this guide, do not hesitate to contact us at support@projectcards.com