setupguide:setup_with_prolineadmin_gui
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
setupguide:setup_with_prolineadmin_gui [2016/02/04 11:16] 132.168.72.225 |
setupguide:setup_with_prolineadmin_gui [2016/07/07 14:09] (current) 132.168.72.225 [Set up the Datastore] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Setup Proline Suite with Proline-Admin GUI ====== | + | ====== Set up Proline Suite with Proline-Admin GUI ====== |
| __Note__ : All the settings shown on the screenshots only stand for examples. You must adapt them to your needs. | __Note__ : All the settings shown on the screenshots only stand for examples. You must adapt them to your needs. | ||
| Line 15: | Line 15: | ||
| ==== Locate configuration files ==== | ==== Locate configuration files ==== | ||
| - | The default configuration file ''config/application.conf'' is loaded. You can alternatively edit this file or select another ''.conf'' file of the same format. | + | At application start, the default configuration file ''config/application.conf'' is loaded. Note that, when using Proline Admin (GUI) for the first time, this file isn't valid and will lead to an error message. Don't bother: you can alternatively edit this file or select another ''.conf'' file of the same format using the //Configuration// window: \\ |
| - | To select a file, go to the "Select configuration files" menu. A dialog opens, offering you to chose 2 files: | + | - On the main page, click on //Configuration// to open that window (screenshot below). \\ |
| - | * the first one is the Proline-Admin configuration file, mandatory to use the command : configure, setup and upgrade Proline, as well as create users and projects; | + | - The first tab, named //Configuration files//, let you choose all the configuration files that you may use in this application. |
| - | * the second one is the Proline server configuration file. This one is optional for the actions described above, but mandatory to edit Proline Server configuration (see section 'Configuring the mount-points'). . | + | * The first one is the __Proline-Admin configuration file__. This is the only one required for a basic use of the application (setup and upgrade Proline, create users and projects). |
| + | * The second one is the __Proline server configuration file__. It is optional for the actions described above, but mandatory to edit the Proline Server configuration (see the section Configuring the mount points). | ||
| + | * The third one is the __Proline PWX (Proline Web eXtension) configuration file__. It is optional too, and useful only if you use the web interface of Proline (Proline Web). Mentioning it will allow you to automatically synchronize the mount points between the Proline server and the web interface. | ||
| + | * The last field is the __PostgreSQL data directory__, mandatory to configure PostgreSQL //via// ProlineAdmin GUI ([[setupguide:postgresqloptimization|see PostgreSQL optimization and authorizations]]). | ||
| + | - Click //OK// to save changes and go back on the main page, or //Apply// to save changes and stay on the configuration window (edit files).\\ | ||
| - | The Proline Server configuration file will be synchronized with Proline-Admin configuration when you press the 'Save' button. | + | **NB:** The Proline server folder is located in the ".\ws" sub-folder of the Proline installation directory if Windows installer has been used. If archive files has been used you will find it under 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>''. \\ |
| + | The configuration file is located at ''<proline_server_folder>\ProlineWeb-Core-<x.y.z>\Proline\WEB-INF\classes''.\\ | ||
| - | The Proline server folder is located in the ".\ws" sub-folder of the Proline installation directory if Windows installer has been used. If archivce files has been used you will find it under 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>''. | + | {{ :setupguide:choose_config_custom.png?nolink&1200 |}} |
| - | The configuration file is located at ''<proline_server_folder>\ProlineWeb-Core-<x.y.z>\Proline\WEB-INF\classes''.\\ | ||
| - | As shown previously, use 'Menu -> Select Proline configuration files' to select Proline Server configuration file. | ||
| - | {{ :setupguide:select_proline_conf_files_2.png?nolink&1000 |}} | + | ---- |
| ==== Configure Proline parameters ==== | ==== Configure Proline parameters ==== | ||
| - | To edit Proline configuration file(s), press the "Edit Proline configuration" button. You can now configure parameters in the newly opened window, and save it. | + | To edit Proline configuration file(s), select the last tab of the configuration window, entitled //Proline configuration//. |
| - | {{ :setupguide:edit_proline_conf_no_mount_points.png?nolink&1000|}} | + | {{ :setupguide:proline_configuration.png?nolink&800 |}} |
| - | ** Do not confuse: ** | + | This tab is split in three parts: |
| - | * 'Data directory' under 'Proline': indicates where to store Proline data (e.g. exports). | + | * __Working files__ (not visible on the screenshot above): reminds you of the selected configuration files. You can also select other files from here ; it will be effective after clicking on the //Apply// button of this block. It is fully synchronized with the first tab (//Configuration files//) of the configuration window. |
| - | * 'PostgreSQL data directory' (Menu -> Select PostgreSQL data directory): references the PostgreSQL data directory (PostgreSQL configuration files). This one is needed to configure your PostgreSQL instance through ProlineAdmin-GUI (see [[setupguide:postgresqloptimization|PostgreSQL optimization]]). | + | * __Database connection:__ configure and test the connection to the proline database. Entries will be saved in Proline Admin configuration file and in Proline Server configuration file if provided. |
| + | * __Mount points:__ define the Proline mount points in three categories (more details in the following paragraph). Entries will be saved in Proline Server and PWX configuration files if provided. | ||
| === Configure the mount-points === | === Configure the mount-points === | ||
| - | Note that the section named 'Mount points' should now be enable only if Proline server configuration file has been located. | + | Note that the section named //Mount points// is enable only if the Proline server configuration file has been located (see screenshot above). |
| - | Administrator must configure the target directory/ies in 'Mount points' section of the dialog 'Edit Proline configuration'. | + | |
| - | {{ :setupguide:edit_mount_points.png?nolink&1000|}} | + | Input files (e.g. *.RAW, *.WIFF, *.D) should be set in the 'Raw files' sub-section.\\ |
| - | + | mzDB files should be set in the 'mzDB_files' sub-section.\\ | |
| - | \\ | + | Identification result files (e.g. Mascot .dat, OMSSA .omx) should be set in the 'Result files' sub-section. |
| - | 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. | + | |
| + | Several alias/full_path pairs can be used or each. | ||
| + | Aliases can be any valid string chosen by the administrator to help the users identify a mount_point. If multiple repositories are defined, aliases must be different. | ||
| !! 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. | !! 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. | ||
| Line 54: | Line 59: | ||
| instead of a mounted disk on Z: (Z: mounted as \\my_server\\disk\\folder) | instead of a mounted disk on Z: (Z: mounted as \\my_server\\disk\\folder) | ||
| - | Input files should be set in the 'RAW files' sub-section; | + | 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. |
| - | Mascot dat or OMSSA path should be configured in the 'Result files' sub-section; | + | |
| - | mzDB files path should be set in the 'mzDB_files' sub-section. | + | |
| - | Several alias/full_path pairs can be used or each. | + | |
| - | Aliases can be any valid string chosen by the administrator to help the users identify a mount_point. If multiple repositories are defined, aliases must be different. | + | Click //OK// to save changes and go back on the main page, or //Apply// to save changes and stay on the configuration window (edit files).\\ |
| + | ---- | ||
| ==== Set up the Datastore ==== | ==== Set up the Datastore ==== | ||
| - | Once parameters specified in previous Windows, you can finish the Datastore setup by clicking the newly available button "Set up Proline". | + | Once the configuration files has been edited and validated, the button //Set up Proline datastore// becomes availale in the main page. Click it to finish the Datastore setup. |
| __Note__: This functionality will be disabled if Proline is already set up or if Proline configuration is invalid. | __Note__: This functionality will be disabled if Proline is already set up or if Proline configuration is invalid. | ||
| - | {{ :setupguide:setup_proline2.png?nolink&1000|}} | + | {{ :setupguide:setup_proline_datastore.png?nolink&1000 |}} |
| \\ | \\ | ||
| \\ | \\ | ||
setupguide/setup_with_prolineadmin_gui.1454580977.txt.gz · Last modified: 2016/02/04 11:16 by 132.168.72.225
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
