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 2019-08-29 14:11:07 +09:00
parent f124be3298
commit 28b13a2211
1 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -9,7 +9,7 @@ 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 [Elasticsearch](https://www.elastic.co/products/elasticsearch), but knowledge/experience about 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/13.2/admin/webconfig-guide.html), [file system](https://fess.codelibs.org/13.2/admin/fileconfig-guide.html), or [Data Store](https://fess.codelibs.org/13.2/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 also contains a Crawler, which can crawl documents on a [web server](https://fess.codelibs.org/13.3/admin/webconfig-guide.html), [file system](https://fess.codelibs.org/13.3/admin/fileconfig-guide.html), or [Data Store](https://fess.codelibs.org/13.3/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 13.2 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 13.3 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-13.2.x.zip
$ cd fess-13.2.x
$ unzip fess-13.3.x.zip
$ cd fess-13.3.x
$ ./bin/fess
For more details, see the [Installation Guide](https://fess.codelibs.org/13.2/install/index.html).
For more details, see the [Installation Guide](https://fess.codelibs.org/13.3/install/index.html).
### Docker
@ -51,7 +51,7 @@ We provide Docker images on [Docker Hub](https://hub.docker.com/r/codelibs/fess/
![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/13.2/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/13.3/admin/scheduler-guide.html).
## Migration from another search provider
@ -63,7 +63,7 @@ Please see [fess-xpack](https://github.com/codelibs/fess-xpack).
## Data Store
Currently, Fess supports crawling the following [storage locations and APIs](https://fess.codelibs.org/13.2/admin/dataconfig-guide.html):
Currently, Fess supports crawling the following [storage locations and APIs](https://fess.codelibs.org/13.3/admin/dataconfig-guide.html):
- [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian)
- [Box](https://github.com/codelibs/fess-ds-box)
@ -71,12 +71,19 @@ Currently, Fess supports crawling the following [storage locations and APIs](htt
- [Database](https://github.com/codelibs/fess-ds-db)
- [Dropbox](https://github.com/codelibs/fess-ds-dropbox)
- [Elasticsearch](https://github.com/codelibs/fess-ds-elasticsearch)
- [Git](https://github.com/codelibs/fess-ds-git)
- [Gitbucket](https://github.com/codelibs/fess-ds-gitbucket)
- [G Suite](https://github.com/codelibs/fess-ds-gsuite)
- [JSON](https://github.com/codelibs/fess-ds-json)
- [Office 365](https://github.com/codelibs/fess-ds-office365)
- [S3](https://github.com/codelibs/fess-ds-s3)
- [Slack](https://github.com/codelibs/fess-ds-slack)
## Theme
- [Simple](https://github.com/codelibs/fess-theme-simple)
- [Classic](https://github.com/codelibs/fess-theme-classic)
## Localization
### Japanese