Cscott has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/233842

Change subject: Better describe the "domain" setting in 
`localsettings.js.example`
......................................................................

Better describe the "domain" setting in `localsettings.js.example`

Change-Id: Iaa41f3f3f4bdb96f8d6a6fd33816cc9dd57bde4c
---
M api/localsettings.js.example
1 file changed, 16 insertions(+), 3 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/services/parsoid 
refs/changes/42/233842/1

diff --git a/api/localsettings.js.example b/api/localsettings.js.example
index cadc791..14871db 100644
--- a/api/localsettings.js.example
+++ b/api/localsettings.js.example
@@ -17,13 +17,26 @@
        // Otherwise, defaults to 
"Parsoid/<current-version-defined-in-package.json>"
        //parsoidConfig.userAgent = "My-User-Agent-String";
 
-       // The URL of your MediaWiki API endpoint.
-       parsoidConfig.setMwApi({ prefix: 'localhost', uri: 
'http://localhost/w/api.php' });
+       // Configure Parsoid to point to your MediaWiki instance.
+       parsoidConfig.setMwApi({
+               // The "prefix" is the name given to this wiki configuration in 
the
+               // (deprecated) Parsoid v1 API.
+               prefix: 'localhost', // optional
+               // The "domain" is used for communication with Visual Editor
+               // and RESTBase.  It defaults to the hostname portion of
+               // the `uri` property below, but you can manually set it
+               // to an arbitrary string.
+               domain: 'localhost', // optional
+               // This is the only required parameter:
+               // the URL of you MediaWiki API endpoint.
+               uri: 'http://localhost/w/api.php'
+       });
        // To specify a proxy (or proxy headers) specific to this prefix (which
        // overrides defaultAPIProxyURI) use:
        /*
        parsoidConfig.setMwApi({
-               prefix: 'localhost',
+               prefix: 'localhost', // optional
+               domain: 'localhost', // optional
                uri: 'http://localhost/w/api.php',
                // set `proxy` to `null` to override and force no proxying.
                proxy: {

-- 
To view, visit https://gerrit.wikimedia.org/r/233842
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Iaa41f3f3f4bdb96f8d6a6fd33816cc9dd57bde4c
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/services/parsoid
Gerrit-Branch: master
Gerrit-Owner: Cscott <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to