about summary refs log tree commit diff
diff options
context:
space:
mode:
authorДаниил Пронин <mail@grawl.ru>2021-10-15 05:06:19 +1000
committerGitHub <noreply@github.com>2021-10-14 21:06:19 +0200
commit32db7e4df65f7b5594fa533f1655e3632ba98042 (patch)
tree14c2cb3d5fb58c07e165d7333edd891ac8cfc20d
parent085da139338d73598f8b98fc3b29ef8d66c00466 (diff)
add Vagrant short guide to readme (#13009)
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 466ed0f91..d9ee0ac90 100644
--- a/README.md
+++ b/README.md
@@ -74,7 +74,12 @@ Mastodon acts as an OAuth2 provider so 3rd party apps can use the REST and Strea
 
 The repository includes deployment configurations for **Docker and docker-compose**, but also a few specific platforms like **Heroku**, **Scalingo**, and **Nanobox**. The [**stand-alone** installation guide](https://docs.joinmastodon.org/admin/install/) is available in the documentation.
 
-A **Vagrant** configuration is included for development purposes.
+A **Vagrant** configuration is included for development purposes. To use it, complete following steps:
+
+- Install Vagrant and Virtualbox
+- Run `vagrant up`
+- Run `vagrant ssh -c "cd /vagrant && foreman start"`
+- Open `http://mastodon.local` in your browser
 
 ## Contributing