AppSuite:Appserver - Revision history

J.ohny.b at 12:08, 14 March 2014

2014-03-14T12:08:28Z

← Older revision		Revision as of 12:08, 14 March 2014
Line 5:		Line 5:
	The <code>appserver</code> tool is used to develop and test the OX App Suite UI and its plugins with a remote backend. <code>appserver</code> acts as a reverse HTTP proxy for an existing OX App Suite installation and injects the tested JavaScript code in its replies.		The <code>appserver</code> tool is used to develop and test the OX App Suite UI and its plugins with a remote backend. <code>appserver</code> acts as a reverse HTTP proxy for an existing OX App Suite installation and injects the tested JavaScript code in its replies.

	WARNING: These informations are only tested and validated for DEBIAN installations! Please use a DEBIAN virtual machine.		WARNING: These informations are only tested and validated for DEBIAN installations! Please use a DEBIAN virtual machine. Standalone version and using appserver with connect-based middleware should work in most cases, though.

	== Installation ==		== Installation ==

J.ohny.b: /* Usage connect-based middleware */

2014-03-13T16:35:46Z

Usage connect-based middleware

← Older revision		Revision as of 16:35, 13 March 2014
Line 29:		Line 29:
	You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.		You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.

	== Usage connect-based middleware ==		== Usage with connect-based middleware ==

	You can also integrate the collection of middleware classes shipped by appserver into any [http://www.senchalabs.org/connect/ connect]-based middleware, such as [https://github.com/gruntjs/grunt-contrib-connect grunt-contrib-connect]. An example <code>Gruntfile.js</code> can be found in the [https://github.com/Open-Xchange-Frontend/appserver#example-usage-with-grunt-contrib-connect appserver repo]:		You can also integrate the collection of middleware classes shipped by appserver into any [http://www.senchalabs.org/connect/ connect]-based middleware, such as [https://github.com/gruntjs/grunt-contrib-connect grunt-contrib-connect]. An example <code>Gruntfile.js</code> can be found in the [https://github.com/Open-Xchange-Frontend/appserver#example-usage-with-grunt-contrib-connect appserver repo]:

J.ohny.b: /* Usage with grunt-contrib-connect middleware plugin */

2014-03-13T16:29:43Z

Usage with grunt-contrib-connect middleware plugin

← Older revision		Revision as of 16:29, 13 March 2014
Line 29:		Line 29:
	You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.		You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.

	== Usage ~~with grunt~~-~~contrib-connect~~ middleware ~~plugin~~ ==		== Usage connect-based middleware ==

	You can also integrate the collection of middleware classes shipped by appserver into any [http://www.senchalabs.org/connect/ connect]-based middleware, such as [https://github.com/gruntjs/grunt-contrib-connect grunt-contrib-connect]. An example <code>Gruntfile.js</code> can be found in the [https://github.com/Open-Xchange-Frontend/appserver#example-usage-with-grunt-contrib-connect appserver repo]:		You can also integrate the collection of middleware classes shipped by appserver into any [http://www.senchalabs.org/connect/ connect]-based middleware, such as [https://github.com/gruntjs/grunt-contrib-connect grunt-contrib-connect]. An example <code>Gruntfile.js</code> can be found in the [https://github.com/Open-Xchange-Frontend/appserver#example-usage-with-grunt-contrib-connect appserver repo]:

J.ohny.b: /* Usage with grunt-contrib-connect middleware plugin */

2014-03-13T16:25:32Z

Usage with grunt-contrib-connect middleware plugin

← Older revision		Revision as of 16:25, 13 March 2014
Line 48:		Line 48:
	grunt.fail.fatal('Please adjust your local.conf.json');		grunt.fail.fatal('Please adjust your local.conf.json');
	}		}

	config.prefixes = (config.prefixes \|\| []).concat([options.base, options.base + '/apps/']);		config.prefixes = (config.prefixes \|\| []).concat([options.base, options.base + '/apps/']);
	config.manifests = (config.manifests \|\| []).concat(options.base + '/manifests/');		config.manifests = (config.manifests \|\| []).concat(options.base + '/manifests/');
	config = appserver.tools.unifyOptions(config);		config = appserver.tools.unifyOptions(config);

	middlewares.push(appserver.middleware.appsload(config));		middlewares.push(appserver.middleware.appsload(config));
	middlewares.push(appserver.middleware.manifests(config));		middlewares.push(appserver.middleware.manifests(config));

J.ohny.b: /* Usage with grunt-contrib-connect middleware plugin = */

2014-03-13T16:25:14Z

Usage with grunt-contrib-connect middleware plugin =

