This page is now obsolete.The up-to-date page can be found here.
|Calibre2opds User Guide|
Downloading and Installing Calibre2Opds
This section of the documentation covers the steps that are involved in getting Calibre2Opds installed on your system and ready to be used.
- Java Runtime Environment (JRE)
calibre2opds is written in the Java programming language. Therefore before you can use calibre2opds you need the Java runtime system installed. This tends to come as standard with Linux and Mac systems but not with Windows systems. The latest version of Java can always be obtained from the Java web site
- Calibre2opds installation package
which is available from Launchpad. Download links for the latest release are given below.
 Downloading calibre2opds
The latest production versions of calibre2opds are available for download at:
- calibre2opds-2.4.zip (All Platforms - Manual install)
- calibre2opds-2.4.jar (Linux)
- calibre2opds-2.4.exe (Windows)
- Mac dmg release package not ready yet - sorry !
Mac users can do a manual install from the ZIP packagage as specified here.
The latest BETA versions of calibre2opds are available for download at:
- calibre2opds-2.5-beta1.zip (All Platforms - Manual install)
- calibre2opds-2.5-beta1.jar (Linux)
- calibre2opds-2.5-beta1.exe (Windows)
- Mac dmg release package not ready yet - Sorry !
Mac users can do a manual install from the ZIP package as specified here.
You should download the version that is appropriate for the system on which you wish to install calibre2opds. The ZIP file version does not include installation program and requires manual installation steps. This can be appropriate on systems where the system specific installer does not work for some reason.
Go to the appropriate section for your operating system for more information on the steps needed to complete the installation.
 Installing calibre2opds
 Manual Install (All Platforms)
This version of the install should work on all systems, but it does require a number of manual steps and a little understanding of how to do things at the Operating System level.
The steps involved are:
- Unpack the calibre2opds ZIP file that has been downloaded to a folder of your choice.
- The calibre2opds GUI can now be started by running the appropriate rungui file. The rungui.cmd file should be used on Windows based systems, and the rungui.sh file on Linux or Mac based systems. These are simple text based command files so if you want to you can use a text editor to look at their (very simple) contents.
- You can then (optionally) set up a shortcut to run the calibre2opds program. The easiest thing to do is to set up a shortcut to the rungui files mentioned above to provide the appropriate setting for such shortcuts.
As an example the properties of a Menu shortcut for a Windows system might look like the following
although you will need to amend the paths shown if calibre2opds has not been installed into the "C:\Program Files\Calibre2Opds" folder.
The following steps are
- Unzip the downloaded file
- Run the install.sh script from the unzipped files.
The dialogs that are displayed during the install will look like those shown for the Windows install below.
As there are many variants of Linux, if you have any problems with the Linux specific install package of calibre2opds that is supplied, then you can try the Manual install method mentioned in the previous section which is operating system agnostic.
 Installing with an image disk
Install on the Mac is very easy
- Download the .dmg file as mentioned above
- Open the disk image and drag the application icon to your Applications folder.
 Adjusting memory
When running calibre2opds you may sometimes get an error message saying there is not enough memory to generate an image thumbnail.
If you have chosen a manual install, you can fix this by increasing java heapspace memory :
- locate calibre2opds script : run.sh
- change the command line inside the script like this : java -Xms512m -Xmx1024m -cp ./OpdsOutput-2.4-SNAPSHOT.jar Cli $*
( ajust memory values ( here 512 and 1024) if necessary.
Execute again run.sh to build the OPDS catalog.
If you did put your calibre library on a NAS disk, you should access your library using a file network protocole that supports locks. Otherwise calibre2opds won't be able to generate the OPDS catalog.
The following setup had been tested on Snow Leopard ( MacOS 10.6.X), using NFS to mount the NAS folder.
Suppose your calibre library is on NAS folder called /DataVolume/bibliotheque , shared through NFS with read/write access granted to everyone without authentication.
Open a terminal :
- list your NAS shares
> showmount -e nas_ip_address
Exports list on nas_ip_address:
- create a mount point ( for example /Volumes/bib )
- mount the NAS folder
> sudo mount -t nfs -o locallocks nas_ip_address:/DataVolume/bibliotheque /Volumes/bib/
If you prefer to use a graphical tool to mount the share see  . Don't forget to put locallocks in the options field.
 Upgrading with the ZIP package
To upgrade on a Mac using the ZIP package you use the "open package" Finder menu command on the Calibre2Opds application, and then replace all the files in the Contents/Resources/Java folder with the files in the ZIP archive.
You will then need to change the rungui.sh file so that is set to be an 'executable' file. To make it executable, open a terminal window and drag the icon of the folder where the file lives into the terminal window. That will cause the path to the folder to be displayed in the Terminal window.
Enter the command
(where thatpath is the path you saw from dragging the folder). This will leave you posisitoned in nthe folder containing the rungui.sh file. You now use the command
chmod +x rungui.sh
After that, double-clicking on rungui.sh will execute it as a shell command and it will start up calibre2opds.
NOTE: Some people have reported that they have problems running the Windows installer on 64-bit versions of Windows. If you have such a problem then the use the NOINSTALLER manual method based on the ZIP file.
The following steps show installing using the calibre2opds Windows package calibre2opds. on a Windows 7 system. Some of the details will differ slightly on earlier versions of windows and the dialogs displayed in the screenshots could look slightly different.
calibre2opds is supplied in the form of a Windows setup program. The exact name may vary according to the release, but is typically something like calibre2opds-2.2-WINDOWS.exe To start the install you run the calibre2opds-2.2-WINDOWS.exe file.
If you have not got Java installed then you will get an error message saying that windows does not know how to handle this file type.
When the install starts up if you are running under Windows Vista or Windows 7 you will get a warning dialog that looks like the one shown below. This is standard when installing software on Windows Vista or Windows 7. This dialog will not appear on Windows XP.
If you are running on Windows 7 and do not get this dialog, then you may have to right-click the .EXE file and select the "Run as Administrator" option for the install to be successful.
You are then asked to select the language to be used.
Once you have done that you are shown the welcome dialog.
Press Next to proceed. You are now shown the ReadMe pertinent to this release. This gives general background information about calibre2opds
Press Next to proceed. You are now shown the Release Notes pertinent to this release of calibre2opds. You are strongly advised to read them before you proceed.
calibre2opds. is licensed under the Open Software Foundation GPL license so this is displayed for you to read and accept.
You need to accept the license before you are allowed to proceed. Press Next to accept the license.
You are now asked to specify the install location for calibre2opds.
If the default is not what you want change it to the desired value. Press Next to proceed.
| On Windows 7 and Vista you may get warnings about not having relevant access permissions to the folder that you have specified should be used for installing calibre2opds.
If this occurs then create the desired program folder manually, and then set the access permissions so that ordinary users have Full Control.
If the folder already exist then a warning dialog is displayed:
This is standard if you are upgrading calibre2opds. Press Next to proceed.
You are now asked to confirm some details about the installation:
Set them to the desired values. Press Next to proceed.
| If the option to set "All users" to have the shortcut is not selectable
then this means you do not have Administrator privileges.
Installation of the calibre2opds. files will now start. While they are being installed a dialog like the following will be displayed:
When they have completed the following dialog will be displayed:
Press Done to exit the installation program.
calibre2opds. is now installed and ready to be used.