...
On this page:
Table of Contents |
---|
Prerequisites
Download Fedora 3.45.20
- Fedora 3.4.2 5 Installer (110M112M)
- Fedora 3.4.2 5 Source Code (14M7.1M) (if installing from source, see Installation From Source for instructions on building the installer)
- See also the Downloads page.
Java SE Development Kit (JDK) 6.
Whether installing a binary or source distribution, JDK 6 is required. The JDK should be installed on the machine you intend to use as the Fedora server. It is available from http://www.java.sun.com/com/. While historically we have recommended Sun/Oracle's JDK, there have been several reports of success in using OpenJDK as well. Look here for more information on installing Java.
...
Application Server
The Fedora Repository installer includes Tomcat 6.0.2029. Optionally, Fedora may be installed into any existing application server that implements Servlet 2.5/JSP 2.1 or higher. At this time, Fedora has chiefly been tested with Tomcat 56.0.x and Tomcat 67.0.x, but users have reported running Fedora successfully with Jetty and JBoss.
Maven 2
Fedora uses Maven for its build environment. Maven2 is available from http://maven.apache.org/.
Installation Steps
Prepare Environment Variables
The following environment variables must be correctly defined:may need to be set while installing or running Fedora, or executing Fedora command line utilities.
JAVA_HOME
Optional.
If set, tomcat and fedora command line utilities will use the specified java vm. Otherwise, all utilities will attempt to use the java version available by default within the user's PATH. This should point to the base directory of your Java installation. On Windows systems, this might be C:\java
. For UNIX derivatives, this might be something like /usr/local/jdk1.6.0_17
.
FEDORA_HOME
Required for running command line utilities. Optional for running installer. Ignored when running the Fedora server unless fedora home directory is not otherwise specified.
This is This is the directory where Fedora will be installed, for example, C:\fedora
(Windows) or /usr/local/fedora
(UNIX derivatives). Note: This is only required when running the Fedora client command line utilities. The server also requires this information at run time, but can accept it from the following sources (listed in order of preference):
- The
fedora.home
init context-param in configured provided by the Fedora webapp's web.xml file (Fedora 3.2+ only). The installer will automatically include the correct path in your web.xml at installation time, so if you move your Fedora Home directory later, you will need to also modify this file and restart the webapp container.webapp container (preferred). Most webapp containers provide some means for providing context params to individual web applications at startup. This configuration is separate from the deployed webapp. The installer will automatically provide this configuration when installing to a Tomcat container in$CATALINA_HOME/conf/Catalina/localhost/<webapp_name>.xml
(typicallyfedora.xml
). - The fedora.The fedora.home system property, configured as appropriate for your web application server of choice.
- The FEDORA_HOME environment variable, as available when the web application server starts.
...
JAVA_OPTS
If Fedora is configured to use SSL, JAVA_OPTS
must include the javax.net.ssl.trustStore
and javax.net.ssl.trustStorePassword
properties. See the SSL section below for more information.
CATALINA_HOME
If Fedora is configured to use Tomcat, CATALINA_HOME
must be set before starting Fedora. If using the quick install option, CATALINA_HOME
should be set to $FEDORA_HOME/tomcat
(or %FEDORA_HOME%\tomcat
in Windows). Required for command line applications.
Command line applications currently load libraries from the exploded web application in $CATALINA_HOME/webapps/$webapp_name/WEB-INF
DISPLAY (Unix-only)
When running a Fedora server in a Unix-like operating system (Linux, Solaris, OS X, etc), you should ensure that this environment variable is NOT set by the user who will be running the application server in which Fedora is installed (e.g. Tomcat). Background: Fedora and the included web applications are designed to run without access to a graphics output device. Although rare, having this environment variable set has been reported to cause stability problems in certain installations of Fedora. Since a graphic output device should never be needed by the Fedora server, it is safest to ensure this environment variable is not set.
Prepare Database
Fedora is designed to be RDBMS-independent. Fedora has been tested with Derby, McKoi, MySQL, Oracle, PostgreSQL and Microsoft SQL Server. The embedded version of Derby included with the installer is provided as a convenience; Derby is not recommended for use in production repositories. If you choose to use any database other than the embedded Derby provided by the Fedora Installer, you must install that database first.
Follow the instructions below for the RDBMS of your choice in order to create the user and tables required by Fedora.
MySQL
Please note that the MySQL JDBC driver provided by the installer requires MySQL v3.23.x or higher.
...
No Format |
---|
GRANT ALL ON fedora3.\* TO fedoraAdmin@localhost IDENTIFIED BY 'fedoraAdmin'; GRANT ALL ON fedora3.\* TO fedoraAdmin@'%' IDENTIFIED BY 'fedoraAdmin'; |
...
No Format |
---|
ALTER DATABASE fedora3 DEFAULT CHARACTER SET utf8; ALTER DATABASE fedora3 DEFAULT COLLATE utf8_bin; |
Oracle
To prepare Oracle for use with Fedora, the following steps should be taken by an administrative user. First, using the Database Configuration Assistant, ensure that the database you'll be using is created with the UTF8 charset. Next, you'll need to create a Fedora tablespace and user in the database. Assuming the administrative user is sys and the SID is fedora3, log in using SQL*Plus using the following command:
...
Info |
---|
Due to distribution license restrictions, the Fedora Installer does not include the Oracle JDBC driver. Oracle JDBC drivers are available from http://technet.oracle.com/software/tech/java/sqlj_jdbc/content.html. The installer will prompt you for the location of the driver on your filesystem. Also, if you run Fedora in Java 6 as is required by Fedora 3.4, you will need an Oracle Java 6 jdbc jar such as |
PostgreSQL
Please consult the documentation at http://www.postgresql.org/docs/ for more detailed information about configuring PostgreSQL.
...
No Format |
---|
CREATE ROLE "fedoraAdmin" LOGIN PASSWORD 'fedoraAdmin'; CREATE DATABASE "fedora3" WITH ENCODING='UTF8' OWNER="fedoraAdmin"; |
Microsoft SQL Server
David Handy has contributed a guide for interfacing Fedora with MS SQL Server
Other Databases
To use a database other than Derby, McKoi, MySQL, Oracle, PostgreSQL and Microsoft SQL Server, the database must support common SQL-92 syntax and you must have a JDBC version 3 driver available.
The JDBC driver will need to be installed manually. For most containers, the driver may be placed in the Fedora webapp's WEB-INF/lib
directory. For Tomcat 56.0.x and 7.0.x, however, the driver should be installed to TOMCAT_HOME/common/lib
. The JDBC URL will need to be configured appropriately in the Fedora Server Configuration File.
...
- Create the tables and indexes and auto-increments yourself in your own database (see the file:
src/dbspec/server/fedora/server/storage/resources/DefaultDOManager.dbspec
in the source distribution for the RDBMS-neutral table specifications). - Write a subclass of
fedora.server.utilities.DDLConverter
for your database software, include it in the FedoraWEB-INF/classes
directory or in a jar file in the FedoraWEB-INF/lib
directory, and associate it with the JDBC driver inside theFEDORA_HOME/server/config/fedora.fcfg
file (see how it's done by looking at the MySQLDDLConverter and DerbyDDLConverter associations with their respective drivers in thefedora.fcfg
file, and the classes' implementations in the source distribution). If you choose option #2, please tell us about it, as it will be useful for other users of Fedora. Option 2 is harder, but it will make future installations of new versions of Fedora (where the db schema will likely change) much easier for you if you plan on using that database later.
Run Installer
The Fedora Installer provides three installation options: quick, custom, and client.
...
Tip |
---|
Fedora can also be installed in non-interactive mode by specifying an install.properties file as an argument to the installer. After installing interactively, you will find an install.properties file in your $FEDORA_HOME/install/ directory. You can use this file as a template for future, non-interactive installations. *Take care if you are using an install.properties file from an earlier release as the file may not contain some properties defined in the later release, default settings will be used in this case, which may or may not be appropriate for your installation. |
Note |
---|
Please ensure that the user account that is running the installer has sufficient permissions to write to the directories where Fedora will be installed (if deploying to an existing Tomcat installation, this includes permissions to the Tomcat directory). Installer created files will usually be owned by the user running the installer. Consequently, for example, after installation users of the Fedora Admin client will need write permissions to the log files defined by |
Quick Install
The quick option is designed to get Fedora up and running as quickly as possible, with a minimum of advanced options. The quick install will automatically install Tomcat pre-loaded with the Fedora Repository and the Derby database. Neither SSL support nor XACML policy enforcement is enabled by the quick install.
Custom Install
The custom option provides the most flexibility in configuring an installation. Options include the choice of servlet container, database, the host, ports and application server context Fedora will be running on, enabling optional services, as well as security options including SSL, XACML policy enforcement, and FeSL.
...
The installer will automatically configure and deploy to Tomcat 56.0.x, 5.5.x , and 67.0.x servlet containers. However, if an existing Tomcat installation (as opposed to the Tomcat bundled with the installer) was selected, the installer will not overwrite your existing server.xml
, but rather, place a modified copy at FEDORA_HOME/install
so that you may review it before before installing it yourself.
...
Application Server Context
The installer provides the option to enter an application server context name under which Fedora will be deployed. The context name defaults to Fedora (resulting in http\[s\]://host:port/fedora), however any other valid context name can be supplied. The installer will name the resulting _war_ file according to the supplied context name (defaults to {{ Wiki Markup fedora.war
}}). Please ensure that the servlet container configuration reflects the name of the Fedora context name in case it needs to be configured explicitly. For further details see [Alternative Webapp Context Configuration|https://fedora-commons.org/confluence/display/FCR30/Alternative+Webapp+Context+Configuration].
SSL
Configuring SSL support for Fedora's API-M interface is an optional feature. It strongly recommended for production environments if Fedora is exposed to unsecured application and users. However, if your installation is within a managed data center with firewall services, you may choose to provide SSL using a software or hardware front-end instead. For example, a reverse proxy implemented using the Apache HTTP Server and hiding Fedora generally provides better SSL performance.
...
Messaging
If Messaging is enabled, Fedora will create and send a message via JMS whenever an API-M method is called.
Client Install
Both the quick and custom options will install the Fedora client software in addition to the Fedora server. The client option, however, will install only the Fedora client software.
Start Fedora
If you selected the quick install option, you will find Tomcat installed in FEDORA_HOME/tomcat
. To run Fedora, start Tomcat by entering:
...
If you selected the custom install option, ensure that your database server is running (unless you selected the included Derby option which will be automatically started when the first database connection is made).
Installing the Demo Objects
If you just started Fedora for the first time, it's a good idea to check out the demonstration objects to get an idea of how Fedora works. See the Demonstration documentation for complete descriptions.
NOTE: If, during a custom install, you entered values other than the defaults for fedoraServerHost (localhost) or fedoraServerPort (8080), you must run the demo object converter utility script to change the host and/or port in the demonstration object ingest files. The demonstration object conversion is only required if you are ingesting demonstration objects. If the demonstration objects are already ingested into the repository (e.g. from a previous installation), there is no need for conversion. The demonstration objects are shipped with references to "localhost:8080" and these references must reflect the new values of fedoraServerHost fedoraServerPort. Refer to the Command-line Utilities documentation for additional details on running the demo object converter.
...
For additional information on the fedora-ingest-demos command, see the documentation for the Client Command-line Utilities. Please note that the demonstration objects must be ingested before they can be discovered using the default search interface.
Additional Configuration
fedora.fcfg
The Fedora Server's configuration is chiefly has historically been governed by the Fedora Server Configuration File, fedora.fcfg
, located at FEDORA_HOME/server/config/fedora.fcfg
. This means of configuration is slowly being replaced with spring bean configuration
The Fedora server configuration file contains:
...
There are many other parameters you can configure with Fedora. Refer to the Fedora Server Configuration File itself (fedora.fcfg
) for internal documentation on all the parameters.
Spring configuration
For more details, see the full Spring Configuration page.
Fedora configuration via spring is eventually planned to replace the existing fedora.fcfg
configuration, as well as eliminate the need for custom configuration if web.xml
within the fedora server war file.
Ar present, spring bean and property definitions can be found in:
server/config/spring
- used to define configuration for fedora server modules
server/config/spring/web
- contains configuration for servlet filters on fedora's web interfaces, most notably related to Spring Security
Logging
Fedora uses the Simple Logging Facade for Java (SLF4J) framework for logging with Logback as the actual logging implementation. For detailed information about using SLF4J, consult the SLF4J Manual: http://www.slf4j.org/manual.html, and for information about using Logback consult the Logback manual: http://logback.qos.ch/manual/index.html.
...