0ct0pu5/fess
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update doc

Browse source
This commit is contained in:
Shinsuke Sugaya 2024-09-30 22:06:45 +09:00
parent 3726fbec40
commit b5b6e45200
1 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -8,8 +8,8 @@ Fess Enterprise Search Server [![Tweet](https://img.shields.io/twitter/url/http/
Fess is a very powerful and easily deployable Enterprise Search Server. You can quickly install and run Fess on any platform where you can run the Java Runtime Environment. Fess is provided under the [Apache License 2.0](LICENSE).
Fess is based on [OpenSearch](https://github.com/opensearch-project/OpenSearch)/[Elasticsearch](https://github.com/elastic/elasticsearch), but knowledge/experience about OpenSearch/Elasticsearch is _not_ required. Fess provides an easy to use Administration GUI to configure the system via your browser.
Fess also contains a Crawler, which can crawl documents on a [web server](https://fess.codelibs.org/14.11/admin/webconfig-guide.html), [file system](https://fess.codelibs.org/14.11/admin/fileconfig-guide.html), or [Data Store](https://fess.codelibs.org/14.11/admin/dataconfig-guide.html) (such as a CSV or database). Many file formats are supported including (but not limited to): Microsoft Office, PDF, and zip.
Fess is based on [OpenSearch](https://github.com/opensearch-project/OpenSearch), but knowledge/experience about OpenSearch is _not_ required. Fess provides an easy to use Administration GUI to configure the system via your browser.
Fess also contains a Crawler, which can crawl documents on a [web server](https://fess.codelibs.org/14.17/admin/webconfig-guide.html), [file system](https://fess.codelibs.org/14.17/admin/fileconfig-guide.html), or [Data Store](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html) (such as a CSV or database). Many file formats are supported including (but not limited to): Microsoft Office, PDF, and zip.
*[Fess Site Search](https://github.com/codelibs/fess-site-search)* is a free alternative to [Google Site Search](https://enterprise.google.com/search/products/gss.html). For more details, see the [FSS JS Generator documentation](https://fss-generator.codelibs.org/docs/manual).
@ -27,15 +27,15 @@ There are 2 ways to try Fess. The first is to download and install yourself. The
### Download and Install/Run
Fess 14.11 is now available and can be downloaded on the [Releases page](https://github.com/codelibs/fess/releases "download"). Downloads come in 3 flavors: deb, rpm, zip.
Fess 14.17 is now available and can be downloaded on the [Releases page](https://github.com/codelibs/fess/releases "download"). Downloads come in 3 flavors: deb, rpm, zip.
The following commands show how to use the zip download:
$ unzip fess-14.11.x.zip
$ cd fess-14.11.x
$ unzip fess-14.17.x.zip
$ cd fess-14.17.x
$ ./bin/fess
For more details, see the [Installation Guide](https://fess.codelibs.org/14.11/install/index.html).
For more details, see the [Installation Guide](https://fess.codelibs.org/14.17/install/index.html).
### Docker
@ -51,7 +51,7 @@ We provide Docker images on [ghcr.io](https://github.com/orgs/codelibs/packages)
![Admin UI](https://fess.codelibs.org/_images/fess_admin_dashboard.png)
You can register crawling targets in the Admin UI on the (Web, File, Data Store) crawler configuration pages, and then start the Crawler manually on the [Scheduler page](https://fess.codelibs.org/14.11/admin/scheduler-guide.html).
You can register crawling targets in the Admin UI on the (Web, File, Data Store) crawler configuration pages, and then start the Crawler manually on the [Scheduler page](https://fess.codelibs.org/14.17/admin/scheduler-guide.html).
## Migration from another search provider
@ -59,7 +59,7 @@ Please see [MIGRATION.md](MIGRATION.md).
## Data Store
Currently, Fess supports crawling the following [storage locations and APIs](https://fess.codelibs.org/14.11/admin/dataconfig-guide.html):
Currently, Fess supports crawling the following [storage locations and APIs](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html):
- [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian)
- [Box](https://github.com/codelibs/fess-ds-box)
@ -157,7 +157,7 @@ If you want to add labels/messages for your language, please translate propertie
* [fess_label_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_label_en.properties)
* [fess_message_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_message_en.properties)
For search/index analyzer, if [doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json) contains lang\_[lang] for your language, please modify the analyzer for your language. For more details about Analyzers, see the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html).
For search/index analyzer, if [doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json) contains lang\_[lang] for your language, please modify the analyzer for your language. For more details about Analyzers, see the [OpenSearch documentation](https://opensearch.org/docs/latest/analyzers/search-analyzers/).
We welcome pull requests for your language.
@ -168,4 +168,3 @@ We welcome pull requests for your language.
* [Lasta Job](https://github.com/lastaflute/lasta-job "Lasta Job"): Job Scheduler
* [Fess Crawler](https://github.com/codelibs/fess-crawler "Fess Crawler"): Web Crawler
* [OpenSearch](https://opensearch.org/ "OpenSearch"): Search Engine
* [Elasticsearch](https://github.com/elastic/elasticsearch "Elasticsearch"): Search Engine