prolineconcepts:pwd
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
prolineconcepts:pwd [2013/11/29 17:13] 193.48.0.3 [Setup the Proline Service] |
prolineconcepts:pwd [2016/07/07 14:13] (current) 132.168.72.225 [Setup the Proline Service] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Installation ====== | + | ====== Installation and configuration of Proline Web Desktop ====== |
| - | * The Proline Web Extension is based on the use of MongoDB database engine. You need to download it and install it either on the computer which will host the Proline Web Extension server, or any other network-accessible computer. You will find the installation files on this page : [[http://www.mongodb.org/downloads]] | + | * The Proline Web eXtension (PWX) is based on the use of MongoDB database engine. You need to download it and install it either on the computer which will host the PWX server, or any other network-accessible computer. You will find the installation files on this page : [[http://www.mongodb.org/downloads]] |
| - | * Download and run the Proline Web Extension Installer. The automated installer embeds serveral components of the Proline Suite. You can only install the Proline Web component, but if you want you can perform a full installation. It will install Proline-Admin and Proline-WebCore in the bin directory of Proline Web. | + | * Download and unzip the PWX archive. |
| + | |||
| + | |||
| + | NOT AVAILABLE YET: | ||
| + | The automated installer embeds several components of the Proline Suite. You may only install the Proline Web component, but if you want you can perform a full installation. It will install Proline-Admin and Proline-WebCore in the bin directory of Proline Web. | ||
| ====== Configure the Server ===== | ====== Configure the Server ===== | ||
| - | If you installed your MongoDB database on a different computer than the Proline Web Extension server, you'll need to edit the Proline Web Extension configuration file : | + | If you installed your MongoDB database on a different computer than the PWX server, you'll need to edit the PWX configuration file : |
| - | * Go to the installation directory of your Proline Web Extension server | + | * Go to the installation directory of your PWX server |
| - | * Go to the "config" folder and open the "pwx.conf" file with any text editor (like Window default Notepad) | + | * Go to the "conf" folder and open the "application.conf" file with any text editor (like Window default Notepad) |
| - | * Setup the "mongo_db_config" "host" parameter with the right URL to your MongoDB server (ex: 'mongodb://185.532.02.33:27017' or 'mongodb://distant_computer_name:27017') | + | * Edit the mongodb.servers and cache.mongodb.servers parameters by setting the host name and the port number corresponding to your MongoDB server (default MongoDB port is 27017) |
| - | * There is a "mongo_db.bat" script file in your proline web installation directory. Right-click on it and click "Modify" in order to set up the right path to your MongoDB Installation. Replace the "C:\Program Files\mongodb-win32-x86_64-2008plus-2.4.6\bin\mongod.exe" -dbpath="E:\mongodb" statement with the path to your mongod.exe executable, and the path to the directory where data will be stored in the "dbpath" param | + | |
| - | * If you defined a specific user and password on your MongoDB server, you should add them as "user:"user_name" and "password:"your_password" parameters | + | |
| - | If MongoDB is installed on the same computer as the Proline Web Extension server, you don't need to configure anything at this time. | + | If MongoDB is installed on the same computer as the PWX server, you don't need to configure anything at this time. |
| ====== Launch The Server ====== | ====== Launch The Server ====== | ||
| - | * First, please make sure that MongoDB is running. If it's not, please start it manually. Check out the configuration procedure to make sure your "mongo_db.bat" script file is correct (you must set up the path to your mongodb server program and the directory where your data will be stored) | + | * First, please make sure that MongoDB is running. If it's not, please start it manually. [[http://docs.mongodb.org/manual/|See official docs]] |
| - | * In order to start the Proline Web Extension server components, go to its installation folder, and launch the "start.bat" script. This script will start the following programs : | + | * In order to start the PWX server, go to its installation folder. On Windows platforms launch the "start.bat" script. On Linux platforms execute the "start.sh" script. |
| - | * The Gearman service : this is a program used to supervise and manage heavy tasks requests that will be executed by the PWX Daemon program. | + | |
| - | * The PWX Daemon, that handles : | + | |
| - | * the heavy works that need to be ran in a separated Perl process | + | |
| - | * the events listenning and dispatching. | + | |
| - | * The PWX "Mojolicious" Program that is the actual web server. It runs the Web Desktop and the Applications. | + | |
| - | ====== Setup the Proline Service ====== | ||
| - | * The connection between the desktop and the proline core server is provided by the "proline" service. This service is included with the Proline Web Extension package, but it needs to be registered and configured as a service for your Web Desktop server. The following steps will explain how : | + | ====== Connect to the Proline Desktop ====== |
| - | * To set it up, go to "Start">"Administration">"Services Manager". On the "Services Directory Browser", you should see the "proline" service appear in the the table. Click on its name to select it, and click the "Register" button. You should be notified when it has been registered properly. | + | |
| - | * {{:prolineconcepts:service_registering.png| Service Registering Interface screenshot}} | + | |
| - | * Once the registration is done, click on the "Registered Services" tab, select "proline" in the Grid Table, and then click on "Configure" | + | |
| + | Once PWX is running, you can connect to the Proline Web Desktop by opening a Web Browser and go to the address of this form: "name-of-the-machine:9000" or "local.ip.of.the.machine:9000" (for instance 192.168.0.30). | ||
| + | The default user is "admin" and its password is "proline". Don't forget to change its password from the User menu button once you're logged in. | ||
| - | * {{:prolineconcepts:proline_configuration.png| Proline Configuration Interface screenshot}} | + | ====== Setup the Proline Service ====== |
| + | |||
| + | * The connection between the desktop and the proline core server is provided by the "proline" service. This service is included with the Proline Web eXtension server, but it needs to be configured. The following steps will explain how: | ||
| + | * To set it up, as an admin user, once logged in, click on the "gear" button on the top task bar. Then open the Daemons tab, and click on "Proline" to edit its settings : | ||
| + | |||
| + | {{ :prolineconcepts:edit_settings.png?direct |}} | ||
| * Here are some param values you can use : | * Here are some param values you can use : | ||
| - | * __ws_host__ is the adress of the Proline Web Core server. Use the name or the IP adress of the server to set the URL. Examples : | + | * __ws_host__ is the address of the Proline Web Core server. Use the name or the IP address of the server to set the URL. Examples : |
| * ''http://servername:8080/proline'' | * ''http://servername:8080/proline'' | ||
| * ''http://localhost:8080/proline'' | * ''http://localhost:8080/proline'' | ||
| - | * ''http://198.0.13.37/proline'' (replace 198.0.13.37 by the right IP adress) | + | * ''http://198.0.13.37/proline'' (replace 198.0.13.37 by the right IP address) |
| - | * __uds_db_dsn__ is the UDS database connexion configuration (DSN stands for Data Source Name). It has the following format **dbi:** + name of the Driver (**Pg** for PostgreSQL, **SQLite** for SQLite) + **:db_name=** + name of the Postgre SQL database (**uds_db** or path to the SQLite file **D:/path/to/uds_db.sqlite**) + **;host=** + Postgre SQL erver adress or name + **;port=** + port of the Postgre SQL server. The host and port params are not needed if you use a SQLite database. Here are some config examples : | + | |
| - | * dbi:Pg:dbname=uds_db;host=localhost;port=5432 | + | |
| - | * dbi:SQLite:dbname=D:/proline/data/uds_db.sqlite | + | |
| * __data_root__ is the directory where the user projects data will be stored. You can use something like **D:/proline/data**. __Make sure this directory exists on your disk, Proline won't create it automatically if it doesn't__. | * __data_root__ is the directory where the user projects data will be stored. You can use something like **D:/proline/data**. __Make sure this directory exists on your disk, Proline won't create it automatically if it doesn't__. | ||
| - | * __ps_db_dsn__ is equivalent to the __uds_db_dsn__ param but points to the PS Database. Set up the connection config the same way you did it for the UDS Database. | ||
| - | * __pwd_mascot_data_root__ is the Directory where the Proline Web Extension server will browse mascot result files. Set it up with a simple path like **D:/proline/mascot/data** or a network adresse like **\\servername\mascot\data**. __Make sure this directory exists on your disk, Proline won't create it automatically if it doesn't__. | ||
| - | * __pwc_mascot_data_root__ is the path from which the Proline Web Core will access this directory. You can leave it blank if you configured it in the Proline Web Core config file. It can be useful if you installed Proline Web Extension and Proline Web Core on two different servers, and if one of them runs on Linux, for example | ||
| - | * __db_username__ is the user name used by the PostgreSQL connection. not needed if you use SQLite. The default PostgreSQL user is " *postgres* ". | ||
| - | * __db_password__ is the password you gave to the PostgreSQL user specified above. | ||
| - | * __raw_files_root__ is the path to your .raw files root directory | ||
| - | * __mzdb_files_root__ is the path to your .mzdb files root directory | ||
| + | * __db_password__ is the password you gave to the PostgreSQL user specified above. | ||
| + | * __mascot_server_url__ (optional) is the url of your mascot server | ||
| - | * You must set up the right connexion informations and data directories in order to access the Proline Core Web services properly | + | You might need to restart the PWX server to make sure these new settings are updated. |
| - | * You must set up two path to the mascot data root folder : one for the desktop (pwd_mascot_data_root) and one for jetty (pwc_mascot_data_root). These to paths must point to the same folder. There are two of them because you need the Proline Web Extension server and the Proline Web Core server may not access it via the same way. Fill it the right way so the both servers can access the same directory. If they are on the same network and use the same OS (i.e Windows), you can set up the same path on both fields. | + | |
| - | * Set up the SQL Server connection settings, and the path to the raw files and mzdb files root directory. | + | |
| - | * Once it's done, simply click "Save Configuration" | + | |
| - | * To make sure that the "admin" user is registered in the UDS DB, you need to logout and login, in order to make the Proline Service to check your status in the UDS DB, and create your account if you're not registered yet | + | |
| - | + | ||
| - | ====== Activate the Dataset Explorer Application ====== | + | |
| - | * In order to use the Dataset Explorer Application (equivalent to the Proline Studio), you must register it into the desktop the same way you did it for the Proline Service. If it hasn't been registered automatically (the new auto_register function ensure that this app is automatically at Proline Web Extension servers' start), go to the Administration Panel, on the "Application Manager" tab, select "Dataset Explorer" on the list and click "register". After its registration, no further configuration is needed. | ||
prolineconcepts/pwd.1385741580.txt.gz · Last modified: 2013/11/29 17:13 by 193.48.0.3
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
