https://wiki.eprints.org/w/api.php?action=feedcontributions&feedformat=atom&user=TmbEPrints Documentation - User contributions [en-gb]2026-04-21T12:24:07ZUser contributionsMediaWiki 1.31.8https://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10932Import From ORCID2014-03-14T11:08:14Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Concept ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID, using the ORCID Tier 1 (public) API.<br />
<br />
== For Developers: Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== For Administrators: Testing the Concept ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10931Import From ORCID2014-03-14T11:07:43Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID, using the ORCID Tier 1 (public) API.<br />
<br />
== For Developers: Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== For Administrators: Testing the Concept ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10930Import From ORCID2014-03-14T11:07:19Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID.<br />
<br />
== For Developers: Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== For Administrators: Testing the Concept ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10929Import From ORCID2014-03-14T11:06:27Z<p>Tmb: /* User Guide */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 (public) API.<br />
<br />
== For Developers: Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== For Administrators: Testing the Concept ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10928Import From ORCID2014-03-14T11:06:09Z<p>Tmb: /* Technical Details */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 (public) API.<br />
<br />
== For Developers: Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10927Import From ORCID2014-03-14T11:05:45Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that demonstrates how publications could be imported into EPrints for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 (public) API.<br />
<br />
== Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10926Import From ORCID2014-03-14T10:54:11Z<p>Tmb: /* Technical Details */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that allows you to import publications for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 (public) API.<br />
<br />
== Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the ORCID Tier 1 API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10925Import From ORCID2014-03-14T10:53:58Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a simple plugin for EPrints that allows you to import publications for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 (public) API.<br />
<br />
== Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the orcid.com Tier 1 (public) API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10924Import From ORCID2014-03-14T10:46:22Z<p>Tmb: /* User Guide */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a plugin for EPrints that allows you to import publications for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 API.<br />
<br />
== Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the orcid.com Tier 1 (public) API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an author's ORCID to search for their published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results retrieved and listed with import options where available.<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the default EPrints import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10923Import From ORCID2014-03-14T10:44:55Z<p>Tmb: /* Technical Details */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a plugin for EPrints that allows you to import publications for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 API.<br />
<br />
== Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the orcid.com Tier 1 (public) API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BIBTEX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PMID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an ORCID to search for published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results are listed with import options where available (import from DOI or import from PubMed ID).<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the standard Import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10922Import From ORCID2014-03-14T10:43:55Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a plugin for EPrints that allows you to import publications for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 API.<br />
<br />
== Technical Details ==<br />
<br />
Given an author's ORCID, the plugin queries the orcid.com Tier 1 (public) API and retrieves a list of works published by that author in JSON format.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BibTeX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PubMed ID) elements - where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an ORCID to search for published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results are listed with import options where available (import from DOI or import from PubMed ID).<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the standard Import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10921Import From ORCID2014-03-14T10:41:13Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a plugin for EPrints that allows you to import publications for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 API.<br />
<br />
Given an author's ORCID, the plugin queries the Tier 1 API and retrieves a list of works published by that author.<br />
<br />
The metadata describing each work may include ''work-citation-format'' (for example, BibTeX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PubMed ID). Where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an ORCID to search for published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results are listed with import options where available (import from DOI or import from PubMed ID).<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the standard Import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10920Import From ORCID2014-03-14T10:40:38Z<p>Tmb: /* Overview */</p>
<hr />
<div>== Overview ==<br />
<br />
'''Import from ORCID''' is a plugin for EPrints that allows you to import publications for a given author identified by an ORCID.<br />
<br />
The plugin demonstrates how an EPrints repository can interface with the ORCID Tier 1 API.<br />
<br />
Given an author's ORCID, the plugin queries the Tier 1 API and retrieves a list of works published by that author.<br />
<br />
The metadata describing each work may include a ''work-citation-format'' (for example, BibTeX) and/or multiple ''work-external-identifier-type'' (for example, DOI, PubMed ID). Where the ''work-citation-format'' or ''work-external-identifier-type'' can be mapped to an EPrints import plugin an Import option is displayed next to the work.<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an ORCID to search for published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results are listed with import options where available (import from DOI or import from PubMed ID).<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the standard Import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10919Import From ORCID2014-03-14T10:31:15Z<p>Tmb: /* User Guide */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|none]]<br />
<br />
2. Enter an ORCID to search for published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|none]]<br />
<br />
3. Search results are listed with import options where available (import from DOI or import from PubMed ID).<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|none]]<br />
<br />
4. Clicking Import takes you to the standard Import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|none]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|none]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10918Import From ORCID2014-03-14T10:28:26Z<p>Tmb: /* User Guide */</p>
<hr />
<div>== Overview ==<br />
<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen.<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|left]]<br />
<br />
2. Enter an ORCID to search for published works.<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|left]]<br />
<br />
3. Search results are listed with import options where available (import from DOI or import from PubMed ID).<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|left]]<br />
<br />
4. Clicking Import takes you to the standard Import screen.<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|left]]<br />
<br />
5. After importing the item, you are taken to the deposit workflow where you can edit and deposit the item.<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|left]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10917Import From ORCID2014-03-14T10:26:14Z<p>Tmb: </p>
<hr />
<div>== Overview ==<br />
<br />
<br />
== User Guide ==<br />
<br />
1. After installing, an ORCID button appears on the Admin screen<br />
<br />
[[File:import_from_orcid_admin.png|400px|thumb|left]]<br />
<br />
<br><br />
<br />
2. Enter an ORCID to search for published works<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|left]]<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|left|3. Search results showing import options (import from DOI or import from PubMed ID)]]<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|left|4. Clicking Import takes you to the standard Import screen]]<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|left|5. After importing the item]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10916Import From ORCID2014-03-14T10:24:54Z<p>Tmb: </p>
<hr />
<div>[[File:import_from_orcid_admin.png|400px|thumb|left|1. After installing, an ORCID button appears on the Admin screen]]<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|left|2. Enter an ORCID to search for published works]]<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|left|3. Search results showing import options (import from DOI or import from PubMed ID)]]<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|left|4. Clicking Import takes you to the standard Import screen]]<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|left|5. After importing the item]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=File:Import_from_orcid_edit_item.png&diff=10915File:Import from orcid edit item.png2014-03-14T10:22:52Z<p>Tmb: </p>
<hr />
<div></div>Tmbhttps://wiki.eprints.org/w/index.php?title=File:Import_from_orcid_import.png&diff=10914File:Import from orcid import.png2014-03-14T10:22:36Z<p>Tmb: </p>
<hr />
<div></div>Tmbhttps://wiki.eprints.org/w/index.php?title=File:Import_from_orcid_search_results.png&diff=10913File:Import from orcid search results.png2014-03-14T10:22:21Z<p>Tmb: </p>
<hr />
<div></div>Tmbhttps://wiki.eprints.org/w/index.php?title=File:Import_from_orcid_enter_orcid.png&diff=10912File:Import from orcid enter orcid.png2014-03-14T10:22:05Z<p>Tmb: </p>
<hr />
<div></div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10911Import From ORCID2014-03-14T10:21:53Z<p>Tmb: </p>
<hr />
<div>[[File:import_from_orcid_admin.png|400px|thumb|left|After installing, an ORCID button appears on the Admin screen]]<br />
<br />
[[File:import_from_orcid_enter_orcid.png|400px|thumb|left|]]<br />
<br />
[[File:import_from_orcid_search_results.png|400px|thumb|left|]]<br />
<br />
[[File:import_from_orcid_import.png|400px|thumb|left|]]<br />
<br />
[[File:import_from_orcid_edit_item.png|400px|thumb|left|]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10910Import From ORCID2014-03-14T10:20:58Z<p>Tmb: </p>
<hr />
<div>[[File:import_from_orcid_admin.png|400px|thumb|left|After installing, an ORCID button appears on the Admin screen]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10909Import From ORCID2014-03-14T10:20:47Z<p>Tmb: </p>
<hr />
<div>[[File:import_from_orcid_admin.png|400px|thumb|right|After installing, an ORCID button appears on the Admin screen]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10908Import From ORCID2014-03-14T10:20:21Z<p>Tmb: </p>
<hr />
<div>[[Image:import_from_orcid_admin.png|thumb|frame|right|||An example MePrints User Profile||This image shows an example MePrints User Profile.]]<br />
<br />
[[File:import_from_orcid_admin.png|300px|thumb|right|ORCID button appears on Admin screen]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10907Import From ORCID2014-03-14T10:19:31Z<p>Tmb: </p>
<hr />
<div>[[Image:import_from_orcid_admin.png|thumb|frame|right|||An example MePrints User Profile||This image shows an example MePrints User Profile.]]<br />
<br />
[[File:File.png|200px|thumb|left|alt text]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=File:Import_from_orcid_admin.png&diff=10906File:Import from orcid admin.png2014-03-14T10:18:05Z<p>Tmb: </p>
<hr />
<div></div>Tmbhttps://wiki.eprints.org/w/index.php?title=Import_From_ORCID&diff=10905Import From ORCID2014-03-14T10:17:41Z<p>Tmb: Created page with ' This image shows an example MePrints User Profile.'</p>
<hr />
<div><br />
[[Image:import_from_orcid_admin.png|frame|right|||An example MePrints User Profile||This image shows an example MePrints User Profile.]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10810ApacheConfigMigration2013-07-18T09:14:33Z<p>Tmb: /* Apache Configuration in 3.1 */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
└── auto-secure.conf<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview (3.1)===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache (3.1)===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
''Note if EPrints is installed from RPM, check /etc/httpd/conf.d/eprints.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.2+==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview (3.2+)===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache (3.2+)===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
''Note if EPrints is installed from RPM, check /etc/httpd/conf.d/eprints.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10809ApacheConfigMigration2013-07-18T08:57:54Z<p>Tmb: </p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview (3.1)===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache (3.1)===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
''Note if EPrints is installed from RPM, check /etc/httpd/conf.d/eprints.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.2+==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview (3.2+)===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache (3.2+)===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
''Note if EPrints is installed from RPM, check /etc/httpd/conf.d/eprints.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10808ApacheConfigMigration2013-07-18T08:57:10Z<p>Tmb: /* Loading into Apache */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
''Note if EPrints is installed from RPM, check /etc/httpd/conf.d/eprints.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.2+==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
''Note if EPrints is installed from RPM, check /etc/httpd/conf.d/eprints.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10807ApacheConfigMigration2013-07-18T08:56:27Z<p>Tmb: /* Loading into Apache */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.2+==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
''Note if EPrints is installed from RPM, check /etc/httpd/conf.d/eprints.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Upgrading_from_3.1&diff=10806Upgrading from 3.12013-07-18T08:50:38Z<p>Tmb: </p>
<hr />
<div>One of the core parts of upgrading from 3.1 is converting all database tables and data to the utf8 charset (previous version of EPrints used latin1). There are a couple of pitfalls in this process - the following tips are from the EPrints Services team, after carrying out many upgrades to 3.2. Please note that you follow this advice at your own risk.<br />
<br />
==Avoiding subject__index_grep key length error==<br />
<br />
When converting subject__index_grep and subject__rindex to utf8, ''bin/epadmin upgrade'' will generate an error:<br />
<br />
DBD::mysql::db do failed: Specified key was too long; max key length is 1000 bytes at /opt/eprints3/perl_lib/EPrints/Database.pm line 3213, <STDIN> line 1.<br />
<br />
To avoid this error clear the tables before running ''bin/epadmin upgrade'':<br />
<br />
delete from subject__index_grep<br />
delete from subject__rindex<br />
<br />
Then reindex when ''bin/epadmin upgrade'' has completed:<br />
<br />
bin/epadmin reindex ARCHIVEID subject<br />
<br />
==Minimising downtime==<br />
<br />
Whilst ''bin/epadmin upgrade'' is running, your repository will be offline.<br />
<br />
If you have a LARGE repository the conversion to utf8 can take a LONG time (12+ hours). However some of the tables are volatile (ie. the data can be generated) so you can reduce downtime by clearing these tables beforehand, and then regenerating the content afterwards (whilst your repository is back online).<br />
<br />
You only really need to consider this if your eprint__rindex table contains MILLIONS of rows.<br />
<br />
Clear these tables before running ''bin/epadmin upgrade'':<br />
<br />
DELETE FROM eprint__rindex;<br />
<br />
After running ''bin/epadmin upgrade'' and getting your repository back online:<br />
<br />
bin/epadmin reindex ARCHIVEID eprint<br />
<br />
Note that your search won't be at full capacity until the indexes are fully regenerated, but we have found that getting the repository back online ASAP is more desirable so worth the trade off.<br />
<br />
==Post-upgrade: Migrating Apache Configuration==<br />
<br />
See [[ApacheConfigMigration]]</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10805ApacheConfigMigration2013-07-18T08:42:19Z<p>Tmb: /* Loading into Apache */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.2+==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
''Note: this assumes a single SSL repository or multiple SSL repositories sharing the same <tt>securehost</tt> - for multiple repositories with different <tt>securehost</tt> settings each reposity-specific SSL configuration file may need to be loaded in a separate VirtualHost.<br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10804ApacheConfigMigration2013-07-18T08:40:00Z<p>Tmb: /* Apache Configuration in 3.1 */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.2+==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10803ApacheConfigMigration2013-07-18T08:39:04Z<p>Tmb: /* Loading into Apache */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10802ApacheConfigMigration2013-07-18T08:38:55Z<p>Tmb: /* Loading into Apache */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
===Loading into Apache===<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10801ApacheConfigMigration2013-07-18T08:38:07Z<p>Tmb: /* Migrating apache configuration from 3.1 to 3.2+ */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10800ApacheConfigMigration2013-07-18T08:37:04Z<p>Tmb: /* Migrating apache configuration from 3.1 to 3.2+ */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular <tt>cfg/apache.conf</tt>, <tt>archives/<ARCHIVEID>/cfg/apache.conf</tt> and <tt>archives/<ARCHIVEID>/cfg/apachevhost.conf</tt><br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load <tt>/opt/eprints3/cfg/apache_ssl.conf</tt> instead of <tt>/opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf</tt><br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
<br />
var/auto-apache.conf<br />
var/auto-apache-includes.conf<br />
archives/<ARCHIVEID>/cfg/apache.conf<br />
archives/<ARCHIVEID>/var/auto-apache.conf<br />
archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10799ApacheConfigMigration2013-07-18T08:34:58Z<p>Tmb: /* Migrating apache configuration from 3.1 to 3.2+ */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular cfg/apache.conf, archives/<ARCHIVEID>/cfg/apache.conf and archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load /opt/eprints3/cfg/apache_ssl.conf instead of /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
## var/auto-apache.conf<br />
## var/auto-apache-includes.conf<br />
## archives/<ARCHIVEID>/cfg/apache.conf<br />
## archives/<ARCHIVEID>/var/auto-apache.conf<br />
## archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10798ApacheConfigMigration2013-07-18T08:34:38Z<p>Tmb: /* Migrating apache configuration from 3.1 to 3.2+ */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular cfg/apache.conf, archives/<ARCHIVEID>/cfg/apache.conf and archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load /opt/eprints3/cfg/apache_ssl.conf instead of /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
* var/auto-apache.conf<br />
* var/auto-apache-includes.conf<br />
* archives/<ARCHIVEID>/cfg/apache.conf<br />
* archives/<ARCHIVEID>/var/auto-apache.conf<br />
* archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10797ApacheConfigMigration2013-07-18T08:34:26Z<p>Tmb: /* Migrating apache configuration from 3.1 to 3.2+ */</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular cfg/apache.conf, archives/<ARCHIVEID>/cfg/apache.conf and archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load /opt/eprints3/cfg/apache_ssl.conf instead of /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
** var/auto-apache.conf<br />
** var/auto-apache-includes.conf<br />
** archives/<ARCHIVEID>/cfg/apache.conf<br />
** archives/<ARCHIVEID>/var/auto-apache.conf<br />
** archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=ApacheConfigMigration&diff=10796ApacheConfigMigration2013-07-18T08:34:04Z<p>Tmb: Created page with '=Apache Configuration= The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the…'</p>
<hr />
<div>=Apache Configuration=<br />
<br />
The EPrints apache configuration is distributed across a number of files. This layout changed between EPrints version 3.1 and 3.2 - this page explains the differences and advises how to migrate to the new layout after upgrading from 3.1 to 3.2+.<br />
<br />
==Apache Configuration in 3.1==<br />
<br />
cfg/<br />
└── apache.conf<br />
var/<br />
├── auto-apache.conf<br />
└── auto-apache-includes.conf<br />
archives/<br />
└── <ARCHIVEID><br />
├── cfg<br />
│ ├── apache.conf<br />
│ └── apachevhost.conf<br />
└── var<br />
├── auto-apache.conf<br />
├── auto-secure.conf<br />
└── entities.dtd<br />
<br />
''Note auto-secure.conf will only be present if using SSL<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Loads files from var/<br />
<br />
'''var/auto-apache-includes.conf<br />
<br />
* Loads HTTP configuration for each repository: archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
'''var/auto-apache.conf<br />
<br />
* Global HTTP configuration<br />
<br />
'''archives/<ARCHIVEID>/cfg/apache.conf<br />
<br />
* Loads archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
'''archives/<ARCHIVEID>/var/auto-apache.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
'''archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
<br />
* Empty - add custom directives here<br />
<br />
'''archives/<ARCHIVEID>/var/auto-secure.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the repository-specific EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
</VirtualHost><br />
<br />
==Apache Configuration in 3.1==<br />
<br />
From 3.2 onwards things were simplified - there are fewer configuration files in a single location. The configuration files are shorter as much of the processing was moved into the EPrints::Apache::Rewrite module.<br />
<br />
cfg/<br />
├── apache.conf<br />
├── apache<br />
│ └── <ARCHIVEID>.conf<br />
├── apache_ssl.conf<br />
└── apache_ssl<br />
└── <ARCHIVEID>.conf<br />
<br />
'''Note apache_ssl* files will only be present if using SSL.<br />
<br />
===File Overview===<br />
<br />
'''cfg/apache.conf<br />
<br />
* Global configuration<br />
* Loads HTTP configuration for each repository: cfg/apache/*.conf<br />
<br />
'''cfg/apache/<ARCHIVEID>.conf<br />
<br />
* VirtualHost for repository<br />
* Loads archives/<ARCHIVEID>/cfg/apachevhost.conf if present<br />
<br />
'''cfg/apache_ssl.conf<br />
<br />
* Global SSL configuration<br />
* Loads SSL configuration for each repository: cfg/apache_ssl/*.conf<br />
<br />
'''cfg/apache_ssl/<ARCHIVEID>.conf<br />
<br />
* Repository-specific SSL configuration (note no VirtualHost)<br />
<br />
==Loading into Apache==<br />
<br />
'''Example 1 - Debian/Ubuntu<br />
<br />
HTTP - create a new "site" which loads the top level EPrints apache configuration file:<br />
<br />
$ cat /etc/apache2/sites-available/eprints3<br />
Include /opt/eprints3/cfg/apache.conf<br />
$ a2ensite eprints3<br />
<br />
SSL - load the top level EPrints apache configuration file from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/apache2/sites-available/default-ssl<br />
<IfModule mod_ssl.c><br />
<VirtualHost _default_:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
</IfModule><br />
$ a2ensite default-ssl<br />
<br />
'''Example 2 - RedHat/CentOS<br />
<br />
HTTP - load top level EPrints apache configuration file:<br />
<br />
$ tail /etc/httpd/conf/httpd.conf<br />
...<br />
Include /opt/eprints3/cfg/apache.conf<br />
<br />
SSL - load the repository-specific SSL configuration from inside an SSL VirtualHost:<br />
<br />
$ cat /etc/httpd/conf.d/ssl.conf<br />
...<br />
<VirtualHost _default:443><br />
...<br />
Include /opt/eprints3/cfg/apache_ssl.conf<br />
</VirtualHost><br />
<br />
==Migrating apache configuration from 3.1 to 3.2+==<br />
<br />
This won't happen automatically when you upgrade from 3.1 to 3.2+ so follow the steps below to migrate the apache configuration after upgrading:<br />
<br />
# Back up the 3.1 apache configuration files<br />
# Check for any custom directives added to 3.1 apache config files, in particular cfg/apache.conf, archives/<ARCHIVEID>/cfg/apache.conf and archives/<ARCHIVEID>/cfg/apachevhost.conf<br />
# Run <tt>bin/generate_apacheconf --system --replace</tt> - this will generate the new apache configuration files as above<br />
# If using SSL change the top level apache SSL configuration file to load /opt/eprints3/cfg/apache_ssl.conf instead of /opt/eprints3/archives/<ARCHIVEID>/var/auto-secure.conf<br />
# Merge custom directives back in as appropriate (noting that custom directives may be lost if generate_apacheconf is run with the --system or --replace option)<br />
# Restart apache<br />
# After successful testing, the following 3.1 configuration files can be removed:<br />
## var/auto-apache.conf<br />
## var/auto-apache-includes.conf<br />
## archives/<ARCHIVEID>/cfg/apache.conf<br />
## archives/<ARCHIVEID>/var/auto-apache.conf<br />
## archives/<ARCHIVEID>/var/auto-secure.conf</div>Tmbhttps://wiki.eprints.org/w/index.php?title=API:EPrints/Plugin/Export/XSLT&diff=10795API:EPrints/Plugin/Export/XSLT2013-07-17T10:20:39Z<p>Tmb: </p>
<hr />
<div><!-- Pod2Wiki=_preamble_ <br />
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.<br />
-->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Plugin/Export/XSLT.pm|package_name=EPrints::Plugin::Export::XSLT}}[[Category:API|XSLT]][[Category:API:EPrints/Plugin/Export|XSLT]][[Category:API:EPrints/Plugin/Export/XSLT|XSLT]]<div><!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --><br />
==NAME==<br />
EPrints::Plugin::Export::XSLT - XSLT-based exports<br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_synopsis --><br />
==SYNOPSIS==<br />
Create a file in <code>Plugins/Export/XSLT/</code> called 'Title.xsl' containing:<br />
<br />
<source lang="perl"><?xml version="1.0"?><br />
<br />
<xsl:stylesheet<br />
version="1.0"<br />
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"<br />
ept:name="Titles"<br />
ept:visible="all"<br />
ept:advertise="1"<br />
ept:accept="list/eprint dataobj/eprint"<br />
ept:mimetype="application/xml; charset=utf-8"<br />
ept:qs="0.1"<br />
xmlns:ept="http://eprints.org/ep2/xslt/1.0"<br />
xmlns:ep="http://eprints.org/ep2/data/2.0"<br />
exclude-result-prefixes="ept ep"<br />
><br />
<br />
<xsl:param name="results" /><br />
<br />
<xsl:template match="text()" /><br />
<br />
<xsl:template match="/ept:template"><br />
<titles><xsl:value-of select="$results"/></titles><br />
</xsl:template><br />
<br />
<xsl:template match="/ep:eprints/ep:eprint"><br />
<title><xsl:value-of select="ep:title"/></title><br />
</xsl:template><br />
<br />
</xsl:stylesheet></source><br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_description --><br />
==DESCRIPTION==<br />
This export plugin allows you to use XSL Transforms to export data from EPrints. The plugin is fed EPrints XML and can output any resulting data supported by XSLT.<br />
<br />
This is the inverse process of [[API:EPrints/Plugin/Import/XSLT|EPrints::Plugin::Import::XSLT]].<br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_headers_and_footers --><br />
===Headers and Footers===<br />
You can specify a template to use for your output:<br />
<br />
<pre> &lt;xsl:template match="ept:template"&gt;<br />
&lt;html&gt;<br />
&lt;body&gt;<br />
&lt;xsl:value-of select="$results"/&gt;<br />
&lt;/body&gt;<br />
&lt;/html&gt;<br />
&lt;/xsl:template&gt;</pre><br />
<br />
Note: you can output unbalanced XML by using disable-output-escaping:<br />
<br />
<pre> &lt;xsl:template match="ept:template"&gt;<br />
&lt;xsl:text disable-output-escaping="yes"&gt;<br />
&amp;lt;html&amp;gt;<br />
&amp;lt;body&amp;gt;<br />
&lt;/xsl:text&gt;<br />
&lt;xsl:value-of select="$results"/&gt;<br />
&lt;/xsl:template&gt;</pre><br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_controlling_xml_declarations --><br />
===Controlling XML Declarations===<br />
If your stylesheet outputs XML (the default):<br />
<br />
<pre> &lt;xsl:output method="xml"/&gt;</pre><br />
<br />
The XML declaration will only be outputted once at the start of the export, regardless of how many records there are.<br />
<br />
To output as XML and suppress the XML declaration entirely define an empty prefix:<br />
<br />
<pre> &lt;xsl:stylesheet<br />
xmlns:ept="http://eprints.org/ep2/xslt/1.0"<br />
ept:prefix=""<br />
&gt;</pre><br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_plugin_options --><br />
==PLUGIN OPTIONS==<br />
All attributes on &lt;xsl:stylesheet&gt; that are in the EPT namespace are treated as plugin parameters. In addition to those parameters used by all [[API:EPrints/Plugin/Export|EPrints::Plugin::Export]] plugins XSLT uses:<br />
<br />
<pre> prefix<br />
Value is printed before any content (defaults to XML decl.)<br />
postfix<br />
Value is printed after any content.</pre><br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_stylesheet_parameters --><br />
==STYLESHEET PARAMETERS==<br />
The following parameters are passed to the transform for each item:<br />
<br />
<pre> total<br />
Total items in result set.<br />
position<br />
1-indexed position in result set.<br />
dataset<br />
Base id of the item's dataset (e.g. "eprint").</pre><br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_extended_functions --><br />
==EXTENDED FUNCTIONS==<br />
The standard EPrints global extended XPath functions are supported, see [[API:EPrints/XSLT|EPrints::XSLT]].<br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_see_also --><br />
==SEE ALSO==<br />
[[API:EPrints/Plugin/Export|EPrints::Plugin::Export]]<br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=head_copyright --><br />
==COPYRIGHT==<br />
Copyright 2000-2011 University of Southampton.<br />
<br />
This file is part of EPrints http://www.eprints.org/.<br />
<br />
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<br />
<br />
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 Lesser General Public License for more details.<br />
<br />
You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.<br />
<br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
<!-- Pod2Wiki=_postamble_ --><br />
<!-- Edit below this comment --></div>Tmbhttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.2&diff=10582New Features in EPrints 3.22012-07-26T16:15:56Z<p>Tmb: </p>
<hr />
<div>[[Category:Releases]]<br />
{{releasenotes}}<br />
<br />
==NOTE==<br />
* We now recommend LibXML in preference to GDOME. It's less buggy, and easier to install.<br />
* Upgrade may take several hours as it cleans up the unicode issues in the database.<br />
<br />
==Database==<br />
* In addition to MySQL, EPrints 3.2 now supports Oracle and Postgres<br />
<br />
==API==<br />
* This release features a formal API. Not all functionality is yet available via the API, but will be added slowly and carefully in future releases.<br />
* The bugbear of EPrints internals, EPrints::Session has been merged into EPrints::Repository. All old code will still work.<br />
<br />
==Documents==<br />
* Thumbnails are now documents in their own right<br />
* Built in document-format icons, as well as those you configure yourself<br />
* Thumbnailing now happens in the background as part of the indexer process<br />
<br />
==Deposit Interface==<br />
* Edit Locking locks records reduces risk of 2 people editing a record at the same time.<br />
* Option to extract metadata and images from OpenXML files (.docx and .pptx)<br />
* Offers options to users and editors on the deposit screen if there are problems<br />
* Document upload screen has been redesgined to be clearer.<br />
* Split document uploading into adding a new document and editing existing documents<br />
* The documents inside an EPrint may now be re-ordered<br />
* Progress bar on file upload<br />
* Document upload methods (file, url, zip etc.) are now plugin-based and can be extended<br />
* When attempting to deposit an eprint with problems show Save button<br />
* Made it an option to provide action buttons top and bottom in workflow<br />
* Added support for "input_boxes" property to the workflow, so you can now specify the number of input boxes to show for multiple fields<br />
* epc: no longer crashes eprints on bad scripts, just reports an error<br />
<br />
==Search & Indexing==<br />
* The search library has been entirely re-written to reduce use of cache tables and to improve performance. Simple searches are now over ten times faster.<br />
* The indexer now uses plugins, so you can schedule other tasks, like thumbnail conversion, to be done in the background.<br />
* Added config option "cache_max" to limit the cachemap tables used<br />
* Added --clear option to cleanup old/broken indexer jobs<br />
<br />
==Unicode==<br />
* EPrints use of unicode has been significantly improved.<br />
<br />
==REST==<br />
* A "REST" style interface to objects, via /rest/eprint/23/title.txt, for example. This can also support "PUT" to alter fields!<br />
<br />
==SWORD2==<br />
* SWORD2 (1.3 Specification) is supported.<br />
<br />
==Linked Data Support==<br />
* Ability to establish arbitrary relations between objects or provide additional metadata in triple form.<br />
<br />
==Collections Support==<br />
* Collections can be built via use of linked data, object ids and relationships. <br />
<br />
== Semantic Web / Linked Data (RDF) ==<br />
<br />
We have made a (difficult) decision to move these features to 3.2.1 (due out soon after 3.2.0) because testing showed it caused a significant slow down.<br />
<br />
We're rewriting it to do the same thing but with much less overhead!<br />
<br />
==Storage Layer==<br />
* Now uses plugins to store files<br />
** Local Filesystem<br />
** Amazon S3<br />
** Sun Cloud Storage<br />
<br />
==Speed==<br />
* Search & Indexing much faster<br />
* Import is faster<br />
* Other parts of the code have been audited for speed, and optimised.<br />
<br />
==Import==<br />
* Modified Import UI to allow a per-plugin/single/bulk workflow<br />
<br />
==EPC & EPrints Script==<br />
* New EPC tag: epc:debug, which is like print but sends the XML to STDERR for debugging purposes.<br />
* New EPC tag: epc:set which defines a variable inside it's scope.<br />
* Improvements to the epc:foreach processing (better handling of multiple object types in lists)<br />
* Added "limit" option to epc:foreach to limit the number<br />
* Inside <epc:foreach> blocks an $index variable is set, allowing you to test which interation it's on.<br />
* New EPScript methods: citation_link, dataset, related_objects, url, doc_size, is_public, thumbnail_url, preview_link, icon, human_filesize, control_url, contact_email, property, substr, filter_compound_list, to_data_array, pretty_list, array_concat, action_list, action_button, action_title, action_description, action_icon<br />
* New Script methods: <br />
** $data.property($key) which takes a string and returns a property from a hash or dataobj.<br />
** $eprint.documents() which returns all the "real" (non-volatile) documents.<br />
* New Script inline math functions: + - / * %<br />
* New EPrints Script datatype: DATA_ARRAY: Represents a list of tuples of [$value, $epscript_type]<br />
<br />
==OAI==<br />
* Stateless OAI Interface means no timing-out<br />
* Support for multiple constraints in custom OAI sets<br />
<br />
==Unit Tests==<br />
* We have introduced unit-tests to improve both the short and long term quality of our code.<br />
==Metadata Types==<br />
* Counter (incrementing value)<br />
* Timestamp (defaults to the current time)<br />
* UUID<br />
* MetaField::Search now has two properties:<br />
** "namedfields" which is an array ref of field names to search OR<br />
** "namedfields_config" which is the name of a config variable<br />
* MetaField::Search can now be used in any workflow (not hard-coded to editpermfields)<br />
* A captcha pseudo-field based on http://recaptcha.net/<br />
* added "repeat_secret" property to secret fields that will render a confirmation box which is checked with validate()<br />
* Storable (store arbitrary Perl structures - internal use)<br />
<br />
==Administration Interface==<br />
* Converted Admin screen into several tabs.<br />
* Improved the BatchEdit interface<br />
* Show a progress bar while records are updated during batch edit<br />
<br />
==Editorial Interface==<br />
* Improved "Review" Screen<br />
* The "Review buffer" can now be filtered for better management of large review buffers.<br />
* When an editor provide the "Move to Review" button if there are problems<br />
<br />
==User Defined Datasets==<br />
* Allows 3rd party tools to create their own additional datasets<br />
* Suite of interface screens to work with these new datasets<br />
<br />
==Command Line Tools==<br />
* Allow eprint ids to be specified for redo_thumbnails<br />
<br />
==Export ==<br />
* Added support for OAI-ORE<br />
* Added support for JSONP<br />
* Added support for an 'n' argument to search exports<br />
* Added arguments support to export plugins. Passed by CGI arguments on abstract search or by the --arg option in bin/export<br />
<br />
==Abstract Page==<br />
* Now generated with a citation<br />
* Shows an "action list", so plugins can register to appear on this page<br />
<br />
==Phrases==<br />
* Primary method of editing phrases is now the web interface<br />
* Added "ref" option to phrases, which will cause the referenced phrase to be used instead - Equivalent to calling the referenced phrase directly<br />
<br />
==Views==<br />
* Entire rendering of item lists and menus can be over-ridden by a function<br />
<br />
==Misc. Changes ==<br />
* Can now disable a repository through a system configuration setting<br />
* Refactoured DataObj::get_defaults so that you can now specify default values through a "default_value" property<br />
* Most of get_defaults() can now be specified through the metafield spec.<br />
* Can now apply multiple changes to the same field (???? I assume this means metafield?)<br />
* Preference field for users (to store k/v pairs in)<br />
* Simplified Apache configuration: generate_apacheconf will no longer overwrite existing files<br />
<br />
==Key Bugfixes==<br />
* Fixed login/logout pages not using phrases<br />
* Fixed spurious history objects being created on document upload<br />
* Fixed an HTML insertion bug in the <title> element [Brian D. Gregg]<br />
* Fixed schema errors in uketd_dc and METS/MODS export plugins<br />
* Fixed bug in Compound creation of Set types that squashed the set options<br />
* Fixed order static directories are searched to: repository->theme->system<br />
* Support long values in browse views by using the MD5 of the value,<br />
* Subject inputform component can now be used with singular values<br />
* Fixed bug that is_advertised property on export plugins was being ignored.<br />
* Fixed bug in indexer which meant it didn't index in a round-robin fashion.<br />
* Fixed export not respecting metadata visibility<br />
<br />
<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
<br />
If upgrading from 3.1 to 3.2, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
* cp lib/defaultcfg/cfg.d/rdf* archives/YOURID/cfg/cfg.d/<br />
* run epadmin recommit<br />
* edit cfg/lang/en/static/index.xpage and add the following to the <xpage:head> section. <br />
<xpage:head><br />
<link rel="alternate" type="application/rss+xml" title="Items in {phrase('archive_name')}" href="{$config{http_cgiurl}}/latest_tool?output=RSS2"></link><br />
<link rel="alternate" type="application/atom+xml" title="Items in {phrase('archive_name')}" href="{$config{http_cgiurl}}/latest_tool?output=Atom"></link><br />
<link rel="alternate" type="application/rdf+xml" title="Repository Summary RDF+XML" href="{$config{http_cgiurl}}/repositoryinfo/RDFXML/devel.rdf"></link><br />
<link rel="alternate" type="text/n3" title="Repository Summary RDF+N3" href="{$config{http_cgiurl}}/repositoryinfo/RDFN3/devel.n3"></link><br />
</xpage:head><br />
(you may already have the rss & atom bits)<br />
<br />
* This list has NOT been completed yet, we're working on it!<br />
<br />
==New and Altered Config options==<br />
<br />
These need documenting and noting which ones we recommend setting/altering when upgrading.<br />
<br />
* Set "hide_document_conversion" to hide the Convert link on the document workflow<br />
* Broke up SystemSettings into logically named files<br />
* Can now disable a repository through a system configuration setting<br />
* Moved most of eprint_render.pl into a citation file: summary_page.xml<br />
* Updated defaults views.pl to show current configuration style<br />
* Improved document_upload.pl layout to make it easier to add/remove suffix to mimetype mappings.<br />
* Added URI to EPrint Summary Page<br />
* Added RDF+XML and N3+NT Document formats <br />
* New metafield option: $defaults{render_max_search_values} = 5;<br />
* Added "show_help" option to workflow component to disable collapsing Usage: show_help={always,toggle,never}<br />
* Added config option "cache_max" to limit the cachemap tables used<br />
* user defined datasets<br />
* Made it an option to provide action buttons top and bottom in workflow<br />
**$c->{locking}->{eprint}->{enable} = 1;<br />
**$c->{locking}->{eprint}->{timeout} = 600;<br />
*REST privs<br />
*check registation email callback<br />
*epc:debug, epc:set, changes to epc:foreach<br />
*lots of eprints script functions (see list above)<br />
*views.pl<br />
** "DEFAULT;render_fn=render_view_items_3col_boxes",<br />
** render_menu => "render_view_menu_3col_boxes"<br />
** ranges & variations were introduced in 3.1.? but need documenting.<br />
* Storage plugins<br />
* adding actions to abstract page<br />
* select targz,zip,plain etc. in workflow/upload</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Upgrading_from_3.1&diff=10579Upgrading from 3.12012-07-26T12:07:40Z<p>Tmb: /* Minimising downtime */</p>
<hr />
<div><br />
One of the core parts of upgrading from 3.1 is converting all database tables and data to the utf8 charset (previous version of EPrints used latin1). There are a couple of pitfalls in this process - the following tips are from the EPrints Services team, after carrying out many upgrades to 3.2. Please note that you follow this advice at your own risk.<br />
<br />
==Avoiding subject__index_grep key length error==<br />
<br />
When converting subject__index_grep and subject__rindex to utf8, ''bin/epadmin upgrade'' will generate an error:<br />
<br />
DBD::mysql::db do failed: Specified key was too long; max key length is 1000 bytes at /opt/eprints3/perl_lib/EPrints/Database.pm line 3213, <STDIN> line 1.<br />
<br />
To avoid this error clear the tables before running ''bin/epadmin upgrade'':<br />
<br />
delete from subject__index_grep<br />
delete from subject__rindex<br />
<br />
Then reindex when ''bin/epadmin upgrade'' has completed:<br />
<br />
bin/epadmin reindex ARCHIVEID subject<br />
<br />
==Minimising downtime==<br />
<br />
Whilst ''bin/epadmin upgrade'' is running, your repository will be offline.<br />
<br />
If you have a LARGE repository the conversion to utf8 can take a LONG time (12+ hours). However some of the tables are volatile (ie. the data can be generated) so you can reduce downtime by clearing these tables beforehand, and then regenerating the content afterwards (whilst your repository is back online).<br />
<br />
You only really need to consider this if your eprint__rindex table contains MILLIONS of rows.<br />
<br />
Clear these tables before running ''bin/epadmin upgrade'':<br />
<br />
DELETE FROM eprint__rindex;<br />
<br />
After running ''bin/epadmin upgrade'' and getting your repository back online:<br />
<br />
bin/epadmin reindex ARCHIVEID eprint<br />
<br />
Note that your search won't be at full capacity until the indexes are fully regenerated, but we have found that getting the repository back online ASAP is more desirable so worth the trade off.</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Upgrading_from_3.1&diff=10578Upgrading from 3.12012-07-26T12:07:14Z<p>Tmb: /* Avoiding subject__index_grep key length error */</p>
<hr />
<div><br />
One of the core parts of upgrading from 3.1 is converting all database tables and data to the utf8 charset (previous version of EPrints used latin1). There are a couple of pitfalls in this process - the following tips are from the EPrints Services team, after carrying out many upgrades to 3.2. Please note that you follow this advice at your own risk.<br />
<br />
==Avoiding subject__index_grep key length error==<br />
<br />
When converting subject__index_grep and subject__rindex to utf8, ''bin/epadmin upgrade'' will generate an error:<br />
<br />
DBD::mysql::db do failed: Specified key was too long; max key length is 1000 bytes at /opt/eprints3/perl_lib/EPrints/Database.pm line 3213, <STDIN> line 1.<br />
<br />
To avoid this error clear the tables before running ''bin/epadmin upgrade'':<br />
<br />
delete from subject__index_grep<br />
delete from subject__rindex<br />
<br />
Then reindex when ''bin/epadmin upgrade'' has completed:<br />
<br />
bin/epadmin reindex ARCHIVEID subject<br />
<br />
==Minimising downtime==<br />
<br />
Whilst ''bin/epadmin upgrade'' is running, your repository will be offline.<br />
<br />
If you have a LARGE repository the conversion to utf8 can take a LONG time (12+ hours). However some of the tables are volatile (ie. the data can be generated) so you can reduce downtime by clearing these tables beforehand, and then regenerating the content afterwards (whilst your repository is back online).<br />
<br />
You only really need to consider this if your eprint__rindex table contains MILLIONS of rows.<br />
<br />
Clear these tables before running ''bin/epadmin upgrade'':<br />
<br />
DELETE FROM eprint__rindex;<br />
DELETE FROM eprint__ordervalues_en;<br />
<br />
After running ''bin/epadmin upgrade'' and getting your repository back online:<br />
<br />
bin/epadmin reindex ARCHIVEID eprint<br />
bin/epadmin reorder ARCHIVEID eprint<br />
<br />
Note that your search won't be at full capacity until the indexes are fully regenerated, but we have found that getting the repository back online ASAP is more desirable so worth the trade off.</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Upgrading_from_3.1&diff=10574Upgrading from 3.12012-07-25T15:26:50Z<p>Tmb: /* Avoiding subject__index_grep key length error */</p>
<hr />
<div><br />
One of the core parts of upgrading from 3.1 is converting all database tables and data to the utf8 charset (previous version of EPrints used latin1). There are a couple of pitfalls in this process - the following tips are from the EPrints Services team, after carrying out many upgrades to 3.2. Please note that you follow this advice at your own risk.<br />
<br />
==Avoiding subject__index_grep key length error==<br />
<br />
When converting subject__index_grep and subject__rindex to utf8, ''bin/epadmin upgrade'' will generate an error:<br />
<br />
DBD::mysql::db do failed: Specified key was too long; max key length is 1000 bytes at /opt/eprints3/perl_lib/EPrints/Database.pm line 3213, <STDIN> line 1.<br />
<br />
To avoid this error drop the tables before running ''bin/epadmin upgrade'':<br />
<br />
delete from subject__index_grep<br />
delete from subject__rindex<br />
<br />
Then reindex when ''bin/epadmin upgrade'' has completed:<br />
<br />
bin/epadmin reindex ARCHIVEID subject<br />
<br />
==Minimising downtime==<br />
<br />
Whilst ''bin/epadmin upgrade'' is running, your repository will be offline.<br />
<br />
If you have a LARGE repository the conversion to utf8 can take a LONG time (12+ hours). However some of the tables are volatile (ie. the data can be generated) so you can reduce downtime by clearing these tables beforehand, and then regenerating the content afterwards (whilst your repository is back online).<br />
<br />
You only really need to consider this if your eprint__rindex table contains MILLIONS of rows.<br />
<br />
Clear these tables before running ''bin/epadmin upgrade'':<br />
<br />
DELETE FROM eprint__rindex;<br />
DELETE FROM eprint__ordervalues_en;<br />
<br />
After running ''bin/epadmin upgrade'' and getting your repository back online:<br />
<br />
bin/epadmin reindex ARCHIVEID eprint<br />
bin/epadmin reorder ARCHIVEID eprint<br />
<br />
Note that your search won't be at full capacity until the indexes are fully regenerated, but we have found that getting the repository back online ASAP is more desirable so worth the trade off.</div>Tmbhttps://wiki.eprints.org/w/index.php?title=Files/OpenAIRE_Compliance_Plug-in&diff=10524Files/OpenAIRE Compliance Plug-in2012-06-01T10:09:16Z<p>Tmb: </p>
<hr />
<div>This EPrints extension is designed to help the administrators of repositories that contain outputs from EU FP7 funded projects to achieve compliance with the OpenAIRE Guidelines version 1.1 (http://www.openaire.eu/index.php?option=com_content&view=article&id=207).<br />
<br />
In summary, these guidelines state that the outputs from FP7 projects must be made avaiable for harvesting via OAI-PMH using a defined set specification. In addition these outputs should meet certain standards in their metadata as defined in the guidelines document.<br />
<br />
==What this add-on does and doesn't do==<br />
<br />
===This add-on will===<br />
<br />
* Add new metadata fields for EU FP7 specific elements<br />
* Map the default EPrints data types to their DRIVER equivalents (see http://www.driver-support.eu/documents/DRIVER_Guidelines_v2_Final_2008-11-13.pdf, page 69)<br />
* Create a new custom set within the OAI-PMH output of the repository called EC_fundedresources and containing all resources that are flagged as being outputs of FP7 projects<br />
* Add required metadata to the OAI-PMH output<br />
* Check if any files have an embargo date specified (and are restricted access) and alter the rights field in OAI-PMH output to reflect this<br />
<br />
===This add-on will not===<br />
<br />
* Check whether items flagged as outputs of FP7 projects have a Project ID specified in the correct format before including them in the EC_fundedresources set<br />
* Check whether items flagged as outputs of FP7 projects have full text available before including them in the EC_fundedresources set<br />
* Check whether items flagged as outputs of FP7 projects have all required metadata set (e.g. DC.rights)<br />
<br />
This is due to the fact that EPrints custom sets can only currently filter on a single metadata value (in this case we're using the flag that states that the resource is form an FP7 funded project).<br />
<br />
==Installation (EPrints 3.1+)==<br />
<br />
Download the latest tarball to your local repository directory (eg. /opt/eprints3/archives/ARCHIVEID/)<br />
<br />
Extract files:<br />
<br />
tar xzvf eprints-openaire.xx.tgz<br />
<br />
===Update database===<br />
<br />
Add the new metadata fields to your database:<br />
<br />
cd [eprints_root]/bin<br />
./epadmin update_database_structure ARCHIVEID --verbose<br />
<br />
==Getting started==<br />
<br />
To activate the OpenAIRE compliance features you will need to make some changes to your repository setup. <br />
<br />
In file cfg/cfg.d/eprint_fields_automatic.pl add the following lines:<br />
<br />
# Map Eprints type to DRIVER type<br />
my %type_map = (<br />
"article" => "info:eu-repo/semantics/article",<br />
"book_section" => "info:eu-repo/semantics/bookPart",<br />
"monograph" => "info:eu-repo/semantics/book",<br />
"conference_item" => "info:eu-repo/semantics/conferenceObject",<br />
"book" => "info:eu-repo/semantics/book",<br />
"patent" => "info:eu-repo/semantics/patent"<br />
);<br />
<br />
my $mapped_type = (exists $type_map{$type}) ? $type_map{$type} : "info:eu-repo/semantics/other";<br />
$eprint->set_value("fp7_type", $mapped_type)<br />
<br />
In file cfg/workflows/eprint/default.xml add the following lines before the closing </workflow> tag:<br />
<br />
<stage name="fp7"><br />
<component type="Field::Multi"><br />
<title>Details for FP7 project outputs</title><br />
<field ref="fp7_project"/><br />
<field ref="fp7_project_id"/><br />
<field ref="access_rights"/><br />
</component><br />
</stage><br />
<br />
And add the following line to the <flow> element (near the start of the file) to place the new FP7 stage where you feelit will be most appropriate for your workflow:<br />
<br />
<stage ref="fp7"/><br />
<br />
e.g.:<br />
<br />
<flow><br />
<stage ref="type"/><br />
<stage ref="files"/><br />
<stage ref="core"/><br />
<stage ref="subjects"/><br />
<stage ref="fp7"/><br />
</flow><br />
<br />
Restart apache to ensure that all the changes are applied.<br />
<br />
==ADDENDUM - install notes for EPrints 3.3==<br />
<br />
-----Original Message-----<br />
From: Timothy Miles-Board<br />
Sent: 01 June 2012 10:53<br />
To: Rob Ingram<br />
Subject: OpenAIRE Compliance Plug-in http://files.eprints.org/649/<br />
<br />
Hi Rob,<br />
<br />
FYI<br />
<br />
I've just installed your plugin on an EPrints 3.3 repository.<br />
<br />
The OAI code has changed in 3.3 so it doesn't work out of the box.<br />
<br />
$c->{oai}->{v2}->{output_plugins}->{oai_dc} = "OAI_DC_Ext";<br />
<br />
The OAI code no longer looks at the output_plugins setting to determine <br />
which plugin to use for each metadataPrefix. Each individual export <br />
plugin can now advertise support for a metadataPrefix so given a <br />
metadataPrefix request, the OAI code just asks the plugin subsystem for <br />
a plugin that says it supports that metadataPrefix.<br />
<br />
So in order to get the OAI_DC_Ext used instead of the default OAI_DC I <br />
needed to add the following config settings (eg. to z_oai.pl):<br />
<br />
# don't use Export::OAI_DC for oai_dc metadataPrefix...<br />
$c->{plugins}->{"Export::OAI_DC"}->{params}->{metadataPrefix} = undef;<br />
# ...use Export::OAI_DC_Ext instead<br />
$c->{plugins}->{"Export::OAI_DC_Ext"}->{params}->{metadataPrefix} = "oai_dc";<br />
<br />
Regards,<br />
<br />
Tim<br />
<br />
--<br />
Timothy Miles-Board<br />
EPrints Services</div>Tmbhttps://wiki.eprints.org/w/index.php?title=My_First_Bazaar_Package&diff=10494My First Bazaar Package2012-05-18T11:24:01Z<p>Tmb: /* Step 5 - Adding the missing phrases */</p>
<hr />
<div>=Introduction=<br />
<br />
In this tutorial you will create a "Hello, World" Screen and package it as a Bazaar Package (.epm).<br />
<br />
=Requirements=<br />
<br />
You will need a working EPrints installation on which you have an administrator account. You will need to have access to the command line to create the files for the package.<br />
<br />
=Step 1 - Develop your package contents=<br />
<br />
You will need to be in the root directory of your EPrints installation (typically /opt/eprints3).<br />
<br />
''gedit'' is the Gnome Text editor but you can use any editor that is capable of creating text files.<br />
<br />
==Hello.pm==<br />
<br />
Create the directory to contain the ''Screen'' plugin you're going to package:<br />
<br />
$ mkdir -p lib/plugins/EPrints/Plugin/Screen/<br />
<br />
Create the screen plugin using your preferred text editor and add the sample content below:<br />
<br />
$ gedit lib/plugins/EPrints/Plugin/Screen/Hello.pm<br />
<br />
package EPrints::Plugin::Screen::Hello;<br />
<br />
@ISA = ( 'EPrints::Plugin::Screen' );<br />
<br />
use strict;<br />
# Make the plug-in<br />
sub new<br />
{<br />
my( $class, %params ) = @_;<br />
<br />
my $self = $class->SUPER::new(%params);<br />
<br />
# Where the button to access the screen appears if anywhere, and what priority<br />
$self->{appears} = [<br />
{<br />
place => "admin_actions",<br />
position => 1247,<br />
},<br />
];<br />
<br />
return $self;<br />
}<br />
<br />
# Anyone can see this screen<br />
sub can_be_viewed { 1 }<br />
<br />
# What to display<br />
sub render<br />
{<br />
my( $self ) = @_;<br />
<br />
# Get the current repository object (so we can access the users, eprints information about things in this repository)<br />
<br />
my $repository = $self->{repository};<br />
<br />
# Create an XML element to return to our screen<br />
<br />
my $frag = $repository->xml->create_document_fragment();<br />
<br />
# Fill the fragment with stuff<br />
<br />
$frag->appendChild($repository->xml->create_text_node( "Hello, World!" ));<br />
<br />
return $frag;<br />
}<br />
<br />
1;<br />
<br />
==hello_world.pl==<br />
<br />
Create the package directory that will contain the package's configuration file:<br />
<br />
$ mkdir -p lib/epm/hello_world/cfg/cfg.d<br />
<br />
Create a configuration file that enables the plugin - this file is copied into the repository when the package is enabled:<br />
<br />
$ gedit lib/epm/hello_world/cfg/cfg.d/hello_world.pl<br />
<br />
$c->{plugins}{"Screen::Hello"}{params}{disable} = 0;<br />
<br />
'''NOTE All plugins in lib/plugins are disabled by default (see EPrints::PluginFactory::new) UNLESS you explicitly set the disable property in the plugin (and it doesn't make sense to set disable = 0 in the plugin because that would make it visible to all of your repositories even if they hadn't explicitly enabled your bazaar package).<br />
<br />
=Step 2 - Add an Icon=<br />
<br />
Create an Icon, using the icon builder at http://bazaar.eprints.org<br />
<br />
OR<br />
<br />
Download the hello_world icon from http://bazaar.eprints.org/images/hello_world.png<br />
<br />
Once you have this icon, name it hello_world.png and move it into the lib/static/images/epms/ directory.<br />
<br />
=Step 3 - Create a blank package=<br />
<br />
In ''Admin'' &rarr; ''System Tools'' &rarr; ''EPrints Bazaar'', select the ''Developer Tools'' tab.<br />
<br />
At the bottom of this screen is a form to create a new EPM. Enter the name (without quotes) "hello_world" and click ''Create''.<br />
<br />
You can fill out the metadata if you wish but at this stage you are only required to have a ''version'', which defaults to "1.0.0".<br />
<br />
At the bottom of the screen (the ''Files'' selector) you need to add the two files you created above:<br />
<br />
* epm/hello_world/cfg/cfg.d/hello_world.pl<br />
* plugins/EPrints/Plugin/Screen/Hello.pm<br />
* static/images/epm/hello_world.png<br />
<br />
Click ''Save and Return'' to return to the EPrints Bazaar screen.<br />
<br />
If you make a mistake you can click ''Edit'' on the ''Developer Tools'' tab to re-edit the package.<br />
<br />
=Step 4 - Enable and test the package=<br />
<br />
On the EPrints Bazaar ''Installed'' tab click ''Enable'' for the '''hello_world''' package. After a short time you should see a repository configuration reloaded message.<br />
<br />
In ''Admin'' &rarr; ''System Tools'' &rarr; ''Misc. Tools'' you should now a button-link to your plugin (although with a missing phrase).<br />
<br />
You can now use ''Uninstall'' to completely remove the package and the source files created. A copy of the package will be saved in '''var/cache/epm/hello_world-1.0.0.epm'''.<br />
<br />
=Step 5 - Adding the missing phrases=<br />
<br />
As EPrints is designed to be multi-language, phrases should be used instead of embedded text.<br />
<br />
In this section we add the phrase file to define a name a description for our screen.<br />
<br />
Create the English language directory that will contain the package's English language phrase file:<br />
<br />
$ mkdir -p lib/lang/en/phrases/<br />
<br />
Create a phrase file:<br />
<br />
$ gedit lib/lang/en/phrases/hello_world.xml<br />
<br />
<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?><br />
<!DOCTYPE phrases SYSTEM "entities.dtd"><br />
<br />
<epp:phrases xmlns="http://www.w3.org/1999/xhtml" xmlns:epp="http://eprints.org/ep3/phrase" xmlns:epc="http://eprints.org/ep3/control"><br />
<br />
<epp:phrase id="Plugin/Screen/Hello:title">Hello</epp:phrase><br />
<epp:phrase id="Plugin/Screen/Hello:description">My First Bazaar Package</epp:phrase><br />
<br />
<epp:phrase id="Plugin/Screen/Hello:text">Hello World - This is the my first bazaar package calling.</epp:phrase><br />
<br />
</epp:phrases><br />
<br />
Don't worry too much about the wrapping here, the important thing are the phrases of which we have created 3. <br />
<br />
Note that 2 of these (the top 2) will get used instantly by our package however the 3rd needs to be added to the render method of our screen. <br />
<br />
In order to do this edit the Hello.pm screen created in Step 1 and add the following in the appropriate place in the render method.<br />
<br />
$frag->appendChild($repository->xml->create_element("br"));<br />
$frag->appendChild($self->html_phrase("text"));<br />
<br />
For some hints on loading and manipulating EPrints see [[Manipulating eprints in 3.2]].<br />
<br />
'''Don't Forget''' to add the phrase file to your bazaar package using the developer tools tab.<br />
<br />
'''WARNING: if your package overrides any existing EPrints phrases then your overrides will be applied to ALL repositories even if they have not enabled your package. In this case you would add your override phrases to a separate file - eg. lib/epm/hello_world/cfg/lang/en/phrases/hello_world_overrides.xml - this file will then only be considered when a repository enables your package.<br />
<br />
[[Category:EPrints_Bazaar]]</div>Tmb