Main |

Requirements:

Download and install all packages listed on the main page under the Requirements section.  If you are using debs, then try and use debs for all packages possible. Goto Xperience, Inc.'s .org site for instructions on the sources.list entry to use.

Actual installation steps:

Install the PCX Portal package (either from deb or tarball).
For hints look at the README file.

Setup the portal.  Run /usr/lib/pcx_portal/setup.pl.

Create the databases.
Note: If using PostgreSQL and database sessions, you must be using PostgreSQL 7.1 or greater.
Run /usr/lib/pcx_portal/setupDB.pl

Common questions are:

• Can the Portal create the necessary databases automatically?
  Yes, but only if using PostgreSQL 7.3.x, at this time. You will need to set the Database Server = '127.0.0.1', or your local IP, for this to work and you will not be able to have the billing database on a seperate host. The setupDB.pl script will check to make sure that tcp connections are enabled and will attempt to enable them for you if they are not. Also, the pg_hba.conf file will attempt to be updated to allow access so the installer can create the specified portal db user and then create the necessary databases.
• Can I use an IP Address for my server?
  NO, not if you want cookies to work.  You must use a FQDN so that your browser knows to send the cookie back. The Portal relies on cookies, so you must use a FQDN.
• What type of server should I run (http or https)?
  If you are at all worried about security then you should use https for the server connections.  This will require that your web server supports SSL, etc.
• What is the meaning of the cookie domain?
  The cookie domain is the domain part of your hostname so that cookies are properly set in the browser and then sent to the server when needed. As of 0.2.00 you can now specify the full host name as the cookie domain value. This will allow you to limit the cookies to just a single server, but then you can not spread your Portal across multiple servers.
  An example would be: server = www.test.com, cookie domain = .test.com
  Due to interest, I will be looking into using just an IP Address for the hostname and thus figuring out how to make cookies work in this scenario.
• Do I need to enable file uploads?
  If you are planning on using XIWA and would like to import .QIF files, then you need to enable this feature.
  Note: It now defaults to allowing file uploads, so if in doubt just say Yes.
  Eventually the upload file size limit will be specifiable in human readable terms (4M, 4k, etc.)

Now create the default company and administrative user in the portal by running /usr/lib/pcx_portal/create_default_account.pl.
Common questions are:

• What is the code?
  The code being asked for is the unique identifier for a company.  This allows you to have companies that share the same name but have different codes.
  Ex. Company = Xperience, Inc., code = PCX

Now import the colorSchemes that are defined for the Portal by running /usr/lib/pcx_portal/colorSchemeInstall.pl --appname Portal.

The following scripts will go away when portal apps are implemented to do the required functionality:
If you need to add other users then run /usr/lib/pcx_portal/create_user.pl.
If you need to add other companies then run /usr/lib/pcx_portal/create_company.pl.

Test:

The PCX Portal should now be installed and usable.  Try going to the server you defined when configuring the Portal via setup.pl.  It usually is http(s)://servername/portal/.

If you have any problems/questions please use the help forums on the SF Project page.

Installing Applications into the Portal:

Install the application (either from deb or tarball).
Run /usr/lib/pcx_portal/application/setup.pl to configure the application.
Run /usr/lib/pcx_portal/application/appinstall.pl to install the application into the Portal.

Run /usr/lib/pcx_portal/colorSchemeInstall.pl --appname application to install any ColorScheme entries for that application.

Read any README or INSTALL files that the application provides to see if there are any other steps required (ex. creating databases, etc.)