Sha256: 5fab2e2c4fa9ac2a3664c337018eedd09d3e442cb3ed42eaf7d0457878c18ca5

Contents?: true

Size: 1.58 KB

Versions: 4

Compression:

Stored size: 1.58 KB

Contents

---
layout: "docs"
page_title: "Project Setup - Getting Started"
sidebar_current: "gettingstarted-projectsetup"
description: |-
  The first step in configuring any Vagrant project is to create a Vagrantfile.
---

# Project Setup

The first step in configuring any Vagrant project is to create a
[Vagrantfile](/docs/vagrantfile/). The purpose of the
Vagrantfile is twofold:

1. Mark the root directory of your project. Many of the configuration
   options in Vagrant are relative to this root directory.

2. Describe the kind of machine and resources you need to run your project,
   as well as what software to install and how you want to access it.

Vagrant has a built-in command for initializing a directory for usage
with Vagrant: `vagrant init`. For the purpose of this getting started guide,
please follow along in your terminal:

```
$ mkdir vagrant_getting_started
$ cd vagrant_getting_started
$ vagrant init
```

This will place a `Vagrantfile` in your current directory. You can
take a look at the Vagrantfile if you want, it is filled with comments
and examples. Do not be afraid if it looks intimidating, we will modify it
soon enough.

You can also run `vagrant init` in a pre-existing directory to
set up Vagrant for an existing project.

The Vagrantfile is meant to be committed to version control with
your project, if you use version control. This way, every person working
with that project can benefit from Vagrant without any upfront work.

## Next Steps

You have successfully created your first project environment. Read on to learn
more about [Vagrant boxes](/docs/getting-started/boxes.html).

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
vagrant-compose-yaml-0.1.3 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/getting-started/project_setup.html.md
vagrant-compose-yaml-0.1.2 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/getting-started/project_setup.html.md
vagrant-compose-yaml-0.1.1 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/getting-started/project_setup.html.md
vagrant-compose-yaml-0.1.0 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/getting-started/project_setup.html.md