Skip to content

Latest commit

 

History

History
82 lines (45 loc) · 2.7 KB

INSTALL.md

File metadata and controls

82 lines (45 loc) · 2.7 KB
Raw

Installation

Prerequisites

  1. Node.js v6 or above.

    On windows if you get node-command-not-found you may need to reboot, logoff, or restart explorer.exe.

  2. Greasemonkey (for Firefox) or Tampermonkey (for Chrome).

Install via npm

Install it as a global package so you may run it from command-line from anywhere:

npm install --global pocal

Running

Just run

pocal

It should output something like

Listening on port 6000

Open http://localhost:6000 in your browser to view the dashboard.

Setup

Addons

To achieve the client-side url-manipulations and keyword searches it will need to install a userscript (via greasemonkey) and custom search plugin.

Goto http://localhost:6000/addons

Install the userscript

The userscript is hosted from the server itself which you may find in http://localhost:6000/addons/userscript.user.js

Install the custom search plugin

The custom search plugin is an OpenSearch plugin that redirects search queries to the server. It is also hosted on the server itself which you may find in http://localhost:6000/addons/search-plugin

  • Note: Currently this auto-install for some reason only works in Firefox.

    In Chrome goto ⠇ > Settings > Search > Manage search engines then in the Other search engines > Add a new search engine (scroll to the bottom if you have many search engines):

Name Keyword URL
Pocal p http://localhost:6000/search?q=%s

The click Make default in front of it.

If you don't wish to make it your default search engine you'll have to prefix all your search queries with the chosen keyword (p). It automatically searches for google for queries that don't match with any keyword so that covers the main purpose of the default google search plugin anyways.