Repository files navigation

gitbucket-fess-plugin is aGitBucket plugin that providesglobal search, that is, search across multiple repositories.

Users can search for:

• Code in all public repositories
• Code in private repositories where you can access
• Issues /Pull requests
• Wiki pages

This plugin cooperates withFess, which is a full-text search server powered byElasticsearch.But, special knowledge is NOT required to use both Fess and this plugin.

• open source software provided under Apache license
• easy to deploy
• powerful search engine based onElasticsearch
• can index/search documents in30+ languages
• supportsmany file formats (pdf, MS Office, etc.)

• Japanese Documentation

SeeMaven Repository.

• Installation
• Setting Up
• Private Repository Search
• Continuous Crawl

Downloadgitbucket-fess-plugin jar file fromthe release page andput it into~/.gitbucket/plugins (If the directory does not exist, create it by hand).

After the installation, the admin user sets up both of GitBucket and Fess.

The flow of the setting is like the following:

• Step 1. Run GitBucket and Fess
• Step 2. Generate Token for Crawler @GitBucket
• Step 3. Set up Crawler @Fess
• Step 4. Run Crawler @Fess
• Step 5. Register Fess's URL @GitBucket

RunGitBucket andFess.If you run the both applications onlocalhost, use different port numbers.

$ java -jar gitbucket.war --port=8080 --prefix=gitbucket

$ ./bin/fess -Dfess.port=8081 -Dfess.context.path=/fess/

Access tohttp://[GitBucket URL]/[User Name]/_application as a GitBucket's admin user and generate an access token.This token will be used by crawlers of Fess.

Access tohttp://[Fess URL]/admin/dataconfig/ as a Fess's admin user and set up a data crawler.

Then, fill each form as below:

• Name: String
• Handler Name:GitBucketDataStore
• Parameter:

url=http://[GitBucket URL]token=[GitBucket's Token generated in Step 2]

You don't have to change other values.

After you create a configuration successfully, you can find it inhttp://[Fess URL]/admin/dataconfig/.Then, click it and create a new crawling job.

You can set up a crawling schedule here, but you can also change it later.Thus, if you are new to Fess,　you don't need to change any value here.(For more details about scheduling, seea later section.)

Move tohttp://[Fess URL]/admin/scheduler/.Then, you will find the job created in Step 3 on the top of the list.Choose and start it.

If a crawler starts successfully, the status of the job scheduler becomesRunning like the following:

Crawling process takes time, depending on a number of contents in GitBucket.Fess stores codes on the default branch in each repository.After the crawling job finishes, you can search GitBucket's contents on Fess.

This is the final step.Access tohttp://[GitBucket URL]/fess/settings as an admin user and register the URL ofFess's top page.Note that the following image uses the URL of Fess started with flags-Dfess.port=8081 -Dfess.context.path=/fess/.

You can also register aFess's access token here.It is required for private repository search, but you can leave this form empty now.For more details, seethe next section.

Then, global search will be enabled!

If the admin user registers aFess's access token athttp://[GitBucket URL]/fess/settings,users can explore their private repositories.

How to generate Fess's access token

Access tohttp://[Fess URL]/admin/accesstoken/ as an admin user andclick theCreate New button.

Next, fill in the form like the following:

• Name: String
• Permissions: empty
• Parameter Name:permission

Then, access token will be created.

By setting upjob schedulers on Fess,you can run data crawlers periodically to keep search results up to date.

Access tohttp://[FessURL]/admin/scheduler/ and choose a crawler job.Then, you can setting up the value ofSchedule inCron-format.

You need toinstall sbt to build this plugin from source code.

$ sbt package

$ sbt scalafmt

Any contribution will be appreciated!Please sendissues orpull requests.

If you want to increment the version number, please update values in:

• build.sbt
• src/main/scala/Plugin.scala