Differences

This shows you the differences between two versions of the page.

--- guides:win_service [14/10/2012 23:13] – ppk
+++ guides:win_service [16/08/2015 08:26] (current) – ppk
@@ Line 1: / Line 1: @@
 ====== Service version install and setup ======
-===== 1. Download, unpack and service installation =====
+==== 1. Download, unpack and service installation ====
   * **a. Download**\\ From [[http://www.PtokaX.org/|PtokaX homepage]] download service version.
   * **b. Unpacking**\\ Unpack content of archive to some directory (for example to C:\Program Files\PtokaX\).
@@ Line 8: / Line 8: @@
     * Install PtokaX service with command: **ptokax -i servicename** (for example **ptokax -i PtokaX**).
     * If you want to use different config directory than PtokaX_Dir\cfg then install service with command: **ptokax -i servicename -c config_dir** (for example **ptokax -i PtokaX -c C:\PtokaX**).
-===== 2. Basic setup =====
+==== 2. Basic setup ====
-Before we can run our installed PtokaX service we need to do at least minimal setup.\\
+Before we run our compiled PtokaX executable we need to do at least basic configuration.\\
-In PtokaX archive we have config examples, we use them to setup your PtokaX hub.\\
+In source is in directory cfg.example file Settings.pxt with PtokaX settings. You can edit this file with text editor.\\ \\
-\\
+Another way is PtokaX inbuild command line menu where is possible to do basic setup, complete setup and to add registered user.\\
-First we rename cfg.example folder to cfg.\\
+This menu can be used for first time setup and to reconfigure PtokaX. Add reg user part can be used to add additional registered users.\\
-  * **a. Minimal settings**\\ To be able to run PtokaX we need to set at least hub name and hub address.\\ Open Setting.xml in text editor (notepad is good choice).\\ \\
+You can run PtokaX menu with command: **PtokaX.exe -m**
-    * **To change hub name:**\\ Search for this line **<String Name="HubName">&lt;Enter hub name here&gt;</String><!-- Hub name. Min length 1, max 256. -->** and change **&lt;Enter hub name here&gt;** to name of new hub.\\ Result can look like this: **<String Name="HubName">My first PtokaX hub</String><!-- Hub name. Min length 1, max 256. -->**
+  *a. Basic setup\\ In menu option **1** will ask only few required things needed to run PtokaX. Max users, hub name, hub address, encoding for non-unicode characters.\\ In case when PtokaX is compiled with database support then database options will be asked too.
-    * **To change hub address:**\\ Search for this line **<String Name="HubAddress">&lt;Enter hub address here&gt;</String><!-- Hub address. Min length 1, max 256. -->** and change **&lt;Enter hub address here&gt;** to address of new hub.\\ Result can look like this: **<String Name="HubAddress">some-address.some-domain.eu</String><!-- Hub address. Min length 1, max 256. -->**
+  *b. Complete setup\\ In menu option **2** will ask for all PtokaX settings.
-  * **b. Creating registered user. (Optional)**\\ When we are here, it is good idea to create registered user with master account for yourself.\\ Open RegisteredUsers.xml in text editor.\\ \\
+  *c. Creating registered user.\\ In menu option **3** can be used to to add one or more registered users. User Nick, Password and Profile will be asked. It will give hint about available profiles.
-    * **To set nick:**\\ Search for this line **<Nick>Example_Nick</Nick>** and change **Example_Nick** to your nick.\\ Result can look like this: **<Nick>MyNick</Nick>**
-    * **To set password:**\\ Search for this line **<Password>Example_Password</Password>** and change **Example_Password** to your password.\\ Result can look like this: **<Password>MyPassword</Password>**
-    * **To set profile:**\\ Search for this line **<Profile>3</Profile><!-- 0 for master, 1 for operator, 2 for vip, 3 for reg -->** and change **3** to your profile.\\ Result can look like this: **<Profile>0</Profile><!-- 0 for master, 1 for operator, 2 for vip, 3 for reg -->**
-===== 3. Run service =====
+==== 3. Run service ====
 This one is simple. Service will autostart with Windows, but when you want to start it manually go to services, right click on service name and click start.\\
 Another way is to start it from command line with command: **sc start servicename** (for example **sc start PtokaX**). 8-)
-===== 4. Uninstall service =====
+==== 4. Uninstall service ====
 In case when for some reason you want to uninstall PtokaX service then it is similar to how service was installed. But instead if -i use -u (for example **ptokax -u PtokaX**).