-
Notifications
You must be signed in to change notification settings - Fork 405
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation about localConfig.js #1654
Merged
offtherailz
merged 2 commits into
geosolutions-it:master
from
offtherailz:localconfig_doc
Mar 29, 2017
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Application configuration | ||
The application load will load by Default it will load the `localConfig.js` | ||
|
||
You can load a custom configuration by passing the `localConfig` argument in query string: | ||
|
||
``` | ||
localhost:8081/?localConfig=myConfig#/viewer/openlayers/0 | ||
``` | ||
|
||
|
||
The **localConfig** file contains the mail informations about URLs to load and plugins to load in the various modes. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. mail informations? |
||
|
||
This is the mail structure: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. mail? |
||
``` | ||
{ | ||
// URL of geoStore | ||
"geoStoreUrl": "rest/geostore/", | ||
// printURL the url of the print service, if any | ||
"printUrl": "/geoserver-test/pdf/info.json", | ||
// a string or an object for the proxy URL. | ||
"proxyUrl": { | ||
// if it is an object, the url entry holds the url to the proxy | ||
"url": "/MapStore2/proxy/?url=", | ||
// useCORS array contains a list of services that support CORS and so do not need a proxy | ||
"useCORS": ["http://nominatim.openstreetmap.org", "https://nominatim.openstreetmap.org"] | ||
}, | ||
// API keys for bing and mapquest services | ||
"bingApiKey" | ||
"mapquestApiKey" | ||
// path to the translation files directory (if different from default) | ||
"translationsPath" | ||
// if true, every ajax and mapping request will be authenticated with the configurations if match a rule | ||
"useAuthenticationRules": true | ||
// the athentication rules to match | ||
"authenticationRules": [ | ||
{ // every rule has a `urlPattern` regex to match | ||
"urlPattern": ".*geostore.*", | ||
// and a authentication `method` to use (basic, authkey) | ||
"method": "basic" | ||
}, { | ||
"urlPattern": "\\/geoserver.*", | ||
"method": "authkey" | ||
} | ||
"plugins": { | ||
// plugins to load for the mobile mode | ||
"mobile": [...] | ||
// plugins to load for the desktop mode | ||
"desktop": [...] | ||
// plugins to load for the embedded mode | ||
"embedded": [...] | ||
// plugins to load for the myMode mode | ||
"myMode": [...] | ||
} | ||
], | ||
``` | ||
If you are building your own app, you can choose to create your custom modes or force one of them by passing the `mode` parameter in the query string. | ||
|
||
For configuring plugins, see the [Configuring Plugins Section](plugins-documentation) and the [plugin reference page](./api/plugins) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
load will load ?