chore: fixed search index docs

This commit is contained in:
Andrii V 2025-06-19 19:14:52 +02:00
parent ae7ee26257
commit e0dccd2ff4
2 changed files with 12 additions and 9 deletions

View file

@ -3,4 +3,4 @@
# docker build --tag sphinx-doc-build-rc .
# Build Docs
# cd && docker run --rm -v $(pwd):/project --workdir=/project/docs sphinx-doc-build-rc make clean html
# cd .. && docker run --rm -v $(pwd):/project --workdir=/project/docs sphinx-doc-build-rc make clean html

View file

@ -3,16 +3,19 @@
Full-text Search
----------------
.. important::
Some parts of this page refers to legacy components like rccontrol
We are in process of updating documentantion with up-to-date information
RhodeCode provides a full text search capabilities to search inside file content,
commit message, and file paths. Indexing is not enabled by default and to use
full text search building an index is a pre-requisite.
commit message, and file paths (This featureis only available in Enterprise edition).
Indexing is not enabled by default and to use full text search building an index is a pre-requisite.
By default RhodeCode is configured to use `Whoosh`_ to index |repos| and
provide full-text search. `Whoosh`_ works well for a small amount of data and
shouldn't be used in case of large code-bases and lots of repositories.
|RCE| provides support for `ElasticSearch 8`_ as a backend to index |repos|.
See :ref:`enable-elasticsearch` for details.
|RCE| also provides support for `ElasticSearch 6`_ as a backend more for advanced
and scalable search. See :ref:`enable-elasticsearch` for details.
Indexing
^^^^^^^^
@ -343,4 +346,4 @@ For example::
rhodecode-index --instance-name=enterprise-1 --es-version=8 --engine-location=http://elasticsearch:9200
.. _ElasticSearch 6: https://www.elastic.co/
.. _ElasticSearch 8: https://www.elastic.co/