Search the contents of GitHub Enterprise wikis.

We welcome your feedback and contributions.

• Find out about contributing
• File a bug

1. install vagrant

2. clone the repository:

   https://github.com/cfpb/github-wiki-search.git

3. install vagrant cachier

   vagrant plugin install vagrant-cachier

4. enter the repo directory:

   cd github-wiki-search

5. copy settings_example.py to settings.py and modify for your installation

6. start the virtualmachine

   vagrant up

7. ssh into the virtualmachine

   vagrant ssh

8. run the provisioning script

   sudo /vagrant/provision/provision.py

9. run the sync script

   /vagrant/server/sync.py

10. visit the search page at

    http://localhost:8080

• npm
• grunt-cli

1. install dependencies:

   npm install

2. pull in Bower components:

   grunt vendor

1. compile JavaScript and LESS files:

   grunt

2. update dist folder with newly compiled assets:

   grunt dist

Or use grunt serve. This will run both commands when commonly edited front end files have changed. It also sets up a local server on port 8000 for previewing the front end.

If your index isn't updating quite right, it may help to drop the index first. One example we found of this is where the mapping file wasn't updating correctly during the index process unless we dropped the index beforehand.

1. Drop the existing index:

curl -XDELETE http://search.demo.cfpb.gov/search/_all/_all/

1. Run a python script to rebuild everything

./server/index.py