28. Upgrade instructions for Book Library, Joomla elibrary solution
In this article you will find the instructions on how to upgrade from a previous version of Book Library (Joomla elibrary solution) while still preserving all your existing Book Library data.
When you make Full export, all lend record can be lost. Please save them.
General Guidelines (common sense)
- Always test upgrades first in a test environment, never in your live environment
- Always make sure you have a good, recent backup before making changes
- Make regular XML exports of all categories in your Book Library installation (to preserve your book entries)
Recommended Upgrade Procedure of Book Library, Joomla elibrary solution
Fresh installation
- Make XML exports of every category in your current live installation, and save with the category name
- Copy your book covers, ebooks, media to a local directory from
/components/com_booklibrary/covers
/components/com_booklibrary/ebooks
/components/com_booklibrary/media
- Install Book Library Free Edition in a test environment
- Delete existing books and categories in the test environment
- Recreate each category, the same as in your live environment, in the test environment
- Import all XML exports made earlier into the appropriate categories
- Copy your book covers, ebooks, media from the local directory to
/components/com_booklibrary/covers
/components/com_booklibrary/ebooks
/components/com_booklibrary/media
- Set the rights on the covers to 0644
- Set all config settings as in your live environment
- TEST and TEST again
If all is OK, then (and only then) proceed to repeat the procedure in your live environment.
Replacing the files in your installation
If you decide to overwrite the files in your existing installation instead (not really recommended), then follow the guidelines below.
If you DO NOT have shell access (command line) to your server through SSH (e.g. shared hosting):
- unzip the patch files somewhere
- use Quixplorer, eXtplorer, Joomla internal FTP, or similar inside Joomla
- using these tools, copy the original files somewhere or rename them (e.g. with date behind them)
- delete the original files
- upload the new files to the proper directories using Quixplorer, eXtplorer (or Joomla internal FTP)
- file ownership for the new files is automatically set right because you work inside Joomla
- set the file rights on the new files to 0644 (= read/write by owner, read by group, read by others)
ONLY use the method below if you have shell access to your server through SSH:
- unzip the patch files somewhere
- copy the original files somewhere or rename them (e.g. with date behind them)
- delete the original files
- upload the new files to the proper directories using an FTP client like FileZilla or CuteFTP or similar
- set the file ownership for the newly uploaded files to the account your web server runs under (find out first!)
- set the file rights on the new files to 0644 (= read/write by owner, read by group, read by others)
For upgrade from yours Book Library 2.x version to Book Library version without lost data you need:
- full save the files and folders:
{yours site}/administrator/components/com_booklibrary
{yours site}/administrator/com_booklibrary
- do full books export
- remove the files and folders:
{yours site}/administrator/components/com_booklibrary
{yours site}/administrator/com_booklibrary
and do install components from Book Library.
- then recover folders:
{yours site}/administrator/com_booklibrary/ebooks
{yours site}/administrator/com_booklibrary/covers
{yours site}/administrator/com_booklibrary/media
Also you will need upgrade all plugin and modules.
For upgrade from Book Library Basic 2.x version to Book Library Pro without lost data you need:
- full save the files and folders:
{yours site}/administrator/components/com_booklibrary
{yours site}/administrator/com_booklibrary
- do full books export.
- go to [Book Library] [Settings Backend] and set [Update] to “YES”
- Then uninstall Basic component and install Pro version.
Upgrade Instructions from previous Book Library versions
To keep your Book Library books data when upgrading from a previous version (deinstall-reinstall), please follow the instructions below. This will restore all existing book data (including descriptions and reviews) to your new Book Library installation.
- Using FTP client or similar, copy the book covers from /components/com_booklibrary/covers/ somewhere safe.
- Write down your category and subcategory names and structure.
- IMPORTANT! To keep all your edited book descriptions in the new Book Library, make very sure you set [Information from] for EVERY single book to "On your own".
- Do XML exports (do NOT use CSV for this!) from each of your book categories. Right-click the XML-url and save with the category name.
- Repeat the process until you have XML exports for all your categories somewhere safe.
- Deinstall the old version of Book Library.
- Install Book Library with the Joomla component installer.
- Recreate each of your categories and subcategories using the Book Library Category Manager.
IMPORTANT! If you want to keep your original book descriptions, please do the following. In Configuration Backend set the Default Host to "On your own".
- Import each of the exports you made earlier into the proper book categories.
- Copy the previously saved book covers to /components/com_booklibrary/covers/
- Set the rights on the covers you just copied to 0644
- Set options in Settings Backend and Settings Frontend. There are quite a few new options, so please check them.
- Publish the books in Book Manager.
- Your frontend will now have all Categories and the books in them again with all the original data.
WARNING / IMPORTANT:
As mentioned, Book Library Shop now also fetches Book Descriptions (Editorial Reviews) from Amazon. This means that whenever you do Refetch Information for a book from Amazon, your edited Book Description will get overwritten! To avoid this, set books (after editing your descriptions) to "On your own" in the Edit Book interface for each book. This will prevent changes to your book details.
The current versions of Book Library, Joomla elibrary solution, also supports Full XML exports, so future upgrades will be relatively painless. Still, we recommend using the XML export-import method, as it gives you much greater control over what goes where in your new installation.
Total backups within the same Book Library version