https://github.com/codelibs/docker-semanticsearch
https://github.com/codelibs/docker-semanticsearch
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codelibs/docker-semanticsearch
- Owner: codelibs
- Created: 2023-08-31T08:23:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-31T12:09:16.000Z (6 months ago)
- Last Synced: 2025-03-30T18:04:25.840Z (3 months ago)
- Language: Java
- Size: 27.3 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Semantic Search on Fess
[Fess](https://fess.codelibs.org/) is an Enterprise Search Server. This Docker environment provides a Semantic Search Server on Fess.
## Public Site
Visit our public site at [semantic.codelibs.org](https://semantic.codelibs.org/).
## Getting Started
### Prerequisites
Ensure you have Docker and Git installed on your system.
### Setup
Clone the repository and run the setup script:
```sh
git clone https://github.com/codelibs/docker-semanticsearch.git
cd docker-semanticsearch
bash ./bin/setup.sh
```
### Start the Server
Start the server using Docker Compose:
```sh
docker compose -f compose.yaml up -d
```
Once started, access the server at `http://localhost:8080/`.
### Configure Semantic Search
Run the setup script for semantic search models:
```sh
bash <(curl -s https://raw.githubusercontent.com/codelibs/fess-webapp-semantic-search/refs/tags/fess-webapp-semantic-search-14.18.0/tools/setup.sh)
```
Select a model from the list provided by the script. For example, choose option `9` for `huggingface/sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2`.
The script will output system properties similar to the following:
```
--- system properties: start ---
fess.semantic_search.pipeline=neural_pipeline
fess.semantic_search.content.nested_field=content_vector
fess.semantic_search.content.chunk_field=content_chunk
fess.semantic_search.content.field=knn
fess.semantic_search.content.dimension=384
fess.semantic_search.content.method=hnsw
fess.semantic_search.content.engine=lucene
fess.semantic_search.content.space_type=cosinesimil
fess.semantic_search.content.model_id=...
fess.semantic_search.min_score=0.5
--- system properties: end ---
```
Copy these properties.
### Update System Properties in Fess
1. Go to the **Admin** > **General** page.
2. Add the copied values to the **System Properties** field.
3. Click **Update** button.
### Configure Crawl Settings
When creating crawl settings before starting a crawl, you must specify semantic in the Virtual Host field. This step ensures semantic search functions correctly.
### Reindex Data
1. Navigate to the **Admin** > **Maintenance** page.
2. Start the reindexing process.
Your semantic search setup on Fess is now complete and ready to use.
### Stop the Server
To stop the server, run:
```sh
docker compose -f compose.yaml down
```
## For Production
To deploy in a production environment, replace `semantic.codelibs.org` with your domain in `compose-production.yaml`.
---
For additional support or information, please visit the [Fess documentation](https://fess.codelibs.org/).