Cscott has uploaded a new change for review. https://gerrit.wikimedia.org/r/159101
Change subject: Clarify README with local development instructions. ...................................................................... Clarify README with local development instructions. Change-Id: Ic61ff6df80e22e2e8977e7b9cd44fe58aff328cd --- M README.md 1 file changed, 15 insertions(+), 2 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Collection/OfflineContentGenerator refs/changes/01/159101/1 diff --git a/README.md b/README.md index 827bfe4..6817859 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,24 @@ Create `/etc/mw-collection-ocg.js` to configure the render service. See [the default configuration](./defaults.js) for more details. +## Running a development server +See [wiki](https://wikitech.wikimedia.org/wiki/OCG#Installing_a_development_instance) +for instructions on how to configure a local [Collection] extension to point +to this server. But you can run a local instance with +```sh +apt-get install redis-server # runs a local redis service on port 6379 +cd <repodir> ; npm install +./mw-ocg-service.js # starts a front end ocg service on port 17080 +``` + ## Binary node modules -The following node binary modules are required: -* hiredis +The following node binary module is required: * sqlite3 (for `bundler` and `latex_renderer`) +In addition, better performance is obtained if the following binary +module is installed: +* hiredis (for this service) + Be aware of these when deploying to a new node version or machine architecture. You may need to `npm rebuild <package name>`. -- To view, visit https://gerrit.wikimedia.org/r/159101 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ic61ff6df80e22e2e8977e7b9cd44fe58aff328cd Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/Collection/OfflineContentGenerator Gerrit-Branch: master Gerrit-Owner: Cscott <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
