Getting Started - Revision history

Drn@ecs.soton.ac.uk: /* Creating a crontab */

2026-08-11T08:45:41Z

‎Creating a crontab

Drn@ecs.soton.ac.uk: /* Running a Live Archive */ Added more info about cron jobs

2026-08-11T08:43:53Z

‎Running a Live Archive: Added more info about cron jobs

Drn@ecs.soton.ac.uk: /* Creating the Archive */ Tried to make what command better explained.

2026-08-06T12:58:22Z

‎Creating the Archive: Tried to make what command better explained.

Drn@ecs.soton.ac.uk: /* Creating the Archive */ Updated instructions about creating different flavours of archive

2025-03-10T17:22:07Z

‎Creating the Archive: Updated instructions about creating different flavours of archive

Drn@ecs.soton.ac.uk: /* Creating the Archive */ Remove references to old EPrints versions just talking about 3.4.x

2025-03-10T17:18:43Z

‎Creating the Archive: Remove references to old EPrints versions just talking about 3.4.x

Drn@ecs.soton.ac.uk: /* Example Configuration */

2023-10-04T11:42:04Z

‎Example Configuration

Drn@ecs.soton.ac.uk: /* Example Configuration */

2023-10-04T11:41:43Z

‎Example Configuration

Drn@ecs.soton.ac.uk: /* Creating a crontab */

2023-10-04T11:41:03Z

‎Creating a crontab

Drn@ecs.soton.ac.uk: /* Setting it up */

2023-10-04T11:40:48Z

‎Setting it up

Drn@ecs.soton.ac.uk: /* Subscriptions */ Fixed crontab formatting

2023-10-04T11:40:14Z

‎Subscriptions: Fixed crontab formatting

@@ Line 42: / Line 42: @@
 {{template:EPrints_Crontab_Template}}
-For more information about [[EPrints Cron Jobs||cron jobs for EPrints, click here]].
+For more information about [[EPrints Cron Jobs|cron jobs for EPrints, click here]].
 ===Backups===

← Older revision		Revision as of 08:43, 11 August 2026
Line 37:		Line 37:

	There should be one set of crontab entries per archive.		There should be one set of crontab entries per archive.
		+
		+	Here is an example crontab template. <code>EPRINTS_PATH</code> and <code>ARCHIVE_ID</code> should be replaced as appropriate.
		+
		+	{{template:EPrints_Crontab_Template}}
		+
		+	For more information about [[EPrints Cron Jobs\|\|cron jobs for EPrints, click here]].

	===Backups===		===Backups===

@@ Line 15: / Line 15: @@
 Make sure MySQL is actually running.
-Change to your eprints user (probably "eprints").
+Change to your "eprints" user.
-Change directory to the eprints directory (<tt>/opt/eprints3</tt> by default) and run:
+Change directory to the eprints directory (<tt>/opt/eprints3</tt> by default) and run the '''EXACT''' following command to create a research publications archive. (You will be prompted to answer various questions about the configuration of your archive):
   bin/epadmin create pub
-Follow the prompts and answer the questions. For more detailed information about creating a repository see [[Getting Started with EPrints 3]].  In particular.  If you don't want a publications repository.  In the above command either use <code>zero</code> instead of <code>pub</code>.  if you want any other flavours (e.g. Research Data or Open Education) of publication you will need to download their <code><b>FLAVOUR</b>_lib</code> to <code><b>EPRINTS_PATH</b>/flavours/</code> before running the above command.
+If you don't want a research publications archive, in the above command use <code>zero</code> instead of <code>pub</code>. This will create a very basic repository, which can either store very generic items or can be more greatly customised as it does not have some of the intentional restrictions that come with a Research Publications repository.  Other flavours of repository may be available but these will have to have be added their <tt>FLAVOUR_lib</tt> to the <tt>EPRINTS_PATH/flavours/</tt> directory.  If you run just <code>bin/epadmin create</code> without a further parameter or one that is not recognised, the command should suggest what types (flavours) of repository archive are available.
 ===Creating the Database Tables and Website ===

