Ori.livneh has uploaded a new change for review. https://gerrit.wikimedia.org/r/58314
Change subject: Update README ...................................................................... Update README Change-Id: Ia7efac4d322ae059254ac6ed2fcc7255df416c3e --- A README D README.md D extra-vagrant-settings.rb 3 files changed, 55 insertions(+), 57 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/vagrant refs/changes/14/58314/1 diff --git a/README b/README new file mode 100644 index 0000000..d524ecd --- /dev/null +++ b/README @@ -0,0 +1,55 @@ +## MediaWiki-Vagrant + +http://www.mediawiki.org/wiki/Mediawiki-vagrant + +MediaWiki-Vagrant is a portable MediaWiki development environment. It consists +of a set of configuration scripts that automate the creation of a virtual +machine that runs MediaWiki. + +The virtual machine that MediaWiki-Vagrant creates makes it easy to learn +about, modify, and improve MediaWiki's code: useful debugging information is +displayed by default, and various developer tools are set up specifically for +inspecting and interacting with MediaWiki code, including a powerful debugger +and an interactive interpreter. Best of all, because the configuration is +automated and contained in a virtual environment, mistakes are easy to undo. + + +## Prerequisites + +You'll need to install recent versions of Vagrant and VirtualBox. + + * VirtualBox: https://www.virtualbox.org/wiki/Downloads + * Vagrant: http://downloads.vagrantup.com/ + +Next, you'll need a copy of the mediawiki-vagrant project files. + + * zip: https://github.com/wikimedia/mediawiki-vagrant/archive/master.zip + * tar.gz: https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/vagrant.git;a=snapshot;h=HEAD;sf=tgz + * Git: `git clone https://gerrit.wikimedia.org/r/mediawiki/vagrant` + + +## Installation + +If you download the zip file or tarball, you will need to extract it to a +directory of your choice. Once you do that, open up a terminal or a +command-prompt, and change your working directory to the location of the +extracted (or git-cloned) files. From there, run `vagrant up` to provision and +boot the virtual machine. + +You'll now have to wait a bit, as Vagrant needs to retrieve the base image from +Canonical, retrieve some additional packages, and install and configure each of +them in turn. + +If it all worked, you should be able to browse to http://localhost:8080/ and +see the main page of your MediaWiki instance. + + +## Usage + +To access a command shell on your virtual environment, run `vagrant ssh` from +the root mediawiki-vagrant directory or any of its subdirectories. + +From there, run `phpsh` to interactively evaluate PHP code in a MediaWiki +context, or `mysql` to get an authenticated SQL shell on your wiki's database. + +The admin account on MediaWiki is `admin` / `vagrant`. diff --git a/README.md b/README.md deleted file mode 100644 index a4a0699..0000000 --- a/README.md +++ /dev/null @@ -1,49 +0,0 @@ - - - -MediaWiki Vagrant -================= - -A portable MediaWiki development environment. - - -## Prerequisites ## - -You'll need to install -[Vagrant](http://vagrantup.com/v1/docs/getting-started/index.html) and -[VirtualBox](https://www.virtualbox.org/wiki/Downloads) (>= 4.1). - -**IMPORTANT**: You must enable hardware virtualization (VT-x or AMD-V). This -is often a BIOS setting. If you don't do that, you'll probably get an error in -the last step of the installation, 'vagrant up'. You can verify this by trying -to launch the VM from the VirtualBox GUI. If an error message appears that says -something about "VT-X", you need to reboot the host machine and enable the BIOS -setting that allows hardware virtualization. - -## Installation ## - -```bash -git clone https://github.com/wikimedia/mediawiki-vagrant.git -cd ./mediawiki-vagrant -vagrant up -``` - -It'll take some time, because it'll need to fetch the base precise64 box if you -don't already have it. Once it's done, you should be able to browse to -http://127.0.0.1:8080/w/ and see a vanilla MediaWiki install, served by the guest -VM, which is running Ubuntu Precise 64-bit. - -The `mediawiki/` sub-folder in the repository is mounted as `/vagrant/mediawiki`, -and port 8080 on the host is forwarded to port 80 on the guest. - -The MySQL root credentials are: - -* Username: root -* Password: vagrant - -The MediaWiki credentials are: - -* Username: admin -* Password: vagrant - -To SSH into your VM, simply type `vagrant ssh`. diff --git a/extra-vagrant-settings.rb b/extra-vagrant-settings.rb deleted file mode 100644 index 7e61e78..0000000 --- a/extra-vagrant-settings.rb +++ /dev/null @@ -1,8 +0,0 @@ -# -*- mode: ruby -*- -# vi: set ft=ruby : - -Vagrant.configure('2') do |config| - - # You can override any configurations set by 'Vagrantfile' here. - -end -- To view, visit https://gerrit.wikimedia.org/r/58314 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ia7efac4d322ae059254ac6ed2fcc7255df416c3e Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/vagrant Gerrit-Branch: master Gerrit-Owner: Ori.livneh <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
