Skip to content
Code Search on Fess
Java Shell CSS HTML
Branch: master
Clone or download
Latest commit 3bc2279 Dec 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin add icon view Nov 10, 2019
data/fess mask email address Dec 28, 2019
.gitignore add view files Oct 14, 2019
README.md fess 13.4.3 Nov 21, 2019
docker-compose.production.yml add yaml for production Nov 4, 2019
docker-compose.yml

README.md

Code Search on Fess

Fess is Enterprise Search Server. This docker environment provides Source Code Search Server on Fess.

Public Site

Getting Started

Setup

$ git clone -b 13.4.3.0 https://github.com/codelibs/docker-codesearch.git
$ cd docker-codesearch
$ bash ./bin/setup.sh

Start Server

docker-compose up -d

and then access http://localhost:8080/.

Create Access Token

To use Admin API for Fess, you need to create an access token with {role}admin-api permission at Admin Access Token page(http://localhost:8080/admin/accesstoken/). For more details, see Admin Access Token.

Install DataStore Git Plugin

To crawl a git repository, you need to install fess-ds-git plugin in Admin Plugin page(http://localhost:8080/admin/plugin/).

Create DataStore coniguration for GitHub

Using bin/register_github.sh, you can create DataStore and Scheduler settings on Fess.

register_github.sh ACCESS_TOKEN FESS_URL REPO_DOMAIN REPO_ORG REPO_NAME

Example:
$ bash ./bin/register_github.sh ...token... http://localhost:8080 github.com codelibs fess

You can check if settings are created in http://localhost:8080/admin/dataconfig/.

Start Crawler

To start the crawler, run Default Crawler or Data Crawler - ... in Admin Scheduler page(http://localhost:8080/admin/scheduler/).

Search

You can check search results on http://localhost:8080/.

Stop Server

docker-compose down

For Production

  • Replace codesearch.codelibs.org with your domain in docker-compose.yml.
  • If you want to use SSL, modify a value of STAGE in docker-compose.yml.
You can’t perform that action at this time.