API:bin/generate apacheconf

From EPrints Documentation
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

generate_apacheconf - Create the apache config files needed for EPrints


SYNOPSIS

generate_apacheconf [options] [repository_id]

generate_apacheconf --replace [repoid]


DESCRIPTION

This script generates the config files to include in your Apache configuration.

If you have changed a repository's configuration (hostname/port/path) you can update the configuration for that repository with:

 generate_apacheconf --replace [repoid]


Adding to Apache Configuration

To enable EPrints you must add the following line to your main Apache configuration file (/etc/httpd/conf/httpd.conf):

 Include /opt/eprints3/cfg/apache.conf

To enable secure (HTTPS) you must add the following line to your SSL VirtualHost:

 Include /opt/eprints3/cfg/apache_ssl.conf


ARGUMENTS

  • repository_id
Optionally update the given repository's apache configuration only. Will only replace an existing configuration file with the --replace option.


OPTIONS

  • --replace
Replace existing configuration files, overwriting any changes made.
  • --system
Update the system configuration file, overwriting any changes made.
  • --help
Print a brief help message and exit.
  • --man
Print the full manual page and then exit.
  • --quiet
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
  • --verbose
Explain in detail what is going on. May be repeated for greater effect.
  • --version
Output version information and exit.


FILES

  • EPRINTS/cfg/apache.conf
Loads the EPrints environment and repository-specific configuration files.
  • EPRINTS/cfg/apache_ssl.conf
Loads the repository-specific SSL configuration files.
  • EPRINTS/cfg/apache/[repoid].conf
A <VirtualHost> that responds to the configured hostname and port of the repository.
  • EPRINTS/cfg/apache_ssl/[repoid].conf
A <Location> that responds to the configured https_root of the repository.
  • EPRINTS/archives/[repoid]/cfg.d/10_base.pl
Default location for host and path directives used to build the Apache configuration files.


COPYRIGHT

Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.