search

joshuaswarren / magescotch

A Magento 1 + Magento 2 ready development environment based on Scotch Box
55 stars 16 forks source link

readme

MageScotch Box

This is the PHP 7-based version of Magescotch.

This environment is based on the Vagrant base box Magemalt. To request new software to be added, please open an issue on the Magemalt repository.

Magescotch is designed to allow you to experiment with Magento (both Magento 1 and Magento 2). While sample installations of M1 and M2 are setup for you, the main purpose of the environment is to give you a place to work on your own projects.

Magescotch is built for general purpose use, but began with conferences and training sessions in mind. Because of how dodgy conference wifi can be, we include any tool we think you might need in the Magescotch base box. When in doubt, poke around /usr/local/src/ for lots of preloaded goodies. The Composer cache is also prewarmed with a number of Magento-related libraries. This makes Magescotch also especially useful on planes, trains and other situations with little-to-no bandwidth available.

Get Started

Common Tasks

Create an admin account

You can create a new admin account using a command like this: bin/magento admin:user:create --admin-user='admin2' --admin-password='!admin123!' --admin-email='info@domain.com' --admin-firstname='John' --admin-lastname='Doe'

Replace the username and password with something more secure and the email address with your own email address.

Add SSH keys to SSH agent so the Vagrant box can use them via SSH agent forwarding

This only works on Mac and Linux host machines, but on those OS's, on your local machine, run:

ssh-add

Make sure that your ~/.ssh/config file on your local machine includes these lines:

Host * ForwardAgent yes

Troubleshoot issues by making sure SSH is aware of your key, by running:

ssh-add -l

Add a new project to MageScotch

In a command prompt on your local machine:

cd <MageScotch Directory>/public/

git clone <your project> myproject

cd myproject

cp <wherever you have an SQL dump of your project's database) ./dump.sql

vagrant ssh (this command connects you to the MageScotch box via SSH)

mysql -u dev -p

(password is dev)

CREATE DATABASE myproject;

GRANT ALL on myproject.* TO 'dev'@'localhost';(CTRL-D to exit)

cd /var/www/public/myproject/

mysql -u dev -p myproject < dump.sql

exit

Your project should now appear when you visit http://192.168.33.10/myproject/

If your project doesn't appear, try clearing any caches, etc.

You can make changes by editing the files in /public/myproject/ - any changes made there should take effect immediately.

Credentials

Databases / MySQL

Username: dev Password: dev Databases: magento, magento2, dev

Admin accounts

Common Issues

Magento 1 sites don't load

Magento 1 is not currently compatible with PHP 7.

If the error is a 500 error and in the Magento exception log you see this error: " PHP Fatal error: Uncaught Error: Function name must be a string...", your project isn't compatible with PHP 7.

If that's the case, run 'vagrant ssh' to connect to MageScotch and cd to the directory your project is installed in and run the following commands:

For Magento 1.9.3 and newer

modman init modman clone https://github.com/Inchoo/Inchoo_PHP7 magerun cache:flush magerun sys:setup:run

For Magento 1.9.2.4 and older

modman init modman clone https://github.com/Inchoo/Inchoo_PHP7 -b '1.9.2.4' magerun cache:flush magerun sys:setup:run

Features

System Stuff

Magento Stuff

Database Stuff

Caching Stuff

Node Stuff

Laravel Stuff

Other Useful Stuff

Basic Vagrant Commands

Start or resume your server

vagrant up

Pause your server

vagrant suspend

Delete your server

vagrant destroy

SSH into your server

vagrant ssh

Database Access

MySQL

PostgreSQL

SSH Access

Updating the Box

Although not necessary, if you want to check for updates, just type:

vagrant box outdated

It will tell you if you are running the latest version or not, of the box. If it says you aren't, simply run:

vagrant box update

Setting a Hostname

If you're like me, you prefer to develop at a domain name versus an IP address. If you want to get rid of the some-what ugly IP address, just add a record like the following example to your computer's host file.

192.168.33.10 whatever-i-want.local

Or if you want "www" to work as well, do:

192.168.33.10 whatever-i-want.local www.whatever-i-want.local

Technically you could also use a Vagrant Plugin like Vagrant Hostmanager to automatically update your host file when you run Vagrant Up. However, the purpose of Scotch Box is to have as little dependencies as possible so that it's always working when you run "vagrant up".

Scotch Box

MageScotch Box is based on Scotch Box v2 - https://github.com/scotch-io/scotch-box

Learn more about Scotch Box v2:

Check out the official docs at: box.scotch.io

Read the getting started article

Read the 2.0 release article

Scotch Box

Scotch Box is a preconfigured Vagrant Box with a full array of LAMP Stack features to get you up and running with Vagrant in no time.

A lot of PHP websites and applications don't require much server configuration or overhead at first. This box should have all your needs for doing basic development so you don't have to worry about configuring Vagrant and you can simply focus on your code.

No provisioning tools or setup is really even required with Scotch Box. Since everything is packaged into the box, running "vagrant" is super fast, you'll never have to worry about your environment breaking with updates, and you won't need Internet to code.

Scotch Box

What and Why

Vagrant is an extremely powerful tool. With Chef or Puppet and Vagrant, you can configure any type of server environment you can think of. The possibilities are endless (especially with Docker in the picture now, too). Speaking candidly though, most the development I do doesn't really stray from a default LAMP stack, and when I have to configure a server, I really am always just setting up a boring typical LAMP stack anyways. All I really want is PHP 5.6 and a bunch of modules with zero hassle or overhead.

I used to use this seriously awesome Vagrant LAMP Stack that I even wrote about here. The problem with this is it broke a lot. It broke when Vagrant updated, it broke when Chef updated, and it broke when Berkshelf updated. On top of that, I always had problems getting it working on Windows. There are just too many points of failures for what it's purpose was for me - simply just developing locally.

So that's why I decided to build a Vagrant LAMP Box. The box is prepackaged and requires provisioning and no configuration. You simply boot it up and it just works. It's not for every project, but it sure will help you get straight to it with a lot of them.

Are you new to Vagrant? If your new to Vagrant, check out our getting started guide with Vagrant article, our Vagrant Share article, and our article on Larvel's Vagrant stack Homestead. If you follow the first tutorial, you can just learn the Vagrant commands but use the Scotch Box instead.

Scotch Box SSH

The MIT License (MIT)

Copyright (c) 2014-2015 Nicholas Cerminara, scotch.io, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.