Differences

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

--- guides:unix_basic_setup [02/07/2015 19:00] – ppk
+++ guides:unix_basic_setup [16/08/2015 08:22] (current) – PtokaX cmd line menu instead of manual xml editing... ppk
@@ Line 1: / Line 1: @@
 ====== Basic setup ======
-Before we run our compiled PtokaX executable we need to do at least minimal setup.\\
+Before we run our compiled PtokaX executable we need to do at least basic configuration.\\
-In source 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 directory to cfg with this command: **mv cfg.example 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.\\
-Go to cfg dir with this command: **cd cfg**
+You can run PtokaX menu with command: **./PtokaX -m**
-==== a. Minimal settings ====
+==== a. Basic setup ====
-To be able to run PtokaX we need to set at least hub name and hub address.\\ Open Setting.xml in text editor with this command (you can use any other text editor instead of **VIM**, for example **ee** on FreeBSD or **vi** on CentOS): **vim Settings.xml**\\
+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.\\
-  * **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. -->**
+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 ====
-==== b. Creating registered user. (Optional) ====
+In menu option **2** will ask for all PtokaX settings.
-When we are here, it is good idea to create registered user with master account for yourself.\\ Open RegisteredUsers.xml in text editor with this command (you can use any other text editor instead of **VIM**, for example **ee** on FreeBSD or **vi** on CentOS): **vim RegisteredUsers.xml**\\
+==== c. Creating registered user. ====
-  * **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>**
+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 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 -->**