Installing refbase - Revision history

WikiSysop: Update FTP download link for refbase RPM

2023-11-05T19:46:06Z

Update FTP download link for refbase RPM

← Older revision		Revision as of 21:46, 5 November 2023
Line 39:		Line 39:
	=== Mandrake/Mandriva Linux ===		=== Mandrake/Mandriva Linux ===

	[https://pkgs.org/download/refbase refbase RPMs] are available. RPMs for refbase-0.9.5 are available e.g. ~~[ftp://ftp.free.fr/mirrors/ftp.mandriva.com/MandrivaLinux/devel/cooker/cooker/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here] and~~ [ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/MandrivaLinux/devel/cooker/i586/media/contrib/release/refbase-0.9.5-~~1mdv2009~~.1.noarch.rpm here]. To install the refbase RPM, use ''urpmi'' or ''rpmdrake'':		[https://pkgs.org/download/refbase refbase RPMs] are available. RPMs for refbase-0.9.5 are available e.g. [ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/MandrivaLinux/devel/cooker/i586/media/contrib/release/refbase-0.9.5-2mdv2010.0.noarch.rpm here]. To install the refbase RPM, use ''urpmi'' or ''rpmdrake'':

	$ urpmi refbase		$ urpmi refbase

WikiSysop: Change again link for Mandriva refbase RPMs

2023-11-05T19:36:47Z

Change again link for Mandriva refbase RPMs

← Older revision		Revision as of 21:36, 5 November 2023
Line 39:		Line 39:
	=== Mandrake/Mandriva Linux ===		=== Mandrake/Mandriva Linux ===

	[https://~~rpmfind~~.~~net~~/~~linux~~/~~rpm2html/search.php?query=~~refbase refbase RPMs] are available. RPMs for refbase-0.9.5 are available e.g. [ftp://ftp.free.fr/mirrors/ftp.mandriva.com/MandrivaLinux/devel/cooker/cooker/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here] and [ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/MandrivaLinux/devel/cooker/i586/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here]. To install the refbase RPM, use ''urpmi'' or ''rpmdrake'':		[https://pkgs.org/download/refbase refbase RPMs] are available. RPMs for refbase-0.9.5 are available e.g. [ftp://ftp.free.fr/mirrors/ftp.mandriva.com/MandrivaLinux/devel/cooker/cooker/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here] and [ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/MandrivaLinux/devel/cooker/i586/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here]. To install the refbase RPM, use ''urpmi'' or ''rpmdrake'':

	$ urpmi refbase		$ urpmi refbase

WikiSysop: Update link to Gentoo refbase package

2023-11-05T18:21:04Z

Update link to Gentoo refbase package

← Older revision		Revision as of 20:21, 5 November 2023
Line 33:		Line 33:
	=== Gentoo Linux ===		=== Gentoo Linux ===

	[http://www.gentoo.org/ Gentoo] has an [https://~~gentoobrowse~~.~~randomdan~~.~~homeip.net~~/packages/app-text/refbase ebuild of refbase] in [https://wiki.gentoo.org/wiki/Portage portage], so you can merely:		[http://www.gentoo.org/ Gentoo] has an [https://packages.gentoo.org/packages/app-text/refbase ebuild of refbase] in [https://wiki.gentoo.org/wiki/Portage portage], so you can merely:

	$ emerge refbase		$ emerge refbase

WikiSysop: Update external links and remove dead links/info

2023-11-05T16:59:18Z

Update external links and remove dead links/info

← Older revision		Revision as of 18:59, 5 November 2023
Line 21:		Line 21:
	=== Install refbase via ''install.php'' ===		=== Install refbase via ''install.php'' ===

	Point your web browser to ''install.php'', and fill out and submit the install form~~(*)~~ to complete the installation process.		Point your web browser to ''install.php'', and fill out and submit the install form to complete the installation process.

	~~(*) In case you're curious, the install form looks [http://beta.refbase.net/install.php like this]~~.

	Note that the install script currently requires a user with full access to the ''mysql'' database (more info [[#Additional_web-install_requirements\|below]]). I.e., if you're trying to install refbase on a shared host with limited MySQL access privileges, you may need to perform a [[#Manual_installation\|manual installation]] instead.		Note that the install script currently requires a user with full access to the ''mysql'' database (more info [[#Additional_web-install_requirements\|below]]). I.e., if you're trying to install refbase on a shared host with limited MySQL access privileges, you may need to perform a [[#Manual_installation\|manual installation]] instead.
Line 35:		Line 33:
	=== Gentoo Linux ===		=== Gentoo Linux ===

	[http://www.gentoo.org/ Gentoo] has an ebuild of refbase in [~~http~~://gentoo~~-portage~~.~~com~~/~~app-text~~/~~refbase~~ portage], so you can merely:		[http://www.gentoo.org/ Gentoo] has an [https://gentoobrowse.randomdan.homeip.net/packages/app-text/refbase ebuild of refbase] in [https://wiki.gentoo.org/wiki/Portage portage], so you can merely:

	$ emerge refbase		$ emerge refbase

	=== Mandrake/Mandriva Linux ===		=== Mandrake/Mandriva Linux ===

	[~~http~~://~~club~~.~~mandriva.com~~/~~xwiki~~/~~bin/view/rpms/Application~~/refbase refbase RPMs] are available. RPMs for refbase-0.9.5 are available e.g. [ftp://ftp.free.fr/mirrors/ftp.mandriva.com/MandrivaLinux/devel/cooker/cooker/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here] and [ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/MandrivaLinux/devel/cooker/i586/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here]. To install the refbase RPM, use ''urpmi'' or ''rpmdrake'':		[https://rpmfind.net/linux/rpm2html/search.php?query=refbase refbase RPMs] are available. RPMs for refbase-0.9.5 are available e.g. [ftp://ftp.free.fr/mirrors/ftp.mandriva.com/MandrivaLinux/devel/cooker/cooker/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here] and [ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/MandrivaLinux/devel/cooker/i586/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here]. To install the refbase RPM, use ''urpmi'' or ''rpmdrake'':

	$ urpmi refbase		$ urpmi refbase

	then finish the installation by pointing your web browser to <code><nowiki>http://localhost/refbase/install.php</nowiki></code>		then finish the installation by pointing your web browser to <code><nowiki>http://localhost/refbase/install.php</nowiki></code>

	~~=== Virtual machine ===~~

	You may use the gratis [http://www.vmware.com/products/player/ VMware Player] with a [http://www.vmware.com/appliances/directory/1272 refbase virtual appliance] (hosted by [http://arc.nucapt.northwestern.edu NUCAPT]).

	~~=== WOS Portable ===~~

	Windows users can download the free and open source [http://www.chsoftware.net/en/useware/wos/wos.htm WOS Portable] to have an Apache/MySQL/PHP stack (which can even be run from a USB stick). The refbase package can reportedly be downloaded from their premium site. Non-members can download [http://arc.nucapt.northwestern.edu/~karnesky/refbase/refbase.wos the refbase WOS package] from [http://arc.nucapt.northwestern.edu NUCAPT].

	== Installation Troubleshooting ==		== Installation Troubleshooting ==
Line 74:		Line 65:
	== Additional web-install requirements ==		== Additional web-install requirements ==

	In order to run the ''install.php'' script as described above, you will need a MySQL username with permission to modify the database named ''mysql'' which stores the MySQL [~~http~~://dev.mysql.com/doc/refman/5.0/en/~~what~~-~~privileges~~.html user privilege] information. This is since the refbase install script adds a dedicated MySQL user to the ''mysql'' database which will be used with your refbase application ([[Add MySQL User\|more info]]).		In order to run the ''install.php'' script as described above, you will need a MySQL username with permission to modify the database named ''mysql'' which stores the MySQL [https://dev.mysql.com/doc/refman/8.0/en/privileges-provided.html user privilege] information. This is since the refbase install script adds a dedicated MySQL user to the ''mysql'' database which will be used with your refbase application ([[Add MySQL User\|more info]]).

	Some shared hosts do not provide MySQL usernames with the required permissions, but instead provide alternate interfaces for MySQL username administration such as a web-based control center. If you face this restriction, you will need to perform a [[#Manual_installation\|manual installation]].		Some shared hosts do not provide MySQL usernames with the required permissions, but instead provide alternate interfaces for MySQL username administration such as a web-based control center. If you face this restriction, you will need to perform a [[#Manual_installation\|manual installation]].

WikiSysop: Hide section edit links

2023-10-26T13:51:42Z

Hide section edit links

← Older revision		Revision as of 15:51, 26 October 2023
Line 79:		Line 79:

	[[Category:Installation]]		[[Category:Installation]]
			__NOEDITSECTION__

WikiSysop: Original page content from 27-Nov-2008

2023-10-26T13:51:10Z

Original page content from 27-Nov-2008

New page

This document describes how to install refbase.

== Web-based installation ==

This section describes how to install refbase using the install script (''install.php'') that comes with the refbase package. Alternative installation methods are described [[#Alternative_installation_methods|below]]. See the 'INSTALL' file that comes with the refbase package for latest information regarding the installation process.

=== Check requirements ===

Please make sure that your server meets the [[Requirements|requirements]].

=== Download and install scripts ===

[http://sourceforge.net/project/showfiles.php?group_id=64647 Download] the latest stable release version (or, alternatively, get the latest development version of refbase from the refbase [[SVN_version|SVN repository]]). Then, unpack the download archive (if necessary) and copy all refbase scripts to your server's web directory.

Additionally, you may want to download [[Bibutils]] and copy the binaries to an executable path. Bibutils provides additional import and export funtionality to refbase (e.g. support for Endnote & BibTeX). It is optional, but highly recommended.

=== Configure database settings ===

Please be sure to [[Database_configuration|configure important database settings]] prior to installation. While you might be able to use the refbase package without modifying the default settings, we highly recommend not to use the default values.

=== Install refbase via ''install.php'' ===

Point your web browser to ''install.php'', and fill out and submit the install form(*) to complete the installation process.

(*) In case you're curious, the install form looks [http://beta.refbase.net/install.php like this].

Note that the install script currently requires a user with full access to the ''mysql'' database (more info [[#Additional_web-install_requirements|below]]). I.e., if you're trying to install refbase on a shared host with limited MySQL access privileges, you may need to perform a [[#Manual_installation|manual installation]] instead.

== Alternative installation methods ==

=== Manual installation ===

If you're experiencing problems with the web-based installation you can try a [[manual installation]] instead.

=== Gentoo Linux ===

[http://www.gentoo.org/ Gentoo] has an ebuild of refbase in [http://gentoo-portage.com/app-text/refbase portage], so you can merely:
$ emerge refbase

=== Mandrake/Mandriva Linux ===

[http://club.mandriva.com/xwiki/bin/view/rpms/Application/refbase refbase RPMs] are available. RPMs for refbase-0.9.5 are available e.g. [ftp://ftp.free.fr/mirrors/ftp.mandriva.com/MandrivaLinux/devel/cooker/cooker/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here] and [ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/MandrivaLinux/devel/cooker/i586/media/contrib/release/refbase-0.9.5-1mdv2009.1.noarch.rpm here]. To install the refbase RPM, use ''urpmi'' or ''rpmdrake'':

$ urpmi refbase

then finish the installation by pointing your web browser to <code><nowiki>http://localhost/refbase/install.php</nowiki></code>

=== Virtual machine ===

You may use the gratis [http://www.vmware.com/products/player/ VMware Player] with a [http://www.vmware.com/appliances/directory/1272 refbase virtual appliance] (hosted by [http://arc.nucapt.northwestern.edu NUCAPT]).

=== WOS Portable ===

Windows users can download the free and open source [http://www.chsoftware.net/en/useware/wos/wos.htm WOS Portable] to have an Apache/MySQL/PHP stack (which can even be run from a USB stick). The refbase package can reportedly be downloaded from their premium site. Non-members can download [http://arc.nucapt.northwestern.edu/~karnesky/refbase/refbase.wos the refbase WOS package] from [http://arc.nucapt.northwestern.edu NUCAPT].

== Installation Troubleshooting ==

A list of possible problems and their solutions can be found in the [[Installation-Troubleshooting]] section.

== Installation over an existing database ==

In the install form, you will find a cautionary note:

Note that, if there's already an existing database with the name specified
in $databaseName, clicking the Install button will overwrite ALL data in that
database!

Actually, this note is only true if you're installing into an '''existing refbase database'''. The refbase ''install.php'' script will NOT delete an existing database but will only overwrite those [[MySQL tables|tables]] in the specifed database that have names identical to the ones used by refbase. refbase table names are specified in files ''initialize/db.inc.php'' & ''install.sql'' (or ''update.sql'') and can be changed there to avoid any name conflicts with existing tables.

In other words, if the table names in your existing database don't conflict with the table names used by refbase (or if you rename the refbase table names in ''db.inc.php'' AND in ''install.sql'' '''prior to installation''' so that they don't conflict with existing table names), then you should be able to use ''install.php'' for installation of refbase into any existing database.

However, it is a very good idea to make a [[Backup the database|full backup]] of your existing database prior to installation. Also, it may be worth to first do some testing with a non-critical database copy.

== Additional web-install requirements ==

In order to run the ''install.php'' script as described above, you will need a MySQL username with permission to modify the database named ''mysql'' which stores the MySQL [http://dev.mysql.com/doc/refman/5.0/en/what-privileges.html user privilege] information. This is since the refbase install script adds a dedicated MySQL user to the ''mysql'' database which will be used with your refbase application ([[Add MySQL User|more info]]).

Some shared hosts do not provide MySQL usernames with the required permissions, but instead provide alternate interfaces for MySQL username administration such as a web-based control center. If you face this restriction, you will need to perform a [[#Manual_installation|manual installation]].

[[Category:Installation]]