Fireplace/Configuring: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
(hearth -> src)
 
Line 9: Line 9:
= Configuring Fireplace =
= Configuring Fireplace =
== Local Configuration ==
== Local Configuration ==
Fireplace's local configuration is saved under <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;margin:2px 0;padding:0 3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">/hearth/media/js/settings_local.js</code> or if the file doesn't exists you would find the file as <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;padding:3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">/hearth/media/js/settings_local.js.dist</code>, rename this file to <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;padding:3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">settings_local.js</code>. The only setting you will find in it is the <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;padding:3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">api_url</code>. The <i>api_url</i> is the network host that is queried for fireplace's data i.e. <i>Categories, Apps, Reviews and Ratings</i>
Fireplace's local configuration is saved under <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;margin:2px 0;padding:0 3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">/src/media/js/settings_local.js</code> or if the file doesn't exists you would find the file as <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;padding:3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">/src/media/js/settings_local.js.dist</code>, rename this file to <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;padding:3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">settings_local.js</code>. The only setting you will find in it is the <code style="display:inline-block;padding:0px;font:13px 'Open Sans',arial,tahoma;color:#000;background:#f5f5f5;padding:3px;border:1px solid #ccc;box-shadow:0 0 1px #c3d1ec;border-radius:3px;">api_url</code>. The <i>api_url</i> is the network host that is queried for fireplace's data i.e. <i>Categories, Apps, Reviews and Ratings</i>
==== Suggested Change ====
==== Suggested Change ====
The default <i>api_url</i> is set to http://chimney.paas.allizom.org, you can change it to point to flue server running on your localhost i.e. http://localhost:5000 <i>(default flue port is 5000)</i> or to any other server that is capable of sending the data in the prescribed format.<br/>
The default <i>api_url</i> is set to http://chimney.paas.allizom.org, you can change it to point to flue server running on your localhost i.e. http://localhost:5000 <i>(default flue port is 5000)</i> or to any other server that is capable of sending the data in the prescribed format.<br/>
Line 16: Line 16:
define('settings_local', [], function() {<br/>&nbsp;&nbsp;&nbsp;&nbsp;return {<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;api_url: 'http://localhost:5000'<br/>&nbsp;&nbsp;&nbsp;&nbsp;};<br/>});
define('settings_local', [], function() {<br/>&nbsp;&nbsp;&nbsp;&nbsp;return {<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;api_url: 'http://localhost:5000'<br/>&nbsp;&nbsp;&nbsp;&nbsp;};<br/>});
</code>
</code>
== Inferno Configuration ==
== Inferno Configuration ==
== Travis Configuration ==
== Travis Configuration ==

Latest revision as of 18:48, 13 September 2014

Please do not edit this page unless you are on the Fireplace team. Your feedback and comments are welcomed on the discussion page.


This is a Beta Draft

Overview

Fireplace has different components that has their own set of configurations, before you make any change to any configuration file please be advised to first backup the original file so in case you fall in a trap it is easier for you to escape out.

Configuring Fireplace

Local Configuration

Fireplace's local configuration is saved under /src/media/js/settings_local.js or if the file doesn't exists you would find the file as /src/media/js/settings_local.js.dist, rename this file to settings_local.js. The only setting you will find in it is the api_url. The api_url is the network host that is queried for fireplace's data i.e. Categories, Apps, Reviews and Ratings

Suggested Change

The default api_url is set to http://chimney.paas.allizom.org, you can change it to point to flue server running on your localhost i.e. http://localhost:5000 (default flue port is 5000) or to any other server that is capable of sending the data in the prescribed format.
Note: Do not leave a trailing slash at the end of the URL.
define('settings_local', [], function() {
    return {
        api_url: 'http://localhost:5000'
    };
});

Inferno Configuration

Travis Configuration