search

EVE-Tools / vagrant-element43

DEPRECATED - This repository contains the configuration of our unified virtual development environment.
1 stars 1 forks source link

readme

⚠️⚠️⚠️⚠️⚠️

This project is not maintained anymore! Please check here for alternatives. This repository is kept online for reference purposes only and can be taken offline/deleted any time.

⚠️⚠️⚠️⚠️⚠️

Vagrant for element43

This repository contains the configuration of our unified virtual development environment for element43. This has been tested on Windows 8.1 and Mac OS 10.11.1.

THIS VM IS DESIGNED FOR DEVELOPMENT USE ONLY - DO NOT MAKE IT ACCESSIBLE FROM THE INTERNET!

Installation Instructions

Windows users must install the GitHub Client for Windows first. Use the Git Shell for executing the commands listed below!

  1. Download this repository - click Download ZIP in the sidebar of this website and extract it somewhere (or simply git clone it)
  2. Get VirtualBox and install it
  3. Get and install Vagrant - restart your system, if asked
  4. Run vagrant plugin install vagrant-vbguest from command line. It will keep the VirtualBox guest additions on your VM up-to-date.
  5. In command line navigate to where you have extracted this repository and run vagrant up to download and run a basic Ubuntu 14.04 LTS VM
  6. Run vagrant ssh and then execute sudo sh /provisioning/bootstrap.sh - this will install the full Element43 stack in your VM
  7. Lean back and watch the magic happen - this might take up to a couple of hours
  8. ...
  9. Profit!

You'll be able to access your very own instance of element43 under http://127.0.0.1:8080! Remember to stop node-43via supervisord if you experience high CPU usage! Relevant logfiles are located at /var/log/element43. You can stop your VM with vagrant halt on your host system. Simply run vagrant up from within the vagrant-element43 directory to turn it on again.

Creating and activating an account

Create a new account as normal and obtain the activation link from the log located at /var/log/element43/element43.log. Replace the https://element-43.com/ part of the activation link with the appropriate address e.g. http://localhost:8080/. Open the link to activate your account. All e-mail 'sent' by the the dev instance will be written to the log file.

Simple File Access

The VM automatically creates a SMB share you can access via smb://10.0.13.37 or \\10.0.13.37 under Windows. Changes to node-43 and celery tasks require restarting the corresponding process via supervisord (see below).

Managing Services

All relevant services are managed by supervisord:

  1. Run vagrant ssh
  2. Run sudo supervisorctl
Service Autostart Purpose
element43:celery-element43 Yes Background task (e.g. EVE API udpates) worker process
element43:celerybeat-element43 Yes Background task scheduler
element43:django-element43 Yes Main web application server
element43:node-43 No EMDR market data collector (resource hungry)
element43:pathfind-element43 Yes Local EVE pathfinding service

Note: It is recommended to stop the element43:node-43 process after the first couple of hours.

Updating your VM

Run sudo ansible-playbook /provisioning/vagrant.yml -i /home/vagrant/hosts --connection=local via SSH. This will update your VM and local repositories.

Using your own repository

If you want to work on a fork of element43, edit the e43_repository line in provisioning/group_vars/vagrant and fill in your own repo's URL.

Resetting your VM

  1. Run vagrant destroy
  2. Repeat steps 5 to 7

Quick Reference

Recommended Host Hardware Specifications