Difference between revisions of "API:bin/generate apacheconf"
| Line 8: | Line 8: | ||
'''generate_apacheconf''' - Create the apache config files needed for EPrints | '''generate_apacheconf''' - Create the apache config files needed for EPrints | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_synopsis --> | <!-- Pod2Wiki=head_synopsis --> | ||
==SYNOPSIS== | ==SYNOPSIS== | ||
| Line 21: | Line 18: | ||
'''generate_apacheconf''' --replace [repoid] | '''generate_apacheconf''' --replace [repoid] | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_description --> | <!-- Pod2Wiki=head_description --> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
| Line 34: | Line 28: | ||
If you have changed a repository's configuration (hostname/port/path) you can update the configuration for that repository with: | If you have changed a repository's configuration (hostname/port/path) you can update the configuration for that repository with: | ||
| − | + | <pre> generate_apacheconf --replace [repoid]</pre> | |
| − | + | ||
| − | < | ||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_adding_to_apache_configuration --> | <!-- Pod2Wiki=head_adding_to_apache_configuration --> | ||
===Adding to Apache Configuration=== | ===Adding to Apache Configuration=== | ||
To enable EPrints you must add the following line to your main Apache configuration file (<em>/etc/httpd/conf/httpd.conf</em>): | To enable EPrints you must add the following line to your main Apache configuration file (<em>/etc/httpd/conf/httpd.conf</em>): | ||
| − | + | <pre> Include /opt/eprints3/cfg/apache.conf</pre> | |
| − | + | ||
To enable secure (HTTPS) you must add the following line to your SSL VirtualHost: | To enable secure (HTTPS) you must add the following line to your SSL VirtualHost: | ||
| − | + | <pre> Include /opt/eprints3/cfg/apache_ssl.conf</pre> | |
| − | + | ||
| − | < | ||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_arguments --> | <!-- Pod2Wiki=head_arguments --> | ||
==ARGUMENTS== | ==ARGUMENTS== | ||
| − | + | * repository_id | |
| − | + | : Optionally update the given repository's apache configuration only. Will only replace an existing configuration file with the --replace option. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_options --> | <!-- Pod2Wiki=head_options --> | ||
==OPTIONS== | ==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. | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<!-- Pod2Wiki=head_files --> | <!-- Pod2Wiki=head_files --> | ||
==FILES== | ==FILES== | ||
| − | + | * '''EPRINTS/cfg/apache.conf''' | |
| − | + | : Loads the EPrints environment and repository-specific configuration files. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Loads the EPrints environment and repository-specific configuration files. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Loads the repository-specific SSL 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. | |
| − | |||
| − | |||
| − | + | <pre></pre> | |
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | + | <!-- Pod2Wiki=head_copyright --> | |
| − | <!-- Pod2Wiki= | + | ==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/. | |
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | + | <!-- Pod2Wiki=_postamble_ --> | |
| − | <!-- Pod2Wiki= | ||
| − | |||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 09:57, 22 January 2013
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
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/.
