About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
installation:vagrant

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
installation:vagrant [2023/04/14 16:39] – [Setting Up the Virtual Machine] demiankatzinstallation:vagrant [2023/04/14 16:45] demiankatz
Line 1: Line 1:
 ====== Vagrant ====== ====== Vagrant ======
  
-[[http://www.vagrantup.com/|Vagrant]] is a tool for managing consistent development environments. While it is not intended for production use, VuFind developers may find it helpful for quickly setting up a VuFind system, and it may also be useful for evaluation purposes.+[[http://www.vagrantup.com/|Vagrant]] is a tool for managing consistent development environments. While it is not intended for production use, VuFind® developers may find it helpful for quickly setting up a VuFind® system, and it may also be useful for evaluation purposes.
  
 ===== Getting Started ===== ===== Getting Started =====
  
-Starting with VuFind 4.1, the software ships with a default Vagrantfile that will get an instance of VuFind running on an Ubuntu image.+The software ships with a default Vagrantfile that will get an instance of VuFind® running on an Ubuntu image (since release 4.1).
  
 ==== Setting Up the Virtual Machine ==== ==== Setting Up the Virtual Machine ====
  
-To get started, make sure that [[http://www.vagrantup.com/|Vagrant]] is installed on your system, then simply go to your VuFind directory (preferably a fresh, clean checkout from [[development:recommended_tools:git|Git]] with Composer dependencies already installed, if you're just getting started) and run:+To get started, make sure that [[http://www.vagrantup.com/|Vagrant]] is installed on your system, then simply go to your VuFind® directory (preferably a fresh, clean checkout from [[development:recommended_tools:git|Git]] with Composer dependencies already installed, if you're just getting started) and run:
  
   vagrant up   vagrant up
  
-This will take quite some time to install and set up everything. Once the installation completes, VuFind's web interface will be visible on the host machine's port 4567.+This will take quite some time to install and set up everything. Once the installation completes, VuFind®'s web interface will be visible on the host machine's port 4567.
  
 You will have to do a bit of manual work to get everything running.... You will have to do a bit of manual work to get everything running....
Line 42: Line 42:
 ==== Notes on File Mapping / Locations ==== ==== Notes on File Mapping / Locations ====
  
-Your host machine'VuFind directory will be mounted within the Vagrant SSH session as /vagrant. Any changes you make there will affect your host machine as well (and vice versa).+Your host machine'VuFind® directory will be mounted within the Vagrant SSH session as /vagrant. Any changes you make there will affect your host machine as well (and vice versa).
  
 Because Apache does not have write access to the special mounted /vagrant directory, the system is using /vufindlocal as its $VUFIND_LOCAL_DIR; these files are only accessible from within the VM. You will have to use "vagrant ssh" to log in and examine/modify them. Because Apache does not have write access to the special mounted /vagrant directory, the system is using /vufindlocal as its $VUFIND_LOCAL_DIR; these files are only accessible from within the VM. You will have to use "vagrant ssh" to log in and examine/modify them.
Line 54: Line 54:
   * vagrant destroy - completely destroy the VM; you will have to reinstall it (see above) if you want it back.   * vagrant destroy - completely destroy the VM; you will have to reinstall it (see above) if you want it back.
  
-===== Other Options ===== 
  
-If you are on a version of VuFind older than 4.1, or if you want to explore other options, here are some other VuFind/Vagrant options: 
- 
-  * Mark A. Duffy has contributed a VuFind 2.x Vagrant configuration [[https://vagrantcloud.com/markaduffy/vufind_2x|on this page]]. 
-  * An alternative, puppet-configured option that runs directly off a clone of the VuFind 2.x git repository is available [[https://github.com/quartsize/vufind-vagrant|here]]. 
 ---- struct data ---- ---- struct data ----
 properties.Page Owner :  properties.Page Owner : 
 ---- ----
  
installation/vagrant.txt · Last modified: 2024/02/08 18:23 by demiankatz