Setting up a development environment with Git - Revision history

Kgoetz: link to unit tests page

2018-09-19T05:01:21Z

link to unit tests page

Kgoetz: Change category Developer to Contribute

2018-09-11T23:52:09Z

Change category Developer to Contribute

Kgoetz: add categories

2018-08-30T06:16:29Z

add categories

Anbeeken@lincoln.ac.uk at 14:23, 10 September 2015

2015-09-10T14:23:01Z

Anbeeken@lincoln.ac.uk at 14:21, 10 September 2015

2015-09-10T14:21:44Z

Anbeeken@lincoln.ac.uk at 11:57, 10 September 2015

2015-09-10T11:57:41Z

Anbeeken@lincoln.ac.uk at 11:47, 10 September 2015

2015-09-10T11:47:31Z

Anbeeken@lincoln.ac.uk at 11:02, 10 September 2015

2015-09-10T11:02:47Z

Anbeeken@lincoln.ac.uk: /* Get your dev EPrints working */

2015-09-10T10:51:24Z

‎Get your dev EPrints working

Anbeeken@lincoln.ac.uk at 10:41, 10 September 2015

2015-09-10T10:41:56Z

@@ Line 38: / Line 38: @@
 Restart your server with '''sudo apache2 restart''' and you should be able to access your new Git enabled site from a browser. If you've changed the hostname for your site, don't forget to edit your hosts file accordingly!
 [[Category:Contribute]]
 [[Category:Howto]]

@@ Line 39: / Line 39: @@
 Restart your server with '''sudo apache2 restart''' and you should be able to access your new Git enabled site from a browser. If you've changed the hostname for your site, don't forget to edit your hosts file accordingly!
-[[Category:Developer]]
+[[Category:Contribute]]
 [[Category:Howto]]

← Older revision		Revision as of 06:16, 30 August 2018
Line 38:		Line 38:

	Restart your server with '''sudo apache2 restart''' and you should be able to access your new Git enabled site from a browser. If you've changed the hostname for your site, don't forget to edit your hosts file accordingly!		Restart your server with '''sudo apache2 restart''' and you should be able to access your new Git enabled site from a browser. If you've changed the hostname for your site, don't forget to edit your hosts file accordingly!
		+
		+	[[Category:Developer]]
		+	[[Category:Howto]]

