This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
setupguide:firstinstall [2015/09/30 16:04] 193.48.0.3 |
setupguide:firstinstall [2016/07/07 10:07] (current) 132.168.72.225 |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Installing the Proline Suite ====== | + | ====== OBSOLETE Installing the Proline Suite ====== |
+ | |||
+ | |||
+ | **This page is an obsolete help file. Please see following description : ** [[setupguide:start#installing_upgrading_the_proline_suite|Install and set up Proline]] | ||
+ | |||
The Proline suite is based on ([[setupguide:start#architecture_overview|different components]]). | The Proline suite is based on ([[setupguide:start#architecture_overview|different components]]). | ||
Line 44: | Line 49: | ||
===== Setting up the Datastore and Proline Server ===== | ===== Setting up the Datastore and Proline Server ===== | ||
- | You can either use the graphical interface ProlineAdmin GUI ==> [[setupguide:setup_with_prolineadmin_gui#setup with prolineadmin gui| How to ]] \\ | + | You can either use the graphical interface ProlineAdmin GUI => [[setupguide:setup_with_prolineadmin_gui#setup with prolineadmin gui| How to ]] \\ |
- | or use the command-line tool ProlineAdmin ==> [[setupguide:setup_with_prolineadmin#setup_with_prolineadmin| How to ]] . | + | or use the command-line tool ProlineAdmin => [[setupguide:setup_with_prolineadmin#setup_with_prolineadmin| How to ]] . |
- | + | ||
- | + | ||
- | ==== Option 2 - Setup with ProlineAdmin (command-line) ==== | + | |
- | + | ||
- | === Set up the Datastore === | + | |
- | + | ||
- | You must first configure ProlineAdmin since this component is used to create the databases needed by Proline. | + | |
- | + | ||
- | Edit the configuration file ''config/application.conf'' located in the ProlineAdmin folder (see [[#configure_prolineadmin|"Configuring ProlineAdmin"]] section below). | + | |
- | Then perform the datastore setup by running the dedicated script. | + | |
- | + | ||
- | == 1. Launch ProlineAdmin == | + | |
- | //Windows users :// \\ | + | |
- | The ProlineAdmin program files are located in the ".\admin" sub-folder of the Proline installation directory. | + | |
- | You should find the following script in this folder: | + | |
- | + | ||
- | <code> | + | |
- | > setup_proline.bat | + | |
- | </code> | + | |
- | + | ||
- | //Linux users or manual installation :// \\ | + | |
- | Execute the ''setup_proline.sh'' script located in the folder obtained after Proline Admin GUI archive file extraction. | + | |
- | + | ||
- | + | ||
- | == 2. Configure ProlineAdmin == | + | |
- | + | ||
- | Modify the following lines to fit your DBMS configuration: | + | |
- | <code> | + | |
- | proline-config { | + | |
- | driver-type = "postgresql" // valid values are: h2, postgresql or sqlite | + | |
- | data-directory = "/Path/to/Proline/Data" //Not used actually... | + | |
- | } | + | |
- | + | ||
- | auth-config { | + | |
- | user="proline_user" //!! SET TO Database Proline user login | + | |
- | password="proline_user_password" //!! SET TO Database Proline user password | + | |
- | } | + | |
- | + | ||
- | host-config { | + | |
- | host="your_postgresql_server_host" //!! Do NOT put "localhost", but the real IP address or fully qualified name | + | |
- | port="5432" //or other port used to access your DBMS | + | |
- | } | + | |
- | </code> | + | |
- | + | ||
- | __Note__: default naming scheme of databases created by Proline can be modified by editing ''config/application-<dbtype>.conf'' file. | + | |
- | + | ||
- | ** Do not confuse: ** | + | |
- | * 'data-directory' under 'proline-config': indicates where to store Proline data (e.g. exports). | + | |
- | * 'postgresql-data-dir': references the PostgreSQL data directory (for ProlineAdmin purposes). \\ | + | |
- | + | ||
- | == 3. Set up the Datastore == | + | |
- | Perform the datastore setup by running the dedicated script. | + | |
- | \\ | + | |
- | \\ | + | |
- | + | ||
- | === Set up Proline Server === | + | |
- | + | ||
- | == Locating the server folder == | + | |
- | + | ||
- | //Windows users :// \\ | + | |
- | The server program files are located in the ".\ws" sub-folder of the Proline installation directory. | + | |
- | + | ||
- | //Linux users or manual installation ://\\ | + | |
- | Open the folder where you have unzipped the "Proline Server" archive. The Proline server folder should contain a sub-folder named ''ProlineWeb-Core-<x.y.z>''. | + | |
- | + | ||
- | == Editing the configuration file == | + | |
- | + | ||
- | The configuration file is located at ''<proline_server_folder>\ProlineWeb-Core-<x.y.z>\Proline\WEB-INF\classes''. \\ | + | |
- | + | ||
- | == Configuring the datastore == | + | |
- | + | ||
- | Edit the ''application.conf'' file in the same way you did it for ProlineAdmin (see [[#Setting up the Datastore]]). | + | |
- | If your configuration is valid, the Proline Server will be able to use the datastore you've created using Proline Admin. | + | |
- | + | ||
- | == Configuring the mount-points == | + | |
- | + | ||
- | Result identification files (Mascot dat, OMSSA or X!Tandem) as well as mzDB files (for the XIC Quantitation process) are only browsed from Proline Server side. | + | |
- | + | ||
- | Administrator must configure the target directory/ies in the entry ''mount_points'' in the ''application.conf'' file | + | |
- | + | ||
- | !! Important: on a Windows server installation, please use UNC style to access remote disks instead of mounted disk on letters. Otherwise Proline won't be fully functional. | + | |
- | ex: use \\\\my_server\\disk\\folder | + | |
- | instead of a mounted disk on Z: (Z: mounted as \\my_server\\disk\\folder) | + | |
- | + | ||
- | Mascot dat or OMSSA path should be configured in ''result_files'' sub-entry, administrator can add one or more mappings as ''label = "<absolute/directory/path>"''. | + | |
- | mzDB files path should be set under ''mzdb_files'' sub-entry. | + | |
- | + | ||
- | Label can be any valid string chosen by Administrator to help user identify mount_point. If multiple repositories are defined, labels must be different. | + | |
- | + | ||
- | Configuration examples: | + | |
- | <code> | + | |
- | mount_points { | + | |
- | + | ||
- | result_files { | + | |
- | mascot_data = "Z:/" //under window environement | + | |
- | omssa_data = "/local/omssa/data" //under linux environement | + | |
- | xtandem_data = "U:/" | + | |
- | ... | + | |
- | } | + | |
- | ... | + | |
- | + | ||
- | mzdb_files { | + | |
- | } | + | |
- | + | ||
- | } | + | |
- | </code> | + | |