setupguide:firstinstall
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
setupguide:firstinstall [2015/08/12 11:20] 130.79.67.200 [Locating the server folder] |
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]]). | ||
| The following documentation describes the installation procedure for each of this component: | The following documentation describes the installation procedure for each of this component: | ||
| - | * [[#proline_server_installation_and_setup|Proline server]] | + | * [[#installing_and_configuring_proline_server|Proline server]] |
| * [[#installing_and_configuring_the_sequence_repository|Sequence Repository]] | * [[#installing_and_configuring_the_sequence_repository|Sequence Repository]] | ||
| * [[#installing_proline_studio|Proline Studio]] | * [[#installing_proline_studio|Proline Studio]] | ||
| * [[#installing_and_configuring_proline_web_desktop|Proline Web]] | * [[#installing_and_configuring_proline_web_desktop|Proline Web]] | ||
| - | ====== Proline server installation and setup ====== | + | ====== Installing and configuring Proline server ====== |
| - | ==== Proline server installation ==== | + | ===== Proline server installation ===== |
| === Windows users === | === Windows users === | ||
| - | Download the automated installer from the Proline website (http://proline.profiproteomics.fr/download/). | + | Download the automated installer from the Proline website (http://proline.profiproteomics.fr/download/). \\ |
| + | **Warning: Be sure to run the executable file as "administrator" to be able to install third-party dependencies such as PostgreSQL**. | ||
| The wizard will guide you through the installation process. \\ | The wizard will guide you through the installation process. \\ | ||
| By default, the installer will unpack all components on the computer. However, it is possible to install the Proline components on distinct computers if it fits better your hardware architecture. | By default, the installer will unpack all components on the computer. However, it is possible to install the Proline components on distinct computers if it fits better your hardware architecture. | ||
| - | For users who prefer **manual installation or without administrator rights**, an archive file of the distribution is also available. You can follow the installation procedure described in the next section. | + | For users who prefer **manual installation or without administrator privileges**, an archive file of the distribution is also available. You can follow the installation procedure described in the next section. |
| Line 41: | Line 47: | ||
| We will guide you through this process, step by step, using both these tools. | We will guide you through this process, step by step, using both these tools. | ||
| - | ===== Setting up the Datastore ===== | + | ===== Setting up the Datastore and Proline Server ===== |
| - | You must first configure ProlineAdmin since this component is used to create the databases needed by Proline. | + | 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 ]] . | ||
| - | ==== From graphical tool ProlineAdmin GUI ==== | ||
| - | |||
| - | === Launch ProlineAdmin GUI === | ||
| - | |||
| - | == Windows users == | ||
| - | |||
| - | A shortcut "Proline Admin" is available in the Windows Start Menu, under the Proline folder. | ||
| - | |||
| - | == Linux users or manual installation == | ||
| - | |||
| - | Execute the ''start.sh'' script located in the folder obtained after Proline Admin GUI archive file extraction. | ||
| - | |||
| - | === ProlineAdmin GUI usage === | ||
| - | |||
| - | The default configuration file ''config/application.conf'' is loaded. You can alternatively edit this file (see [[#configuring_prolineadmin|"Configuring ProlineAdmin"]] section below) or select another ''.conf'' file of the same format. | ||
| - | To select a file, go to the "Select configuration files" menu. A dialog opens, offering you to chose 2 files: | ||
| - | * the first one is the ProlineAdmin configuration file, mandatory to use configure, setup and upgrade Proline, as well as create users and projects; | ||
| - | * the second one is the Proline server configuration file. This one is optional for the actions described above, but mandatory to edit Proline mount points (see section 'Configuring the mount-points'). Additionally, if this file is selected, it will be automatically synchronized with ProlineAdmin's configuration file. | ||
| - | |||
| - | {{ :setupguide:select_proline_conf_files.png?nolink&600 |}} | ||
| - | |||
| - | To edit Proline configuration file(s), press the "Edit Proline configuration" button. You can now edit your file(s) in the newly opened window, and save it. | ||
| - | |||
| - | {{ :setupguide:edit_proline_conf.png?nolink&600 |}} | ||
| - | |||
| - | Finish the datastore setup by clicking the newly available button "Set up Proline". | ||
| - | |||
| - | __Note__: This functionality will be disabled if Proline is already set up or if Proline configuration is invalid. | ||
| - | |||
| - | {{ :setupguide:setup_proline2.png?nolink&600 |}} | ||
| - | |||
| - | |||
| - | ==== Using the command line interface (ProlineAdmin) ==== | ||
| - | |||
| - | Edit the configuration file ''config/application.conf'' located in the ProlineAdmin folder (see [[#configuring_prolineadmin|"Configuring ProlineAdmin"]] section below). | ||
| - | Then perform the datastore setup by running the dedicated script. | ||
| - | |||
| - | == 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. | ||
| - | |||
| - | |||
| - | ==== Configuring 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. | ||
| - | |||
| - | ===== Configuring the 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> | ||
| - | |||
| - | == Using ProlineAdmin GUI == | ||
| - | |||
| - | Mount points can be edited using ProlineAdmin GUI. | ||
| - | As it is explained in the 'Setting up the Datastore' section, first make sure Proline server configuration file is selected. Then click on the 'Edit Proline configuration button' to access configuration panel. | ||
| - | |||
| - | {{ :setupguide:edit_mount_points.png?nolink&600 |}} | ||
| ===== Running the server ===== | ===== Running the server ===== | ||
| Line 279: | Line 153: | ||
| * [[prolineconcepts:PWD| Install, Configure and launch the Desktop]] | * [[prolineconcepts:PWD| Install, Configure and launch the Desktop]] | ||
| - | |||
| - | |||
setupguide/firstinstall.1439371200.txt.gz · Last modified: 2015/08/12 11:20 by 130.79.67.200
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
