Differences

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

--- niota-docs:niota_install_clients [2025/04/24 15:06]
admin
+++ niota-docs:niota_install_clients [2025/07/17 14:11] (current)
@@ Line 1: / Line 1: @@
+==== Introduction ====
+A client is a group of configuration settings, grouped by a specified name. The name of the client is an identifier that has to be provided mandatory in the URL of the login page.
+Each client has got it's own connection-, formatting-, system-default, ... file, image folder, script folder, etc. There can be multiple clients defined inside one niota installation. A client can be addressed by the ''?client='' parameter in the URL of the login page.
+<code html url.html>
+https://localhost/niota/app/login.php?client=ABC
+</code>
 ==== setting up a client ====
-A client is a group of configuration settings by a specified name. The name of the client is an identifier that has to be provided mandatary in the URL of the login page.
-//What is a niota client exactly?//\\
-"Client" in niota is the term for a defined set of system settings. Each client has got its own connection, formatting, system default file, image folder, script folder, etc. There can be multiple clients defined inside one niota installation. A client can be adressed by the ''?client='' parameter in the URL of the login page.
+All client specific data are located in folder ''conf'' below your niota root folder. At the very beginning you may download a sample ''conf'' folder from [[niota_links|niota download page]] and adapt given samples to your needs.
+** Please take care not to update your ''conf'' folder with sample data after go live! An update package or a product fix should not update your ''conf'' folder **
+** There is always a system (default) client configured. The home folder of the system default client is located in ''app/conf'' folder. Avoid to change the system (default) client. Use an own client instead **
+You can address the system client by explicitly adding the ''?client=system'' parameter at the end of the login URL.
 <code html url.html>
-https://support.etixpert.com/saasDEV/niota/app/login.php?client=ABC
+http://localhost/niota/app/login.php?client=system
 </code>
-All client specific data are located in folder 'conf/' below your niota root folder. At the very beginning you may download a sample 'conf/' folder from niota download page and adapt given samples to your needs.
+{{:niota-docs:niota_doc_system_client.jpeg?nolink&600|}}
-** Please take care not to update your ''conf/'' folder with sample data after go live! An update package or a product fix should not update your ''conf/'' folder **
+You can address your configured clients by explicitly adding the ''?client=<myclientid>'' parameter at the end of the login URL.
-For example:\\
+<code html url.html>
-//my-department.my-server/niota/app/login.php?client=myclient//
+http://localhost/niota/app/login.php?client=ABC
-{{ :niota-docs:multi_client_01.png?400 |}}
+</code>
-((Figure 1 - URL with client parameter ))
-=== folder structure of a client ===
-Client-folders are placed inside 'niota/conf' folder. Each client has a home or root folder and must have a specified set of config files in a given structure below the root folder.
-One client is bound to exactly one configuration folder in file '**client.ini**'
-{{ :niota-docs:multi_client_02.png?400 |}}
+=== folder structure ===
-((Figure 2 - niota/conf folder content ))
+Client-folders are placed inside ''niota/conf'' folder. Each client has a home or root folder and must have a specified set of config files in a given structure below the root folder.
-{{ :niota-docs:multi_client_03.png?400 |}}
+One client is bound to exactly one configuration folder in file **''client.ini''**
-((Figure 3 - content of the sample client folder ))
-=== create a client ===
+{{:niota-docs:client_folder_structure.png?nolink&600|}}
-Make a copy of folder 'client_sample' and name it - for example 'myclientfolder'. Also make a copy of file 'client.sample.ini' and name it exactly '**client.ini**'. In file client.ini redefine the following section:
+** These files are mandatory for a client configuration and must be found in the client's home folder **
+  connections.php
+  debug_defaults.php
+  formatting_defaults.php
+  hosts.php
+  system_defaults.php
+** These folders (and some subfolders) are part of a client configuration and should not be renamed or removed **
+  formattings
+  log
+==== create a client ====
+Make a copy of folder ''client_sample'' and rename it to your desired name. In case there is no ''client.ini'' file in your ''conf'' folder, make a copy of file ''client.sample.ini'' and rename it exactly **''client.ini''**. In file client.ini copy the the following section and adapt it to your needs
 <code>
 [SAMPLE]
@@ Line 38: / Line 59: @@
 </code>
-Client name has to be defined inside brackets [...] and it is also necessary to define the name of the new client folder - it is 'myclientfolder' in the previous example. The content of the client.ini file is the following according to the examples:
+In case you want to configure e.g. a client for some trainings and you would like to address the client by ''?client=EDU01A'' and the home folder should be name ''client_EDU_01A'' then it would look like this.
+Client name has to be defined inside brackets [...] and home folder must be referenced in parameter ''conffolder''. The content of the client.ini file is the following according to the examples:
 <code>
-[MYCLIENT]
+[EDU01A]
-conffolder=myclientfolder
+conffolder=client_EDU_01A
-[/MYCLIENT]
+[/EDU01A]
 </code>
-After finishing these steps niota has the following folder structure:
+<code html url.html>
-{{ :niota-docs:multi_client_04.png?400 |}}
+http://localhost/niota/app/login.php?client=EDU01A
-((Figure 4 - client folder and client.ini file content ))
+</code>
+{{:niota-docs:niota_doc_edu01a_client.jpeg?nolink&600|}}
+Folder structure on the web sever should look like this
+{{:niota-docs:client_folder_structure_edu01a.png?nolink&600|}}
+==== shared folder ====
+If system settings are not changed, different clients share the content of some folders. This can be useful when you have multiple clients configured but you want to use the same set of image files or the same set of scripts or webservices amongst these clients.
+** These folders (and all subfolders) are shared amongst all clients that use system default configuration for images and script folders **
+  images
+  scripts
 Client set up continues with system, connection and formatting configuration:\\

niota

User Tools

Site Tools

Differences

Page Tools