Difference between revisions of "EPrints Live CD Help"

From EPrints Documentation
Jump to: navigation, search
m
(Preserving your archive to use with the live cd)
Line 3: Line 3:
 
The EPrints3 Live CD is designed to help you experience EPrints without the need for a machine to run it on. The CD comes complete with a fully installed EPrints3 distribution which also has our own training archive already set up. From the environment the CD provides you can harness the full power of EPrints3 to setup your own archives for testing and also have an easy way to test new EPrints functionality without putting your active archive at risk.  
 
The EPrints3 Live CD is designed to help you experience EPrints without the need for a machine to run it on. The CD comes complete with a fully installed EPrints3 distribution which also has our own training archive already set up. From the environment the CD provides you can harness the full power of EPrints3 to setup your own archives for testing and also have an easy way to test new EPrints functionality without putting your active archive at risk.  
  
For new repository maintainers the Live CD can also be one click installed permanently onto your hard drive. This will enable you to preserve changes to your archives between reboots.
+
For new repository maintainers the Live CD can also be one click installed permanently onto your hard drive. This will enable you to preserve changes to your archives between reboots (without needing to use a memory stick).
  
 
The Live CD really does provide the all in one solution for experiencing EPrints repository management software.  
 
The Live CD really does provide the all in one solution for experiencing EPrints repository management software.  
Line 12: Line 12:
  
 
The live CD is based upon the [http://www.ubuntu.com Ubuntu Linux Live CD] with Open Office removed to make available the space to install EPrints + all its dependencies whilst still remaining small enough to fit on a single CD.
 
The live CD is based upon the [http://www.ubuntu.com Ubuntu Linux Live CD] with Open Office removed to make available the space to install EPrints + all its dependencies whilst still remaining small enough to fit on a single CD.
 
*Coming Soon*
 
 
Store your archive on a memory stick and preserve the contents of your archive between boots of the Live CD.
 
  
 
= Using the LIVE CD (Start Here) =
 
= Using the LIVE CD (Start Here) =
Line 36: Line 32:
 
* To enable the training archive:
 
* To enable the training archive:
 
   sudo echo "127.0.0.1 training.eprints.org training" >> /etc/hosts.conf
 
   sudo echo "127.0.0.1 training.eprints.org training" >> /etc/hosts.conf
 +
 +
= Storing your Archive on a Memory Stick =
 +
 +
By using the live cd, any changes made will be lost when the system is shut down to avoid this we have created some scripts which backup your archive onto a memory stick.
 +
 +
These scripts should be stored somewhere on the memory stick and the files are stored in a folder called "live_cd" relative to the position to the scripts.
 +
 +
== Backing up your archive to memory stick ==
 +
 +
Extract [http://www.eprints.org/files/eprints3/mem_key/mem_key.zip this file] onto your memory stick and execute as root:
 +
  root@ubuntu$ bash archive_to_usb.sh archive_name
 +
 +
=== Script Details ===
 +
 +
The script backs up both your archive and the related database by doing the following, it assumes you have not set a root password  on the mysql database:
 +
 +
  #!/bin/bash
 +
  if [ "$1" = "" ]
 +
  then
 +
    echo "No Archive Specified"
 +
  else
 +
    FOO=`pwd`
 +
    mkdir $FOO/live_cd
 +
    rm -fR $FOO/live_cd/$1
 +
    mkdir $FOO/live_cd/$1
 +
    tar -cf $FOO/live_cd/$1/$1.tar /usr/share/eprints3/archives/$1
 +
    mysqldump -u root $1 > $FOO/live_cd/$1/$1.sql
 +
    echo "DONE"
 +
  fi
 +
 +
== Restoring your archive from memory stick ==
 +
 +
Don't forget to follow the step above to configure ePrints to run from the live cd first!
 +
 +
Locate the place where you extracted the files to previously on your memory stick and as root:
 +
  root@ubuntu$ bash usb_to_archive.sh archive_name
 +
 +
=== Script Details ===
 +
 +
Pretty much the opposite of the other script:
 +
  #!/bin/bash
 +
  if [ "$1" = "" ]
 +
  then
 +
    echo "No Archive Specified"
 +
  else
 +
    FOO=`pwd`
 +
    rm -fR /usr/share/eprints3/archives/$1
 +
    tar -xf live_cd/$1/$1.tar -C /
 +
    echo "drop database $1" | mysql -u root
 +
    echo "create database $1" | mysql -u root
 +
    mysql -u root $1 < live_cd/$1/$1.sql
 +
    echo "DONE"
 +
  fi
  
 
= Troubleshooting =
 
= Troubleshooting =

Revision as of 13:26, 6 September 2007

Introduction

The EPrints3 Live CD is designed to help you experience EPrints without the need for a machine to run it on. The CD comes complete with a fully installed EPrints3 distribution which also has our own training archive already set up. From the environment the CD provides you can harness the full power of EPrints3 to setup your own archives for testing and also have an easy way to test new EPrints functionality without putting your active archive at risk.

For new repository maintainers the Live CD can also be one click installed permanently onto your hard drive. This will enable you to preserve changes to your archives between reboots (without needing to use a memory stick).

The Live CD really does provide the all in one solution for experiencing EPrints repository management software.

The CD is currently only available for the x86 (32-bit) platforms and is based upon the Ubuntu Linux distribution.

Development News

The live CD is based upon the Ubuntu Linux Live CD with Open Office removed to make available the space to install EPrints + all its dependencies whilst still remaining small enough to fit on a single CD.

Using the LIVE CD (Start Here)

  • Download the image (Documentation#Download) and burn it to a cd using your favorite cd writing application. (Make cup of tea)
  • Boot PC from the CD. (Drink cup of tea)
  • To prepare EPrints to run from the Live CD open a terminal (available from Applications->Accessories) and type the following:
 sudo setup_eprints_live
  • Open Firefox or similar browser and navigate to http://training.eprints.org (which is linked to your local machine, no net connection required)

To Install From the Live CD

DO NOT RUN the setup_eprints_live application during this process.

  • From a clean boot into the Live CD click the install icon. (Go make fresh coffee from ungrounded coffee beans)
  • Once installed and running from your hard drive execute the following from within a terminal:
 sudo touch /etc/apache2/httpd.conf
 sudo apache2ctl stop
 sudo apache2crl start
  • To enable the training archive:
 sudo echo "127.0.0.1 training.eprints.org training" >> /etc/hosts.conf

Storing your Archive on a Memory Stick

By using the live cd, any changes made will be lost when the system is shut down to avoid this we have created some scripts which backup your archive onto a memory stick.

These scripts should be stored somewhere on the memory stick and the files are stored in a folder called "live_cd" relative to the position to the scripts.

Backing up your archive to memory stick

Extract this file onto your memory stick and execute as root:

 root@ubuntu$ bash archive_to_usb.sh archive_name

Script Details

The script backs up both your archive and the related database by doing the following, it assumes you have not set a root password on the mysql database:

 #!/bin/bash
 if [ "$1" = "" ]
 then
   echo "No Archive Specified"
 else
   FOO=`pwd`
   mkdir $FOO/live_cd
   rm -fR $FOO/live_cd/$1
   mkdir $FOO/live_cd/$1
   tar -cf $FOO/live_cd/$1/$1.tar /usr/share/eprints3/archives/$1
   mysqldump -u root $1 > $FOO/live_cd/$1/$1.sql
   echo "DONE"
 fi

Restoring your archive from memory stick

Don't forget to follow the step above to configure ePrints to run from the live cd first!

Locate the place where you extracted the files to previously on your memory stick and as root:

 root@ubuntu$ bash usb_to_archive.sh archive_name

Script Details

Pretty much the opposite of the other script:

 #!/bin/bash
 if [ "$1" = "" ]
 then
   echo "No Archive Specified"
 else
   FOO=`pwd`
   rm -fR /usr/share/eprints3/archives/$1
   tar -xf live_cd/$1/$1.tar -C /
   echo "drop database $1" | mysql -u root
   echo "create database $1" | mysql -u root
   mysql -u root $1 < live_cd/$1/$1.sql
   echo "DONE"
 fi 

Troubleshooting

If you find any problems with the CD please contact myself (David Tarrant) dct05r[at]ecs.soton.ac.uk.

Any problems with the EPrints software should be referred to the EPrints development team.