]> cat aescling's git repositories - mastodon.git/commitdiff
add Vagrant short guide to readme (#13009)
authorДаниил Пронин <mail@grawl.ru>
Thu, 14 Oct 2021 19:06:19 +0000 (05:06 +1000)
committerGitHub <noreply@github.com>
Thu, 14 Oct 2021 19:06:19 +0000 (21:06 +0200)
README.md

index 466ed0f915a6f987dcb35badaa7ff15949b4fe07..d9ee0ac9056cf60d669ab2c617e9c83b39e32ac2 100644 (file)
--- 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