Welcome to the Mushroom Observer Developer Startup system! The purpose of this system is to help software developers setup an environment where they can contribute to the Mushroom Observer code base. The basic idea is to setup a virtual machine (VM) on your personal ("host") machine that is configured to serve a test version of the Mushroom Observer website and to access the code. This system does require a reasonably powerful computer probably purchased in the last 3 years.
⚠️ The development team is using macOS. **If you are using Windows, some of the notes relate to older versions of the Developer System; they may be irrelevant to the current version or more recent versions of windows (example: ssh support is now built into most windows machines)
If you're interested in contributing your code to MO, please also read DEVELOPER-WORKFLOW.md. Administrators/Managers should also have a look at ADMIN-WORKFLOW.md.
From a clean Mac/PC to running the tests:
Install VirtualBox: https://www.virtualbox.org/
Install Vagrant: https://www.vagrantup.com/downloads.html
Install git: https://git-scm.com/downloads
In a Terminal shell:
git clone https://github.com/MushroomObserver/developer-startup.git
cd developer-startup
vagrant up
vagrant ssh
mo-dev /vagrant
cd /vagrant/mushroom-observer
rails lang:update
rails test
rails server -b 0.0.0.0
That should be it. If something did not work, then see below for a more detailed walk through which addresses the issues that have been reported.
Install VirtualBox: https://www.virtualbox.org/ (Windows Users: If you have Hyper-v enabled, which will be the case if you also have Docker or WSL2 installed, you must use VirtualBox 6.1.4+, as previous versions will not work with Hyper-V enabled.)
Install Vagrant: https://www.vagrantup.com/downloads.html
Install git: https://git-scm.com/downloads (some Mac users have found the GitHub GUI to be helpful, https://central.github.com/mac/latest)
If you are using Windows, it will be very helpful to select the option in the git installer to add the Unix tools to the Windows path. This will make accessing the virtual box via SSH much easier.
Get the developer-startup Git project:
git clone https://github.com/MushroomObserver/developer-startup.git
Go into the resulting directory:
cd developer-startup
vagrant up
Troubleshooting:
-
You might get an error message about VirtualBox not being able to start virtual machines. This means you may have to enable virtualization support on your computers BIOS, which is accessed during your computers power-on process.
-
If you see the error:
Stderr: VBoxManage.exe: error: RawFile#0 failed to create the raw output file /dev/null (VERR_PATH_NOT_FOUND) VBoxManage.exe: error: Details: code E_FAIL (0x80004005), component ConsoleWrap, interface IConsolethis can be resolved by disabling the serial port for the development VM from within the VirtualBox GUI. In VirtualBox select the development machine. Click Settings > Serial Ports. Uncheck Enable Serial Port for Port 1. Then run vagrant up again.
Login to your new VM:
% vagrant ssh
Older Windows machines may require installing an ssh client like
PuTTY. Attempting to run vagrant ssh will give you the parameters
you need to give to PuTTY.
Note: Windows 10 & 11 now have built in ssh support. You can see if this feature is enabled by typing "ssh" into the command prompt.
Note: if you have Git installed with the Unix tools you will not need to install PuTTY.
You have been successful if the final output line is:
vagrant@vagrant:~$
If you are using ssh to connect with github, you'll need a private key is ~/.ssh on the VM whose public key is registered with github. You can either generate a new key pair with:
$ ssh-keygen -f /home/vagrant/.ssh/id_rsa -N ''
and accepting all the defaults. You then need to add ~/.ssh/id_rsa.pub to your SSH Keys in your github settings. You can also reuse an existing private key by copying it to the developer-startup directory on the host machine. Assuming the key is called id_rsa, on the VM run:
$ mkdir ~/.ssh
$ chmod 700 ~/.ssh
$ mv /vagrant/id_rsa ~/.ssh
$ chmod 600 ~/.ssh/id_rsa
$ mo-dev /vagrant
Note: You can give mo-dev any directory on the VM you want. The advantage of using /vagrant is that the MO source code will be available both on the VM and on the host machine in the same directory as the Vagrantfile. This is handy if you want to edit MO files on your host machine with your normal editor. However, it usually makes the tests run more slowly on the VM. Another common option is to just use:
$ mo-dev .
and use Linux editors such as vi or emacs. The rest of this document assumes that you used /vagrant when calling mo-dev.
*Gotcha for Windows users:
You may need to update the the "guest additions" on the VM in order for 'folder sharing' to work. If you are unable to see any files in the /vagrant directory on the VM, then run this command on your host.
> vagrant plugins update vbguest
The default database on developer-startup is very minimal. If you'd like to use a more recent copy of the live database locally, you'll need to request a zipped database file from MO developers. Download checkpoint_stripped.gz and place it in your /developer-startup directory on your local machine. Then, after bringing vagrant up, execute the following commands from within the Vagrant box:
$ cd /vagrant
$ ls
Be sure checkpoint_stripped.gz is listed in the directory. Then:
$ gunzip -c checkpoint_stripped.gz | mysql -u mo -pmo mo_development
Assuming all of that was successful, you now have a running virtual machine with the MO source code installed, an instance of MySQL and all the goodies to successfully run all the tests and startup a local server (see below). You access the new machine by being in the developer-startup directory and running 'vagrant ssh' or through Putty. The new instance of MySQL can be accessed with usernames/passwords mo/mo or root/root.
Go to the VM ('vagrant ssh' or through Putty)
$ cd /vagrant/mushroom-observer
$ rails test
Note if the VM has been inactive for a while or you know additional changes have been added to the source code repository, you may want to re-run mo-dev using the directory containing the mushroom-observer directory. This will run standard things like 'git pull', 'bundle install', run any pending database migrations, and make sure your lang files are up to date.
Go to VM (vagrant ssh or through PuTTY)
$ cd /vagrant/mushroom-observer
$ rails db:schema:load
$ rails db:fixtures:load
$ rails lang:update
Start the Rails server on the VM
$ rails server -b 0.0.0.0
Go to http://localhost:3000 in a browser on the host machine. (Note: one developer reports that port-forwarding required use of port 5656 instead of 3000)
Go to http://localhost:3000/account/signup and create a new user in your regular browser
Go to VM (vagrant ssh or through PuTTY):
$ grep verify /vagrant/mushroom-observer/log/development.log
Note: this information can also be found on the host machine by looking in develop-startup/mushroom-observer/log/development.log
Go to verification URL in your browser
Have fun! (Note the initial database, developer-startup/init.sql, just has the admin user and the language stuff. It probably makes sense to add some observations, names and images for testing, but we haven't gotten to it yet.)
To contribute to MO code development, please follow the suggestions in DEVELOPER-WORKFLOW.md.
If something goes wrong or you simply want to start over from scratch, on the host machine run:
% vagrant destroy
% rm -rf mushroom-observer
% vagrant up
and continue as above after the original vagrant up.
If for some reason the VM created using the ./startup does not work or it gets outdated and you wish to refresh it, you can build a new VM from scratch. First, you may want to update the base box in the Vagrantfile. Once you have the base box you want, run:
% vagrant up clean
Once the VM is setup, you should create a new version of the box with:
% vagrant package clean
This will create a package.box file in the developer-startup directory. To allow others to use it, this should get uploaded to https://images.mushroomobserver.org and placed in the web root directory under a distinct name. Finally, the Vagrantfile should be updated to reference the new box and checked in.
Other developers should now be able to get the upgraded box by simply updating their local developer-startup repo and running:
% vagrant destroy
% vagrant up
They may also want to get rid of any old boxes by running:
% vagrant box list
% vagrant box remove [boxname]