← Older revision		Revision as of 14:23, 10 September 2015
Line 1:		Line 1:
−	~~'''* WORK IN PROGRESS! *'''~~
−
	This page will detail how to set up EPrints in a development environment that will allow you to keep your local version up to date with any changes made to the EPrints Git repository [http://github.com/eprints/eprints]		This page will detail how to set up EPrints in a development environment that will allow you to keep your local version up to date with any changes made to the EPrints Git repository [http://github.com/eprints/eprints]

Line 38:		Line 36:

	Finally, we need to add our repository as a site. This will be an easy task if you've already installed EPrints from a package (as suggested at the beginning of this documentation!) but the location of the sites is platform dependant. On Ubuntu, you can find them in ''etc/apache2/sites-enabled'', for example. Edit eprints.conf in your text editor of choice and change the path to reflect where your new site lives.		Finally, we need to add our repository as a site. This will be an easy task if you've already installed EPrints from a package (as suggested at the beginning of this documentation!) but the location of the sites is platform dependant. On Ubuntu, you can find them in ''etc/apache2/sites-enabled'', for example. Edit eprints.conf in your text editor of choice and change the path to reflect where your new site lives.
		+
		+	Restart your server with '''sudo apache2 restart''' and you should be able to access your new Git enabled site from a browser. If you've changed the hostname for your site, don't forget to edit your hosts file accordingly!

← Older revision		Revision as of 14:21, 10 September 2015
Line 36:		Line 36:

	Now we need to create a repository. Type '''cd ../../bin'''. From here, '''./epadmin create''' to start the repository creation script. Follow this through to create your new repository.		Now we need to create a repository. Type '''cd ../../bin'''. From here, '''./epadmin create''' to start the repository creation script. Follow this through to create your new repository.
		+
		+	Finally, we need to add our repository as a site. This will be an easy task if you've already installed EPrints from a package (as suggested at the beginning of this documentation!) but the location of the sites is platform dependant. On Ubuntu, you can find them in ''etc/apache2/sites-enabled'', for example. Edit eprints.conf in your text editor of choice and change the path to reflect where your new site lives.

← Older revision		Revision as of 11:57, 10 September 2015
Line 2:		Line 2:

	This page will detail how to set up EPrints in a development environment that will allow you to keep your local version up to date with any changes made to the EPrints Git repository [http://github.com/eprints/eprints]		This page will detail how to set up EPrints in a development environment that will allow you to keep your local version up to date with any changes made to the EPrints Git repository [http://github.com/eprints/eprints]
		+
		+	Ideally you should work through a package install of EPrints before you do this, which will set up users and dependencies for you. You can find a handy video tutorial on how to do that on YouTube [https://www.youtube.com/watch?v=vJ5vf_GXfOI].

	Your development environment should ideally emulate your production environment as closely as possible - you may want to run a virtual machine through an application such as VirtualBox, or use a Linux install directly on your development device.		Your development environment should ideally emulate your production environment as closely as possible - you may want to run a virtual machine through an application such as VirtualBox, or use a Linux install directly on your development device.

← Older revision		Revision as of 11:47, 10 September 2015
Line 31:		Line 31:
	We now need to edit this new SystemSettings file. You can do this in your editor of choice. Find the line that reads'' 'base_path' => "/opt/eprints3"''. This should be line 20. You need to edit this to read''' 'base_path' => "/usr/share/<your-directory>/eprints"''		We now need to edit this new SystemSettings file. You can do this in your editor of choice. Find the line that reads'' 'base_path' => "/opt/eprints3"''. This should be line 20. You need to edit this to read''' 'base_path' => "/usr/share/<your-directory>/eprints"''

−	You should also make sure that the ''user'' and ''group'' settings (lines 23 and 24) are correct - these are usually '''eprints'''.	+	You should also make sure that the ''user'' and ''group'' settings (lines 23 and 24) are correct - these are usually '''eprints'''. Save your changes.
		+
		+	Now we need to create a repository. Type '''cd ../../bin'''. From here, '''./epadmin create''' to start the repository creation script. Follow this through to create your new repository.

← Older revision		Revision as of 11:02, 10 September 2015
Line 27:		Line 27:
	== Get your dev EPrints working ==		== Get your dev EPrints working ==

−	Okay, so now things get a little fiddly. Head into the core EPrints libraries by typing cd /usr/share/<your-~~dir~~>/eprints~~/perl_lib/EPrints~~	+	Okay, so now things get a little fiddly. Head into the core EPrints libraries by typing '''cd eprints/perl_lib/EPrints'''. Now we're going to create a copy of the template ''SystemSettings.pm'' file. Do this with '''cp SystemSettings.pm.templ SystemSettings.pm'''.
		+
		+	We now need to edit this new SystemSettings file. You can do this in your editor of choice. Find the line that reads'' 'base_path' => "/opt/eprints3"''. This should be line 20. You need to edit this to read''' 'base_path' => "/usr/share/<your-directory>/eprints"''
		+
		+	You should also make sure that the ''user'' and ''group'' settings (lines 23 and 24) are correct - these are usually '''eprints'''.

← Older revision		Revision as of 10:51, 10 September 2015
Line 26:		Line 26:

	== Get your dev EPrints working ==		== Get your dev EPrints working ==
		+
		+	Okay, so now things get a little fiddly. Head into the core EPrints libraries by typing cd /usr/share/<your-dir>/eprints/perl_lib/EPrints

@@ Line 5: / Line 5: @@
 Your development environment should ideally emulate your production environment as closely as possible - you may want to run a virtual machine through an application such as VirtualBox, or use a Linux install directly on your development device.
-== Step 1 - Install Git ==
+== Install Git ==
 In your development environment, open a terminal window.
@@ Line 11: / Line 11: @@
 To install Git, use '''sudo apt-get install git'''
-== Step 2 - Set up the directory ==
+== Set up the directory ==
 This is the directory we are going to clone the repository into and it needs to sit in ''/usr/share''. For example, you may want to call it ''eprints-git'', so use the command '''sudo mkdir /usr/share/eprints-git'''.
@@ Line 19: / Line 19: @@
 We now need to give ownership to the ''eprints'' user and ''www-data'' group. If you don't have an eprints user, you'll need to create one. Set ownership with '''sudo chown eprints:www-data <your-directory>'''.
-== Step 3 - Clone the repository ==
+== Clone the repository ==
 The first thing to do now is to change to your new eprints folder with '''cd <your-directory>'''. Now switch to your eprints user with '''sudo su eprints'''.
@@ Line 25: / Line 25: @@
 Let's clone the repository into here. Head off to the repository in your browser [http://github.com/eprints/eprints] and take a look at the right hand sidebar. There is a box with the ''HTTPS clone url'' in it - copy this URL and use it in the command '''git clone <the-url>''' on your command line. If all goes to plan, Git should now clone the repository into your directory!
-== Step 4 - Get your dev EPrints working ==
+== Get your dev EPrints working ==