- modules/fotolab updated imagej to current version & some cod fixes to make it work

[care2x.git] / Care2007 / INSTALL

Care2X - Installation \r
------------------------------------------------------------------------------\r
\r
This guide explains how to install Care2x using the new automatic installer.\r
\r
Contents: \r
  1. Prerequisites\r
  2. Download Care2x Package\r
  3. Automatic Installer\r
    3.1. Introduction\r
    3.2. Collect Information\r
      3.2.1. Database Information\r
      3.2.2. System Administrator User\r
      3.2.3. Network Protocol and Domain\r
      3.2.4. Encryption Keys\r
    3.3. System Checks\r
    3.4. License Agreement\r
    3.5. System Installation\r
    3.6. Optional Components\r
    3.7. Finish Installation\r
  4. Post installation\r
\r
\r
\r
1. Prerequisites\r
-------------------\r
\r
Care2x is a PHP web application. It requires several program components to be \r
installed on the system before the installation. This includes:\r
    * the PHP (http://www.php.net) scripting language;\r
    * a web server;\r
    * a database server. \r
\r
Check the System Requirements page \r
(http://care2x.org/wiki/index.php/System_Requirements) for detailed information \r
about the supported component types and versions.\r
\r
\r
2. Download Care2x Package\r
-----------------------------\r
\r
Download the latest Care2x release package from the project's download section \r
(http://sourceforge.net/project/showfiles.php?group_id=53886&package_id=48463). \r
Typically, you should download the .zip package for Windows installation and \r
the .tar.gz package for Linux/Unix installation.\r
\r
Extract the downloaded package into the document directory of your web server.\r
\r
You may extract the package right in the document root directory of your web \r
server. In this case Care2x will be accessible with URL http://your_host/, \r
where your_host is the host of your server computer.\r
\r
Or, you may extract the package in a subdirectory of the document root \r
directory of your web server. In this case Care2x will be accessible with URL \r
http://your_host/sub_dir/, where your_host is the host of your server computer \r
and sub_dir is the subdirectory where you have extracted the package.\r
\r
You may need to restart your web browser to make the Care2x application \r
available.\r
\r
\r
3. Automatic Installer\r
-------------------------\r
\r
Open your web browser and access the Care2x automatic installer.\r
\r
If you have extracted the Care2x package in the web server's document root \r
directory then you have to access URL http://your_host/installer/.\r
\r
Or, if you have extracted the Care2x package in the web server's document root \r
subdirectory then you have to access URL http://your_host/sub_dir/installer/.\r
\r
The welcome page of the Care2x automatic installer will be displayed in your \r
web browser.\r
\r
3.1. Introduction\r
--------------------\r
\r
NOTE: During the installation process do not use the navigation buttons (Back, \r
Forward, etc.) of your web browser. Instead, use the navigation buttons inside \r
the web pages of the automatic installer as described in this guide.\r
\r
Click on the Continue... hyperlink that will bring you to the Collect \r
Information step of the installation process.\r
\r
\r
3.2. Collect Information\r
---------------------------\r
\r
You are asked to give important information that will be used for the \r
installation of Care2x.\r
\r
The information is divided in several categories.\r
\r
\r
3.2.1. Database Information\r
------------------------------\r
\r
Fill the fields with information about your database server that will contain \r
the working data of the Care2x system:\r
    * Server Type. Choose the type of your database server, all available \r
database types can be chosen from the drop-down list.\r
    * User Name. Give the user name of the account to access the database.\r
    * Password. Give the password of the database user.\r
    * Server Address. Give the network host/address where the database server \r
can be accessed. If you want to specify port of the database server, use the form host:port.\r
    * Database Name. Give the name of the database instance where Care2x will \r
be installed to. If you give the name of an existing database, it will be \r
reused, otherwise a database with this name will be created. \r
\r
The installation will create more than hundred tables in the database. All \r
table names starts with prefix care_. Currently, this prefix cannot be \r
configured to another value.\r
\r
If you want to reuse a database that already contains other tables, make sure \r
that there is no table with name starting with prefix care_. Otherwise the \r
installation may fail.\r
\r
\r
3.2.2. System Administrator User\r
-----------------------------------\r
\r
The System Administrator is the most powerful (in terms of rights) user of the \r
Care2x system. This will be the only user that is available on a freshly \r
installed system. It is used for the initial configuration of the system and to \r
create other users that will be used in the normal work with the Care2x system.\r
\r
The System Administrator user is critical for the system. It is very important \r
to choose appropriate user name and password and to keep this information \r
secure.\r
\r
The information that you will provide in this section is the login credentials \r
of the System Administrator user:\r
    * User Name. Give login name for the System Administrator user. The default \r
is admin. It is highly recommended to choose other name.\r
    * Password. Give login password for the System Administrator user. The \r
default is empty password. It is highly recommended to choose good password \r
(http://www.mit.edu/afs/sipb/project/doc/passwords/passwords.html) instead.\r
    * Confirm Password. Give the same password as in the previous field. This \r
is to check that you have entered your password correctly. \r
\r
\r
3.2.3. Network Protocol and Domain\r
-------------------------------------\r
\r
You have to give some information about your web server configuration.\r
    * Transfer Protocol. Choose the prefered transfer protocol to access \r
Care2x. The default is http. If you have SSL \r
(http://www.webopedia.com/TERM/S/SSL.html) module installed with your web \r
server and want more secure access to Care2x then choose https.\r
    * Care2x Host. Enter the host name where Care2x is installed without the \r
http:// or https:// part and without a trailing slash. If you leave this blank \r
or enter wrong information, you will get problems in storing and displaying \r
uploaded images later on. The value should look like care2x_host if Care2x \r
resides in the document root directory of your web server, or like \r
care2x_host/sub_dir if Care2x resides in a subdirectory of the document root. \r
care2x_host should be a host that is accessible from all possible locations \r
that will work with the system. \r
\r
\r
3.2.4. Encryption Keys\r
-------------------------\r
\r
Encryption keys are used to encrypt security sensitive data in the workflow of \r
Care2x.\r
\r
These keys are generated randomly on each installation. It is OK to leave them \r
as is, but if you have any meaningful reason you have to possibility to change \r
their values.\r
    * 1st key. Used for simple chaining protection of scripts.\r
    * 2nd key. Used for accessing modules.\r
    * 3rd key. Used for encrypting cookie information. \r
\r
\r
When you are ready with entering the data, click on the Save button. This will \r
bring you to the System Checks step of the installation process.\r
\r
\r
3.3. System Checks\r
---------------------\r
\r
At this point of the installation process the installer runs a set of tests to \r
check:\r
    * if the data you entered in the previous step is correct;\r
    * if the system meets the requirements to have Care2x installed. \r
\r
If all tests are OK (green check mark) then you can continue to the next step \r
by clicking on the Continue... hyperlink.\r
\r
If there is failed test (red check mark) then you cannot continue with the \r
installation process. You have to try to fix the problem that causes the test \r
to fail. If you succeed then click on the Restart Installation hyperlink to \r
start the installation process from the beginning.\r
\r
If there is test with warning result (yellow check mark) then you can continue \r
with the installation process, but there are possibility that you may run into \r
problem when using Care2x. If you want to continue with the installation \r
process then click on the Continue... hyperlink. If you want first to fix the \r
problem causing the warning then click on the Restart Installation hyperlink \r
after you fix it. This will start the installation process from the beginning.\r
\r
\r
3.4. License Agreement\r
-------------------------\r
\r
Care2x is distributed under the GNU General Public License \r
(http://www.gnu.org/licenses/gpl.html) (GNU GPL).\r
\r
Read the license displayed on this page of the installer and decide either to \r
agree with the license, or disagree. You have to agree with the license in \r
order to proceed with the installation of Care2x.\r
\r
If you agree with the license then click on the I Agree button. This will start \r
the installation of the Care2x system.\r
\r
If you disagree with the license then click on the I Do NOT Agree button. In \r
this case the installer will refuse to proceed with the installation.\r
\r
More information about the licensing of Care2x you can read on the legal page \r
(http://care2x.org/home_legal.php).\r
\r
\r
3.5. System Installation\r
---------------------------\r
\r
Accepting the license triggers the start of the actual installation process. \r
As the progress bar moves onwards the installer executes the most important \r
installation actions:\r
    * installs the database schema;\r
    * fills the database with general configuration data;\r
    * creates the System Administrator user;\r
    * saves the system configuration data. \r
\r
The above actions should be executed without problem and you will get \r
automatically to the next installation step. If for some reason any of the \r
above actions fail then the whole installation progress will fail too. The \r
error that causes the problem will be displayed. If this happens you can get \r
support in the Care2x mailing list \r
(http://sourceforge.net/mailarchive/forum.php?forum_id=11772).\r
\r
NOTE: On some browser (MS Internet Explorer) the progress bar may freeze after \r
few seconds. This does not mean that the installer is not taking action. It is \r
just the browser that freezes the page rendering because of page refresh \r
action. In this case just wait for the browser to refresh the page.\r
\r
\r
3.6. Optional Components\r
---------------------------\r
\r
At this stage of the installation process your system is already operational. \r
Here you may install some optional components (ICD10 and OPS301 codes). These \r
components are typically large in size and take some time to install, so choose \r
only the ones you need.\r
\r
If you want to install an optional component then choose and click on the \r
Install button.\r
\r
The progress bar indicates the advance of the action. Please, be patient! \r
Optional components may be large and they may need some time to install.\r
\r
After the optional component installs successfully, you may choose to install \r
another one.\r
\r
If you don't want to install more components then click on the Done button to \r
finish the installation.\r
\r
\r
3.7. Finish Installation\r
---------------------------\r
\r
The last step of the installation process is to rename critical installation \r
files. This is made for security reasons. However, it is highly recommended to \r
erase the whole /installer directory.\r
\r
You can now click on the Start using Care2x hyperlink that will bring you to \r
the main page of your freshly installed Care2x system.\r
\r
\r
4. Post installation\r
-----------------------\r
\r
Congratulations! You have completed the installation process of Care2x.\r
\r
The Care2x system is now installed and you can start working on it.\r
\r
However, there are some more things to be done. You have to configure Care2x to \r
fit the needs of your medical institution. This includes definition of \r
departments, wards, doctors, medical products, etc.\r
\r
Follow the Initial Configuration \r
(http://care2x.org/manuals/en_configure_2_1.htm) guide to complete these steps.\r