Difference between revisions of "Xebra Server Config File"

 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:Xebra]]
 
[[Category:Xebra]]
 +
[[Xebra About|About]] | [[Xebra Installation|Installation]] |  [[Xebra Documentation|Documentation]] |  [[Xebra Tutorial|Tutorials]] | [[Xebra FAQ|Frequently Asked Questions]]
 +
 +
The server config file is read on startup and every time the reload command is executed. If there is an error in the configuration on startup, the server immediately shuts down. On the other hand, if there is an error in the configuration but the config file has already been successfully loaded once, the new configuration is discarded. The file is formated in Java Script Object Notation (JSON).
 +
  
 
=Properties=
 
=Properties=
 
==finalize_webapps==
 
==finalize_webapps==
 
*Type: Boolean
 
*Type: Boolean
*Description: If set to True, all webapps are finalized while compiled. (not yet implemented)
+
*Description: If set to True, all webapps are finalized while compiled.  
  
 
==compiler==
 
==compiler==
 
*Type: Path to executable file
 
*Type: Path to executable file
*Description: Set to eiffel compiler (ec or ecb)
+
*Description: Set to eiffel compiler (ec or ecb).
  
 
==translator==
 
==translator==
 
*Type: Path to executable file
 
*Type: Path to executable file
*Description: Set to the xebra_translator
+
*Description: Set to the xebra_translator.
  
==webapps_root==
+
==managed_webapps==
 
*Type: Path to directory
 
*Type: Path to directory
*Description: Set to the directory that contains all webapps
+
*Description: Set to the directory that contains all managed webapps config files.
  
==taglib==
+
==library==
 
*Type: Path to directory
 
*Type: Path to directory
*Description: Set to the directory that contains all tag lib files
+
*Description: Set to the directory that contains all xebra libraries.
  
 +
==compiler_flags==
 +
*Type: STRING
 +
*Description: Use this to add additional compiler flags to ec. Use at your own risk!
 +
 +
== unmanaged_webapps ==
 +
*Type: ARRAY
 +
*Description: Specifies unmanaged (potentially remote) webapps
 +
===name===
 +
*Type: STRING
 +
*Description: The name of the webapp
 +
===host===
 +
*Type: STRING
 +
*Description: The host of the webapp
 +
=== port ===
 +
*Type: NATURAL
 +
*Description: The port of the webapp
  
  
 
=Example=
 
=Example=
 
<code>
 
<code>
finalize_webapps=True
+
{
compiler=$ISE_EIFFEL/studio/spec/$ISE_PLATFORM/bin/ec
+
  "finalize_webapps": "false",
translator=$XEBRA_DEV/eiffel_projects/xebra_translator/EIFGENs/xebra_translator/F_code/xebra_translator
+
  "compiler": "$ISE_EIFFEL/studio/spec/$ISE_PLATFORM/bin/ec.exe",
webapps_root=$XEBRA_DEV/httpd/htdocs
+
  "translator": "$XEBRA_DEV/eiffel_projects/xebra_translator/EIFGENs/xebra_translator/W_code/xebra_translator.exe",
taglib=$XEBRA_DEV/eiffel_projects/xebra_translator
+
  "managed_webapps": "$XEBRA_DEV/www",
 +
  "library": "$XEBRA_DEV/eiffel_projects/library",
 +
  "compiler_flags": "-experiment",
 +
  "unmanaged_webapps":
 +
  [
 +
{
 +
"name": "helloworld2",
 +
"host": "10.0.10.197",
 +
"port": "55030"
 +
},
 +
                {
 +
"name": "helloworld3",
 +
"host": "10.0.10.197",
 +
"port": "55031"
 +
}
 +
]
 +
}
 +
 
 +
 
 
</code>
 
</code>

Latest revision as of 12:17, 20 August 2009

About | Installation | Documentation | Tutorials | Frequently Asked Questions

The server config file is read on startup and every time the reload command is executed. If there is an error in the configuration on startup, the server immediately shuts down. On the other hand, if there is an error in the configuration but the config file has already been successfully loaded once, the new configuration is discarded. The file is formated in Java Script Object Notation (JSON).


Properties

finalize_webapps

  • Type: Boolean
  • Description: If set to True, all webapps are finalized while compiled.

compiler

  • Type: Path to executable file
  • Description: Set to eiffel compiler (ec or ecb).

translator

  • Type: Path to executable file
  • Description: Set to the xebra_translator.

managed_webapps

  • Type: Path to directory
  • Description: Set to the directory that contains all managed webapps config files.

library

  • Type: Path to directory
  • Description: Set to the directory that contains all xebra libraries.

compiler_flags

  • Type: STRING
  • Description: Use this to add additional compiler flags to ec. Use at your own risk!

unmanaged_webapps

  • Type: ARRAY
  • Description: Specifies unmanaged (potentially remote) webapps

name

  • Type: STRING
  • Description: The name of the webapp

host

  • Type: STRING
  • Description: The host of the webapp

port

  • Type: NATURAL
  • Description: The port of the webapp


Example

{
  "finalize_webapps": "false",
  "compiler": "$ISE_EIFFEL/studio/spec/$ISE_PLATFORM/bin/ec.exe",
  "translator": "$XEBRA_DEV/eiffel_projects/xebra_translator/EIFGENs/xebra_translator/W_code/xebra_translator.exe",
  "managed_webapps": "$XEBRA_DEV/www",
  "library": "$XEBRA_DEV/eiffel_projects/library",
  "compiler_flags": "-experiment",
  "unmanaged_webapps":
  [
		{ 
			"name": "helloworld2",
			"host": "10.0.10.197",
			"port": "55030"
		},
                { 
			"name": "helloworld3",
			"host": "10.0.10.197",
			"port": "55031"
		}
	]
}