@@ Line 17: / Line 17: @@
 Change to your eprints user (probably "eprints").
-Change directory to the eprints directory (<tt>/opt/eprints3</tt> by default) and run
+Change directory to the eprints directory (<tt>/opt/eprints3</tt> by default) and run:
   bin/epadmin create pub
-Follow the prompts and answer the questions. For more detailed information about creating a repository see [[Getting Started with EPrints 3]]
+Follow the prompts and answer the questions. For more detailed information about creating a repository see [[Getting Started with EPrints 3]].  In particular.  If you don't want a publications repository.  In the above command either use <code>zero</code> instead of <code>pub</code>.  if you want any other flavours (e.g. Research Data or Open Education) of publication you will need to download their <code><b>FLAVOUR</b>_lib</code> to <code><b>EPRINTS_PATH</b>/flavours/</code> before running the above command.
 ===Creating the Database Tables and Website ===

@@ Line 18: / Line 18: @@
 Change directory to the eprints directory (<tt>/opt/eprints3</tt> by default) and run
   bin/epadmin create pub
-Follow the prompts and answer the questions.  (This is very different from how things worked under version 2; someone who knows how this all works will hopefully expand on this very bare-bones instruction.) For more detailed information about creating a repository see [[Getting Started with EPrints 3]]
+Follow the prompts and answer the questions. For more detailed information about creating a repository see [[Getting Started with EPrints 3]]
 ===Creating the Database Tables and Website ===

@@ Line 112: / Line 112: @@
 ===Example Configuration===
-The "edadmin create" script will run through a number of configuration options, an example of which is listed below. Please change the settings to suit your site configuration.
+The "epadmin create" script will run through a number of configuration options, an example of which is listed below. Please change the settings to suit your site configuration.
 <pre>

← Older revision		Revision as of 11:41, 4 October 2023
Line 35:		Line 35:

	To set up cron, run (as the eprints user):		To set up cron, run (as the eprints user):
		+	% crontab -e

−
−	~~<code>~~
−	~~% crontab -e~~
−	~~</code>~~
	Exactly what to add to the cron table is described in the following sections - "Browse Views" and "Subscriptions".		Exactly what to add to the cron table is described in the following sections - "Browse Views" and "Subscriptions".

← Older revision		Revision as of 11:40, 4 October 2023
Line 78:		Line 78:

	and add the line		and add the line
		+	23 * * * * /opt/eprints2/bin/generate_views I<archiveid>

−
−	~~<code>~~
−	~~23 * * * * /opt/eprints2/bin/generate_views I<archiveid>~~
−	~~</code>~~
	This runs at 23 minutes past each hour. If you have more than one archive, don't make them all start rebuilding stuff at the same time, stagger it. Otherwise once an hour everything will slow down as it fights to run several intensive scripts at once.		This runs at 23 minutes past each hour. If you have more than one archive, don't make them all start rebuilding stuff at the same time, stagger it. Otherwise once an hour everything will slow down as it fights to run several intensive scripts at once.

@@ Line 93: / Line 93: @@
 For example (with dookuprints being the name of the archive):
+ # 00:15 every morning
+0 * * * /opt/eprints2/bin/send_subscriptions dookuprints daily
-<code>
-    # 00:15 every morning
+ # 00:30 every sunday morning
-0 * * * /opt/eprints2/bin/send_subscriptions dookuprints daily
+0 * * 0 /opt/eprints2/bin/send_subscriptions dookuprints weekly
-    # 00:30 every sunday morning
-0 * * 0 /opt/eprints2/bin/send_subscriptions dookuprints weekly
+ # 00:45 every first of the month
-    # 00:45 every first of the month
+0 1 * * /opt/eprints2/bin/send_subscriptions dookuprints monthly
 Note the spacing out so that all 3 don't start at once and hammer the database. You may wish to change the times, but we recommend early morning as the best time to send them (midnight-6am).