====== Installation ======

// This page refers to VuFind® 2.x and later; installation of earlier versions is no longer recommended. //

===== Getting Started =====

If you are new to VuFind®, you should start by reading the [[installation:notes|Installation Notes]] to orient yourself. You may also want to review VuFind®'s hardware and software [[installation:requirements]], and the [[administration:vufind_for_project_managers|VuFind® for Project Managers]] page.

For a broader introduction, try the [[https://github.com/vufind-org/learning-vufind-book|Learning VuFind®]] book or our [[:videos|Video Tutorials]].
===== Platform-Specific Documentation =====

VuFind® is designed to be able to be installed on many different platforms.
Choose from the following installation documents based on the platform of your choice:

  * [[installation:fedora|VuFind® on Fedora Linux]] (adaptable to RedHat flavors)
  * [[https://github.com/NatLibFi/NDL-VuFind2/wiki/VuFind-3-and-Later-with-MAMPStack-on-Mac-OS-X|VuFind® on Mac]] (external link; may not be completely up to date)
  * [[installation:ubuntu|VuFind® on Ubuntu Linux]] (adaptable to Debian flavors)
  * [[installation:windows|VuFind® on Windows]]

:!: The instructions above assume you will be downloading a packaged VuFind® release. If you prefer to install VuFind® directly from a [[https://github.com/vufind-org/vufind|GitHub]] checkout, check the [[https://github.com/vufind-org/vufind/blob/dev/README.md|README]] for additional instructions.

===== Going Live =====

Once the software is installed, be sure to review the [[administration:production_checklist|Production Checklist]] for some important things to consider prior to going live.

===== Upgrading VuFind® =====

  * [[installation:migration_notes|Migration Notes]]

===== Live DVD =====

Healthnet Nepal has pre-configured a live DVD with VuFind® and some other complementary open source applications at their Sourceforge pages: [[https://sourceforge.net/projects/livedvdvufindkohailsdspace/|32-bit version]], [[https://sourceforge.net/projects/livedvdvufindkohadspace/|64-bit version]]. This may be a useful way to evaluate the software with minimal effort.

===== Advanced Topics =====

  * [[installation:docker|Docker]] - VuFind® can be deployed using Docker
  * [[development:recommended_tools:git|Git]] - Git can be a useful way of managing and upgrading a local VuFind® installation.
  * [[installation:installing_multiple_instances|Installing Multiple Instances]] - If just one VuFind® isn't enough.
  * [[installation:php_oci|Installing the PHP OCI Driver for Oracle]] - How to connect to Oracle (required by Voyager and some other ILSes).
  * [[installation:nginx|Nginx]] - Notes on using Nginx in place of Apache
  * [[installation:remote_solr_back-end|Remote Solr Back-end]] - Note on installing Solr on a separate server from the rest of VuFind®
  * [[installation:vagrant|Vagrant]] - VuFind® can be installed in a Vagrant development environment

===== Documentation in Other Languages =====

  * [[http://wiki.ibict.br/index.php/Guia_de_Instala%C3%A7%C3%A3o|Portuguese]]

===== Related Video =====

See the [[videos:installation|Installation]] video for an overview of some of VuFind®'s installation options.