https://github.com/codelibs/docker-codesearch
Code Search on Fess
https://github.com/codelibs/docker-codesearch
fess
Last synced: about 2 months ago
JSON representation
Code Search on Fess
- Host: GitHub
- URL: https://github.com/codelibs/docker-codesearch
- Owner: codelibs
- Created: 2019-09-02T14:18:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-02T04:48:00.000Z (8 months ago)
- Last Synced: 2025-03-30T18:04:21.135Z (3 months ago)
- Topics: fess
- Language: Shell
- Homepage: https://codesearch.codelibs.org
- Size: 172 KB
- Stars: 11
- Watchers: 8
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Code Search on Fess
[Fess](https://fess.codelibs.org/) is an Enterprise Search Server. This Docker environment provides a Source Code Search Server using Fess.
## Public Site
* [codesearch.codelibs.org](https://codesearch.codelibs.org/)
## Getting Started
### Setup
First, clone the repository and navigate into the directory:
```bash
$ git clone https://github.com/codelibs/docker-codesearch.git
$ cd docker-codesearch
$ bash ./bin/setup.sh
```
### Start the Server
To start the server, use Docker Compose:
```bash
docker compose -f compose.yaml up -d
```
Once the server is running, access it at [http://localhost:8080/](http://localhost:8080/).
### Create an Access Token
To use the Admin API for Fess, create an access token with the `{role}admin-api` permission on the Admin Access Token page ([http://localhost:8080/admin/accesstoken/](http://localhost:8080/admin/accesstoken/)).
For more details, see the [Admin Access Token Guide](https://fess.codelibs.org/14.14/admin/accesstoken-guide.html).
### Create DataStore Configuration for GitHub
You can create DataStore and Scheduler settings on Fess using the `bin/register_github.sh` script:
```bash
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
```
Check the created settings on the DataConfig page ([http://localhost:8080/admin/dataconfig/](http://localhost:8080/admin/dataconfig/)).
### Start the Crawler
To start the crawler, run `Default Crawler` or `Data Crawler - ...` on the Admin Scheduler page ([http://localhost:8080/admin/scheduler/](http://localhost:8080/admin/scheduler/)).
### Search
You can view search results at [http://localhost:8080/](http://localhost:8080/).
### Stop the Server
To stop the server, use the following command:
```bash
docker compose -f compose.yaml down
```