Getting Started - Revision history

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

← Older revision		Revision as of 17:22, 10 March 2025
Line 17:		Line 17:
	Change to your eprints user (probably "eprints").		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		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 ===		===Creating the Database Tables and Website ===

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

← Older revision		Revision as of 17:18, 10 March 2025
Line 18:		Line 18:

	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~~

	~~If you are running EPrints version 3.4+ you will need to provide an extra parameter, typically this would be <tt>pub</tt> to create a publications [[EPrints Flavours\|flavour]] archive. E.g.~~
	bin/epadmin create pub		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 ===		===Creating the Database Tables and Website ===

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

2023-10-04T11:42:04Z

Example Configuration

← Older revision		Revision as of 11:42, 4 October 2023
Line 112:		Line 112:

	===Example Configuration===		===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>		<pre>

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

2023-10-04T11:41:43Z

Example Configuration

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

	===Example Configuration===		===Example Configuration===
	The 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 "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.

	<pre>		<pre>

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

2023-10-04T11:41:03Z

Creating a crontab

← 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".

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

2023-10-04T11:40:48Z

Setting it up

← 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.

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

2023-10-04T11:40:14Z

Subscriptions: Fixed crontab formatting

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

	For example (with dookuprints being the name of the archive):		For example (with dookuprints being the name of the archive):
			# 00:15 every morning
			15 0 * * * /opt/eprints2/bin/send_subscriptions dookuprints daily
	~~<code>~~
	# 00:15 every morning		# 00:30 every sunday morning
	15 0 * * * /opt/eprints2/bin/send_subscriptions dookuprints daily		30 0 * * 0 /opt/eprints2/bin/send_subscriptions dookuprints weekly
	# 00:30 every sunday morning
	30 0 * * 0 /opt/eprints2/bin/send_subscriptions dookuprints weekly		# 00:45 every first of the month
	# 00:45 every first of the month		45 0 1 * * /opt/eprints2/bin/send_subscriptions dookuprints monthly
	45 0 1 * * /opt/eprints2/bin/send_subscriptions dookuprints monthly
	~~</code>~~
	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).		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).

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

2023-10-04T11:38:56Z

Example Configuration=

← Older revision		Revision as of 11:38, 4 October 2023
Line 119:		Line 119:
	In general: Change it! It's not a recommended system setup, just a good starting point.		In general: Change it! It's not a recommended system setup, just a good starting point.

	===Example Configuration====		===Example Configuration===
	The 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 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.

Drn@ecs.soton.ac.uk: /* Default Configuration */ Added example configuration through epadmin

2023-10-04T11:38:48Z

Default Configuration: Added example configuration through epadmin

Show changes

Drn@ecs.soton.ac.uk: /* Creating MySQL eprints user */

2023-10-04T11:25:40Z

Creating MySQL eprints user

← Older revision		Revision as of 11:25, 4 October 2023
Line 7:		Line 7:

	===Creating MySQL eprints user===		===Creating MySQL eprints user===
	If you are running a modern version of Linux (e.g. Red Hat Enterprise Linux 9+ or Ubuntu 20.04+), the eprints user will not be able to connect to the MySQL database as the root user without a password. Therefore, before running "epadmin create" later in these instructions make sure you switch ~~the~~ the root user, ~~run~~ the MySQL client and run the following commands, substituting the password (i.e. 'changeme') appropriately.		If you are running a modern version of Linux (e.g. Red Hat Enterprise Linux 9+ or Ubuntu 20.04+), the eprints user will not be able to connect to the MySQL database as the root user without a password. Therefore, before running "epadmin create" later in these instructions make sure you switch to the root user, open the MySQL client and run the following commands, (substituting the password (i.e. 'changeme') appropriately):
	CREATE USER 'eprints'@'localhost' IDENTIFIED by 'changeme';		CREATE USER 'eprints'@'localhost' IDENTIFIED by 'changeme';
	GRANT ALL PRIVILEGES ON . TO 'eprints'@'localhost' WITH GRANT OPTION;		GRANT ALL PRIVILEGES ON . TO 'eprints'@'localhost' WITH GRANT OPTION;
	When you are for the '''Database Superuser Username''' and '''Database Superuser Password''' be sure to use the username and password set above. If you are running older version of Linux where you have not needed to do the above steps. You can probably use the default options for these to steps.		When you are asked for the '''Database Superuser Username''' and '''Database Superuser Password''' be sure to use the username and password set above. If you are running older version of Linux where you have not needed to do the above steps. You can probably use the default options for these to steps.

	===Creating the Archive===		===Creating the Archive===