improve English xdocs
This commit is contained in:
shatake
parent
39e602ab0b
commit
ec04e12d70
1 changed files with 74 additions and 73 deletions
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<document>
|
||||
<properties>
|
||||
<title>Installation of the Fess</title>
|
||||
<title>Fess Installation</title>
|
||||
<author>Shinsuke Sugaya</author>
|
||||
</properties>
|
||||
<head>
|
||||
|
|
@ -10,73 +10,74 @@
|
|||
</head>
|
||||
<body><p style="font-weight:bold;color:red;">This page is generated by Machine Translation from Japanese.</p>
|
||||
<section name='How to install'>
|
||||
<p>Any operating system, it is possible to Fess any Java runtime environment. Work environment is as follows.</p>
|
||||
<p>Fess can run on any operating system with Java runtime environment. Requirement detail is as follows.</p>
|
||||
<ul>
|
||||
<li>You can run Java, including Windows and Unix OS environment</li>
|
||||
<li>Java: Java 7 or more</li>
|
||||
<li>Operating system: Windows, Unix, etc</li>
|
||||
<li>Java: Java SE version 7 or later</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section name='Java installation'>
|
||||
<p>If Java is not installed please install Java by following these steps.</p>
|
||||
<subsection name='Access to the Java SE downloads page'>
|
||||
<p>With JavaScript enabled for Oracle<a href='http://www.oracle.com/technetwork/java/javase/downloads/index.html' target='_blank'>Java SE Downloads page</a>To access the.</p>
|
||||
<p>* Different versions and follow these steps but<a href='http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html#jdk-7u25-oth-JPR' target='_blank'>Java 7u25</a>Install (recommended). [2014 / 3 / 13]</p>
|
||||
<p>Click the 'Download JDK' JavaSE7. (JavaScript is disabled and download is valid and must)</p>
|
||||
<section name='Installing Java'>
|
||||
<p>If Java is not installed please following these steps below to install Java.</p>
|
||||
<subsection name='Accessing Java SE downloads page'>
|
||||
<p>Browsers with Javascript enable are required to access Oracle's<a href='http://www.oracle.com/technetwork/java/javase/downloads/index.html' target='_blank'>Java SE Downloads page</a>.</p>
|
||||
<p>* We recommend <a href='http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html#jdk-7u25-oth-JPR' target='_blank'>Java 7u25</a>. [2014 / 3 / 13]</p>
|
||||
<p>Click the 'Download JDK' tab. (Without Javascript enable, download will become invalid)</p>
|
||||
<img alt='Access' src='/images/en/install/java-1.png'/>
|
||||
<blockquote>
|
||||
<p>Whether JavaScript is enabled you can check below. (If the Internet Explorer 9)</p>
|
||||
<p>To check whether JavaScript is enabled, you can as follows. (In case of Internet Explorer 9)</p>
|
||||
<ol>
|
||||
<li>Click [tools] on the menu bar.</li>
|
||||
<li>Click the [Internet Options].</li>
|
||||
<li>Click the Security tab.</li>
|
||||
<li>Click the [custom level].</li>
|
||||
<li>Scrawl to the [scripts] section is displayed.</li>
|
||||
<li>In the Active Scripting section radio button to enable a check to confirm.</li>
|
||||
<li>Turn on and off if it is, click OK.</li>
|
||||
<li>Click [Internet Options].</li>
|
||||
<li>Click Security tab.</li>
|
||||
<li>Click [custom level].</li>
|
||||
<li>Scrawl to [scripts] section.</li>
|
||||
<li>In the Active Scripting section, confirm whether button is checked.</li>
|
||||
<li>Turn on to enable Javascript and off to disable Javascript. Then click "OK" button to save change.</li>
|
||||
</ol>
|
||||
</blockquote>
|
||||
</subsection>
|
||||
<subsection name='License verification'>
|
||||
<p>When you accept the license, read 'The Oracle Binary Code License Agreement for Java SE' turn to Accept License Agreement check.</p>
|
||||
<p>Java SE's license detail is as 'The Oracle Binary Code License Agreement for Java SE'. Check "Accept License Agreement" to agree Java SE's license.</p>
|
||||
<img alt='License' src='/images/en/install/java-2.png'/>
|
||||
</subsection>
|
||||
<subsection name='Download start'>
|
||||
<p>Do the JDK download according to the OS you install. Windwos 64-bit if you select Windows 86 x 64 Windows, for Windows 32-bit (Windows 64-bit version of the example is below).</p>
|
||||
<subsection name='Download Java SE'>
|
||||
<p>Different Operating System requires different version of Java SE. In case of Windows 64-bit, you must select Windowsx64 version. In case of Windows 32-bit, you must select Windowx86 version. Java SE's Windowx64 version is used in the following example.</p>
|
||||
<blockquote>
|
||||
<p>PCs are used whether the you can check below. (For Windows 7)</p>
|
||||
<p>You can check whether your window is 32 bits or 64 bits by following these steps below. (In case of Windows 7)</p>
|
||||
<ol>
|
||||
<li>In Control Panel-&gt; system and security → [System] appears to the type of system.</li>
|
||||
<li>In Control Panel, select "system and security" </li>
|
||||
<li>[System] appears to the type of system.</li>
|
||||
</ol>
|
||||
</blockquote>
|
||||
<img alt='Download' src='/images/en/install/java-3.png'/>
|
||||
</subsection>
|
||||
<subsection name='Running JDK Installer'>
|
||||
<p>(XX is the downloaded update release version) run the JDK Installer (jdk-7uXX-windows-x64.exe). The following is an example Windows 64-bit Edition.</p>
|
||||
<p>After downloading, JDK Installer file (jdk-7uXX-windows-x64.exe or jdk-7uXX-windows-x86.exe) is archived. xx is Java SE's version. The following image shows icon image of Java SE 7 version 7's JDK Installer.</p>
|
||||
<img alt='Run' src='/images/en/install/java-4.png'/>
|
||||
<p>Depending on settings in Windows, see allow changes to this computer to the following program? "That may receive dialog. If so, please click the [Yes] button.</p>
|
||||
<p>Double click JDK Installer to start installing Java SE. Depending on Windows settings, there is case where "Accept dialog" is appeared. In that case, click "Yes" to continue installation</p>
|
||||
</subsection>
|
||||
<subsection name='JDK installation'>
|
||||
<p>The installer will launch. Press the [next] button.</p>
|
||||
<p>The installer shows first dialog. Press [next] button to continue.</p>
|
||||
<img alt='Run' src='/images/en/install/java-5.png'/>
|
||||
<p>You can change the destination folder. Left at default without problem, press the [next] button.</p>
|
||||
<p>You can change the installation's destination folder. We recommend using default options. Press [next] button to continue.</p>
|
||||
<img alt='Directory' src='/images/en/install/java-6.png'/>
|
||||
<p>Start installing the JDK, so wait.</p>
|
||||
<p>JDK installer starts installing. Wait until installation finishs.</p>
|
||||
<img alt='JDK installation' src='/images/en/install/java-7.png'/>
|
||||
</subsection>
|
||||
<subsection name='JRE installation'>
|
||||
<p>Run the JRE installation after installing the JDK, JRE installed on your PC. In the JDK as well to change the destination folder is possible, but basically the same JDK folder no problem. Press the [next] button.</p>
|
||||
<p>After JDK installation is finished. JRE installation will be started automatically. JRE will be installed in the same folder as JDK's installed folder. We recommend using the default options. Press [next] button to continue.</p>
|
||||
<img alt='JRE' src='/images/en/install/java-8.png'/>
|
||||
<p>JRE installation starts, so wait a while.</p>
|
||||
<p>JRE installer starts installing. Wait until installation finishs.</p>
|
||||
<img alt='JRE installation' src='/images/en/install/java-9.png'/>
|
||||
</subsection>
|
||||
<subsection name='Completing the installation'>
|
||||
<p>The installation complete message appears. Press the [close] button.</p>
|
||||
<p>After the installation finishes, following dialog will appear. Press [close] button to finish installation.</p>
|
||||
<img alt='JRE installation' src='/images/en/install/java-10.png'/>
|
||||
<p>Installation is complete.</p>
|
||||
<blockquote>
|
||||
<p>The components is the following two. In the following you can check. (For Windows 7)</p>
|
||||
<p>Installed components (JDK and JRE) can be checked by using following step. (In case of Windows 7)</p>
|
||||
<ol>
|
||||
<li>[Control Panel] → [programs] → [programs and features] listed will be.
|
||||
<li>[Control Panel] → [programs] → [programs and features]. Two new installed components appear inside installed components' list.
|
||||
<ul>
|
||||
<li>Java SE Development Kit 7 Update XX (64-bit)</li>
|
||||
<li>Java (TM) Update 7 XX (64-bit)</li>
|
||||
|
|
@ -86,101 +87,101 @@
|
|||
</blockquote>
|
||||
</subsection>
|
||||
<subsection name='Setting environment variables'>
|
||||
<p>This is the setting information and environment variables passed to the program. In order to run the JDK command at the command prompt after the Java installation, setting environment variables is required.</p>
|
||||
<p>Windows 7 sets the following. Select the control panel → system and security → [System] → advanced system settings → environment variables.</p>
|
||||
<p>Fess requires Windows command prompt with runable JDK command. These steps below set up environtment variables to use JDK command from command prompt</p>
|
||||
<p>In case of Windows 7, do as following steps. Select "Control panel" → "System and security" → "System" → "Advanced system settings" → "Environment variables".</p>
|
||||
<img alt='Control Panel' src='/images/en/install/java-11.png'/>
|
||||
<p>Click system and security.</p>
|
||||
<p>Click "System and security".</p>
|
||||
<img alt='System and security' src='/images/en/install/java-12.png'/>
|
||||
<p>Click the 'system'.</p>
|
||||
<p>Click "System".</p>
|
||||
<img alt='System' src='/images/en/install/java-13.png'/>
|
||||
<p>Click the 'advanced settings'.</p>
|
||||
<p>Click "Advanced settings".</p>
|
||||
<img alt='Advanced system settings' src='/images/en/install/java-14.png'/>
|
||||
<p>Click environment variables.</p>
|
||||
<p>Click "Environment variables".</p>
|
||||
<img alt='Environment variables' src='/images/en/install/java-15.png'/>
|
||||
<p>New system environment variables button at the bottom of screen.</p>
|
||||
<p>Click "New system environment variables" button which is located at bottom of setting dialpg</p>
|
||||
<img src='/images/en/install/java-16.png'/>
|
||||
<p>Enter "JAVA_HOME" variable name.</p>
|
||||
<p>Variable name: "JAVA_HOME".</p>
|
||||
<p>Variable value: installed JDK location.</p>
|
||||
<img src='/images/en/install/java-17.png'/>
|
||||
<p>Describes the directory where you installed the JDK to the variable value.</p>
|
||||
<p>Open the C:\Program Files zone\scripting in the Explorer, ' jdk... ' that describes its addresses, looking for a folder.</p>
|
||||
<p>For example if you have installed the jdk version 1.7.0_XX will be C:\Program Files \Java\jdk1.7.0_XX. (Contains the portion of the XX version)</p>
|
||||
<p>Description and then press 'OK'.</p>
|
||||
<p>Locate the row from a list of system environment variables, see variables 'Path'.</p>
|
||||
<p>To check JDK's installed folder do as following steps.</p>
|
||||
<p>Go to C:\Program Files zone\scripting in the Explorer. Then searching for folder with keywor: ' jdk... '.</p>
|
||||
<p>For example if you installed JDK version 1.7.0_XX, installed folder will be C:\Program Files \Java\jdk1.7.0_XX. (XX is JDK version number</p>
|
||||
<p>Parse folder location and then press 'OK' to close dialog.</p>
|
||||
<p>Scroll down list of system environment variables and select variables 'Path'.</p>
|
||||
<img src='/images/en/install/java-18.png'/>
|
||||
<p>And then push open the Edit button, the row at the end of the variable value "; %JAVA_HOME%\bin ' that adds a string, click the 'OK'.</p>
|
||||
<p>Click Edit button. Then add "; %JAVA_HOME%\bin ' to the end of Path value. Click the 'OK' to close dialog.</p>
|
||||
<img src='/images/en/install/java-19.png'/>
|
||||
</subsection>
|
||||
</section>
|
||||
<section name='Installation of the Fess'>
|
||||
<subsection name='Access to the download page of the Fess'>
|
||||
<p><a class='externalLink' href='http://sourceforge.jp/projects/fess/releases/'>http://sourceforge.jp/projects/Fess/releases/</a> From the download the latest Fess package.</p>
|
||||
<p>Release file list of the destination URL and then 'fess-server-9.x.y.zip'.</p>
|
||||
<section name='Installing Fess'>
|
||||
<subsection name='Go to download page of Fess'>
|
||||
<p><a class='externalLink' href='http://sourceforge.jp/projects/fess/releases/'>http://sourceforge.jp/projects/Fess/releases/</a> Download latest Fess package.</p>
|
||||
<p>Expand file list of the destination URL, then download 'fess-server-9.x.y.zip'.</p>
|
||||
<img src='/images/en/install/Fess-1.png'/>
|
||||
</subsection>
|
||||
<subsection name='Installation'>
|
||||
<p>Unzip the zip file you downloaded. If the Windows environment expand the zip decompression tool, in.</p>
|
||||
<p>Unzip downloaded zip file. In case of Windows environment, we recommend using 7-zip. In case of Unix, we recommend using unzip command.</p>
|
||||
<blockquote>
|
||||
<p> If you installed in the UNIX environment, in the bin added the performing rights to a script.</p>
|
||||
<p> In case of Unix environment, start up script "startup.sh" need to be executable. Execute following command to add executable access permission to script files.</p>
|
||||
<source><![CDATA[
|
||||
$ unzip fess-server-9.x.y.zip
|
||||
$ cd fess-server-9.x.y
|
||||
$ chmod +x bin/*.sh # (Unix環境のみ)
|
||||
$ chmod +x bin/*.sh # (In case of Unix environment)
|
||||
]]></source>
|
||||
</blockquote>
|
||||
<img src='/images/en/install/Fess-2.png'/>
|
||||
<p> Open the unzipped folder by double-clicking. </p>
|
||||
<p> Double-click to open un-zipped folder. </p>
|
||||
<img src='/images/en/install/Fess-3.png'/>
|
||||
<p> Open the bin folder by double-clicking. </p>
|
||||
<p> Double-click to open bin folder. </p>
|
||||
<img src='/images/en/install/Fess-4.png'/>
|
||||
</subsection>
|
||||
<subsection name='Launch of the Fess'>
|
||||
<p>Double-click the startup.bat file in the bin folder, Fess up.</p>
|
||||
<p>In case of Windows environment, double-click the startup.bat file in the bin folder to start Fess.</p>
|
||||
<blockquote>
|
||||
<p>Run the startup.sh for UNIX environments.</p>
|
||||
<p>In case of Unix environments, run startup.sh to start Fess.</p>
|
||||
<source><![CDATA[
|
||||
$ ./bin/startup.sh
|
||||
]]></source>
|
||||
</blockquote>
|
||||
<img src='/images/en/install/Fess-5.png'/>
|
||||
<p> Will start the command prompt appears. In the last sentence "Server startup... ' is Setup complete appears.</p>
|
||||
<p>After starting Fess, at the end of console message "Server startup... ' willbe appeared. If this message is not appeared, check Java environment's validity.</p>
|
||||
<img src='/images/en/install/Fess-6.png'/>
|
||||
</subsection>
|
||||
</section>
|
||||
<section name='Operation check'>
|
||||
<p>access to / http://localhost:8080/Fess ensures startup.</p>
|
||||
<p>Management UI is / http://localhost:8080/fess/admin. Default Administrator account user name / password is admin/admin. Administrator account is managed by the application server. In the management UI of the Fess, authenticate with the application server in fess role determine as an administrator.</p>
|
||||
<p>Go to http://localhost:8080/Fess to check whether Fess started normally.</p>
|
||||
<p>Fess' management UI is located at / http://localhost:8080/fess/admin. Default Administrator account's user name / password is admin/admin. Administrator account is managed by the application server. Administrators of Fess' management UI are users whose rolls are certificated by applicatoion server .</p>
|
||||
</section>
|
||||
<section name='Other'>
|
||||
<subsection name='Stop Fess'>
|
||||
<p>stop the Fess, double-click shutdown.bat file in the bin folder.</p>
|
||||
<p>To stop Fess, in case of Windows environment double-click shutdown.bat file in the bin folder.</p>
|
||||
<blockquote>
|
||||
<p>Run the shutdown.sh for UNIX environments.</p>
|
||||
<p>To stop Fess, in case of Unix environment run the shutdown.sh.</p>
|
||||
<source><![CDATA[
|
||||
$ ./bin/shutdown.sh
|
||||
]]></source>
|
||||
</blockquote>
|
||||
</subsection>
|
||||
<subsection name='Changing the administrator password'>
|
||||
<p>Administrator account is managed by the application server. Fess Server standard available Tomcat, as well as to the user changing the Tomcat. Modify the password for the admin account of the conf/tomcat-user.xml if you want to change.</p>
|
||||
<subsection name='Changing administrator password'>
|
||||
<p>Administrator account is managed by the application server. Fess' standard server is Tomcat. So to change administrator password, you need to modify conf/tomcat-user.xml.</p>
|
||||
<source><![CDATA[
|
||||
<user username="admin" password="admin" roles="fess"/>
|
||||
]]></source>
|
||||
</subsection>
|
||||
<subsection name='SOLR server password change'>
|
||||
<subsection name='Changing SOLR server password'>
|
||||
<p>
|
||||
To access the Solr into Fess server is password becomes necessary.
|
||||
Change the default passwords in production, etc.</p>
|
||||
Password is required to access Solr of Fess.
|
||||
Change the default passwords in production.</p>
|
||||
<p>
|
||||
How to change the password, you must first change the password attribute of the conf/tomcat-user.xml solradmin.
|
||||
To change Solr password, first you must change solradmin password attribute of conf/tomcat-user.xml.
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
<user username="solradmin" password="solradmin" roles="solr"/>
|
||||
]]></source>
|
||||
<p>
|
||||
Modifies the following three files webapps/fess/WEB-INF/classes/solrlib.dicon, fess_suggest.dicon and solr/core1/conf/solrconfig.xml.
|
||||
Write what you specified in tomcat-user.xml to the following password.</p>
|
||||
Modifies the following three files webapps/fess/WEB-INF/classes/solrlib.dicon, fess_suggest.dicon and solr/core1/conf/solrconfig.xml. These there files' user / password are as same as user / password which are specified in tomcat-user.xml.</p>
|
||||
<p>
|
||||
modify the following areas of the solrlib.dicon.
|
||||
In case of solrlib.dicon, detail is as follows.
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
<component class="org.apache.commons.httpclient.UsernamePasswordCredentials">
|
||||
|
|
@ -189,7 +190,7 @@ modify the following areas of the solrlib.dicon.
|
|||
</component>
|
||||
]]></source>
|
||||
<p>
|
||||
fess_suggest.dicon is the following.
|
||||
In case of fess_suggest.dicon, detail is as follows.
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
<component name="suggestCredentials" class="org.apache.http.auth.UsernamePasswordCredentials">
|
||||
|
|
@ -198,7 +199,7 @@ fess_suggest.dicon is the following.
|
|||
</component>
|
||||
]]></source>
|
||||
<p>
|
||||
SOLR/core1/conf/solrconfig.XML is the following.
|
||||
In case of SOLR/core1/conf/solrconfig.XML, detail is as follows.
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
<!-- SuggestTranslogUpdateHandler settings -->
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue