update doc

This commit is contained in:
Shinsuke Sugaya 2017-03-09 12:46:24 +09:00
parent d74fe9bd6b
commit 80521485e2

View file

@ -9,14 +9,11 @@ Fess is Elasticsearch based search server, but knowledge/experience about Elasti
## Web Sites
- [English](http://fess.codelibs.org/)
- [Japanese](http://fess.codelibs.org/ja/)
- [fess.codelibs.org](http://fess.codelibs.org/)
## Issues/Questions
Please file an [issue](https://github.com/codelibs/fess/issues "issue").
(Japanese forum is [here](https://github.com/codelibs/codelibs-ja-forum "here").)
For submitted questions, see [label:question](https://github.com/codelibs/fess/issues?q=label%3Aquestion%20 "label:question").
## Getting Started
@ -35,8 +32,13 @@ For the details, see [Installation Guide](http://fess.codelibs.org/11.0/install/
### Access Fess
- Search UI: http://localhost:8080/
- Admin UI: http://localhost:8080/admin/ (username/password is admin/admin)
- **Search UI**: http://localhost:8080/
![Search UI](doc/images/screenshot-search-page.png)
- **Admin UI**: http://localhost:8080/admin/ (username/password is admin/admin)
![Admin UI](doc/images/screenshot-admin-page.png)
You can register crawling targets on Web/File System/Data Store of admin pages, and then start Crawler on Scheduler page manually.
@ -45,6 +47,12 @@ You can register crawling targets on Web/File System/Data Store of admin pages,
We provide Docker image on Docker Hub.
For more details, see [Public Repository](https://hub.docker.com/r/codelibs/fess/).
## Localization
- [Japanese](http://fess.codelibs.org/ja/)
- [Korean PDF Document](https://github.com/nocode2k/fess/releases/download/fess-ko-10.1.0/FESS-ko_10.1.0_.pdf)
- [Korean Forum](https://github.com/nocode2k/fess-kr-forum)
## Development Information
### Get Source Code
@ -52,7 +60,7 @@ For more details, see [Public Repository](https://hub.docker.com/r/codelibs/fess
First of all, clone Fess's repositories:
$ cd ~/workspace
$ git clone https://github.com/codelibs/fess.git
$ git clone https://github.com/nocode2k/fess.git
and then imports it as Maven project on eclipse or ohter IDE.
@ -80,12 +88,9 @@ Run package goal and then the release file is created in target/releases.
$ mvn dbflute:freegen
$ mvn license:format
## Localization
### Translate In Your Language
Fess is internationalized software, and supports the following languages at the moment:
* English
* Japanese
Fess is internationalized software.
If you want to add labels/messages for your language, please translate properties file and then rename to fess\_*_[lang].properties.