Action plug-in setting - URL

(1) Required setting

The url points to the web page that will be loaded when the plug-in is executed. The main page and it's resources can be internally hosted inside the plug-in folder, but it can also be on an external server as HTML, PHP, ASP, JSP, etc.

<action>
    <url>...</url>
</action>

Internally hosted plug-ins

Internally hosted plug-ins can have a url relative to the Elvis server domain. This allows you to create a plug-in which can run directly in any Elvis server installation without having to change the url setting. There are variables available that can be used to create these relative URLs.

Examples

Internally hosted, in the plug-in folder

Assume we have a plug-in called my_plugin, with the following path: active/my_plugin/index.html.

<url>${pluginUrl}/index.html</url>

Internally hosted, in the base plug-ins folder

Assume we have a plug-in that uses the HTML page from the plug-in base, for example the debug plug-in, which has the following path: plugin_base/action.base/debug.base/index.html.

<url>${pluginBaseUrl}/index.html</url>

Or:

<url>${pluginsBaseRootUrl}/action.base/debug.base/index.html</url>

Externally hosted

Assume that we have a plug-in hosted on a different machine, different domain, etc.

<url>http://www.myserver.com/specialplugin/dosomething.php</url>