← Older revision		Revision as of 16:25, 13 March 2014
Line 29:		Line 29:
	You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.		You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.

	== Usage with grunt-contrib-connect middleware plugin ===		== Usage with grunt-contrib-connect middleware plugin ==

	You can also integrate the collection of middleware classes shipped by appserver into any [http://www.senchalabs.org/connect/ connect]-based middleware, such as [https://github.com/gruntjs/grunt-contrib-connect grunt-contrib-connect]. An example <code>Gruntfile.js</code> can be found in the [https://github.com/Open-Xchange-Frontend/appserver#example-usage-with-grunt-contrib-connect appserver repo]:		You can also integrate the collection of middleware classes shipped by appserver into any [http://www.senchalabs.org/connect/ connect]-based middleware, such as [https://github.com/gruntjs/grunt-contrib-connect grunt-contrib-connect]. An example <code>Gruntfile.js</code> can be found in the [https://github.com/Open-Xchange-Frontend/appserver#example-usage-with-grunt-contrib-connect appserver repo]:

J.ohny.b: /* Standalone use */

2014-03-13T16:24:59Z

Standalone use

← Older revision		Revision as of 16:24, 13 March 2014
Line 28:		Line 28:

	You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.		You do not need to restart anything after re-building the app, a refresh of the browser page should be enough. If your code doesn’t show up after a refresh, our file cache mighgt not be up-to-date. Until this is fixed in appserver, you can append <code>&debug-js=true</code> to your URL to disable the file cache.

			== Usage with grunt-contrib-connect middleware plugin ===

			You can also integrate the collection of middleware classes shipped by appserver into any [http://www.senchalabs.org/connect/ connect]-based middleware, such as [https://github.com/gruntjs/grunt-contrib-connect grunt-contrib-connect]. An example <code>Gruntfile.js</code> can be found in the [https://github.com/Open-Xchange-Frontend/appserver#example-usage-with-grunt-contrib-connect appserver repo]:

			var appserver = require('appserver');

			grunt.config('connect', {
			server: {
			options: {
			port: 8337,
			base: ['build/'],
			livereload: true,
			middleware: function (connect, options, middlewares) {
			var config = grunt.config().local.appserver;
			if (config.server === '') {
			grunt.log.error('Server not specified in grunt/local.conf.json');
			grunt.log.writeln('Hint: If this is a new setup you may want to copy the file grunt/local.conf.defaults.json to grunt/local.conf.json and change its values according to your setup.');
			grunt.fail.fatal('Please adjust your local.conf.json');
			}

			config.prefixes = (config.prefixes \|\| []).concat([options.base, options.base + '/apps/']);
			config.manifests = (config.manifests \|\| []).concat(options.base + '/manifests/');
			config = appserver.tools.unifyOptions(config);

			middlewares.push(appserver.middleware.appsload(config));
			middlewares.push(appserver.middleware.manifests(config));
			middlewares.push(appserver.middleware.localfiles(config));
			middlewares.push(appserver.middleware.proxy(config));
			return middlewares;
			}
			}
			}
			});

	== Use with Apache ==		== Use with Apache ==

J.ohny.b: /* verbose */

2014-03-13T16:07:54Z

verbose

← Older revision		Revision as of 16:07, 13 March 2014
Line 125:		Line 125:

	; local : The name of every read local file is written to standard output.		; local : The name of every read local file is written to standard output.
	; local:error : The name of files that have not been found locally are written to standard output (good for debugging missing files).		; <nowiki>local:error</nowiki> : The name of files that have not been found locally are written to standard output (good for debugging missing files).
	; remote : The URL of every request for missing local files is written to standard output.		; remote : The URL of every request for missing local files is written to standard output.
	; proxy : The URL of every client request which is forwarded as-is is written to standard output.		; proxy : The URL of every client request which is forwarded as-is is written to standard output.

J.ohny.b: /* verbose */

2014-03-13T16:07:00Z

verbose

← Older revision		Revision as of 16:07, 13 March 2014
Line 125:		Line 125:

	; local : The name of every read local file is written to standard output.		; local : The name of every read local file is written to standard output.
			; local:error : The name of files that have not been found locally are written to standard output (good for debugging missing files).
	; remote : The URL of every request for missing local files is written to standard output.		; remote : The URL of every request for missing local files is written to standard output.
	; proxy : The URL of every client request which is forwarded as-is is written to standard output.		; proxy : The URL of every client request which is forwarded as-is is written to standard output.

J.ohny.b: /* Standalone use */

2014-03-13T16:04:41Z

Standalone use

← Older revision		Revision as of 16:04, 13 March 2014
Line 15:		Line 15:
	== Standalone use ==		== Standalone use ==

	In the simplest case of developing an app or a plugin, all that is needed is ~~an existing OX App Suite installation. Point <code>~~appserver~~</code>~~ to ~~the URL of OX App Suite and~~ to the ~~build directory of your app~~. Assuming you are in the top directory of your app's source code and <code>[[AppSuite:UI build system#builddir\|$builddir]]</code> is not set:		In the simplest case of developing an app or a plugin, all that is needed is the appserver npm package to be installed globally.

			# on many Linux systems you need to run this using the sudo command. MacOS and Windows should work without

			npm install -g appserver

			Assuming you are in the top directory of your app's source code and <code>[[AppSuite:UI build system#builddir\|$builddir]]</code> is not set:

	appserver [[#server\|--server]]=<nowiki>https://www.ox.io/appsuite/</nowiki> build		appserver [[#server\|--server]]=<nowiki>https://www.ox.io/appsuite/</nowiki> build

Cutmasta at 10:21, 10 March 2014

2014-03-10T10:21:54Z

← Older revision		Revision as of 10:21, 10 March 2014
Line 5:		Line 5:
	The <code>appserver</code> tool is used to develop and test the OX App Suite UI and its plugins with a remote backend. <code>appserver</code> acts as a reverse HTTP proxy for an existing OX App Suite installation and injects the tested JavaScript code in its replies.		The <code>appserver</code> tool is used to develop and test the OX App Suite UI and its plugins with a remote backend. <code>appserver</code> acts as a reverse HTTP proxy for an existing OX App Suite installation and injects the tested JavaScript code in its replies.

	WARNING: These informations are only tested and validated for DEBIAN ~~based~~ installations! Please use a DEBIAN ~~based~~ virtual machine.		WARNING: These informations are only tested and validated for DEBIAN installations! Please use a DEBIAN virtual machine.

	== Installation ==		== Installation ==