fleet/docs/development/development-infrastructure.md

Development Infrastructure
==========================

## Starting the local development environment

To set up a canonical development environment via docker, run the following from the root of the repository:

```
docker-compose up
```

This requires that you have docker installed. At this point in time, automatic configuration tools are not included with this project.

#### Stopping the local development environment

If you'd like to shut down the virtual infrastructure created by docker, run the following from the root of the repository:

```
docker-compose down
```

#### Setting up the database tables

Once you `docker-compose up` and are running the databases, you can build the code and run the following command to create the database tables:

```
fleet prepare db
```

## Running Fleet using Docker development infrastructure

To start the Fleet server backed by the Docker development infrastructure, run the Fleet binary as follows:

```
fleet serve --auth_jwt_key="insecure"
```

By default, Fleet will try to connect to servers running on default ports on localhost. Depending on your browser's settings, you may have to click through a security warning.

If you're using Docker via [Docker Toolbox](https://www.docker.com/products/docker-toolbox), you may have to modify the default values use the output of `docker-machine ip` instead of `localhost`. There is an example configuration file included in this repository to make this process easier for you.  Use the `--config` flag of the Fleet binary to specify the path to your config. See `fleet --help` for more options.
Documentation Structure (#1101) Initial structure and content for the Kolide documentation. 2017-01-25 21:51:00 +00:00			`Development Infrastructure`
			`==========================`

			`## Starting the local development environment`

			`To set up a canonical development environment via docker, run the following from the root of the repository:`

			```
			`docker-compose up`
			```

			`This requires that you have docker installed. At this point in time, automatic configuration tools are not included with this project.`

			`#### Stopping the local development environment`

			`If you'd like to shut down the virtual infrastructure created by docker, run the following from the root of the repository:`

			```
			`docker-compose down`
			```

			`#### Setting up the database tables`

			Once you `docker-compose up` and are running the databases, you can build the code and run the following command to create the database tables:

			```
rename old references to the binary (#1638) 2017-11-19 00:58:19 +00:00			`fleet prepare db`
Documentation Structure (#1101) Initial structure and content for the Kolide documentation. 2017-01-25 21:51:00 +00:00			```

Rename Kolide to Fleet in the docs (#1554) 2017-09-21 22:51:26 +00:00			`## Running Fleet using Docker development infrastructure`
Documentation Structure (#1101) Initial structure and content for the Kolide documentation. 2017-01-25 21:51:00 +00:00
Fix documentation typos (#1682) 2017-12-22 02:37:32 +00:00			`To start the Fleet server backed by the Docker development infrastructure, run the Fleet binary as follows:`
Documentation Structure (#1101) Initial structure and content for the Kolide documentation. 2017-01-25 21:51:00 +00:00
			```
Linked development-infra docs from building-the-code docs. (#41) Added link to development-infrastructure docs at the end of building-the-code docs to walk contributors to the next step of serving Fleet locally. Added --auth_jwt_key="insecure" flag to fleet serve command in development-infrastructure docs. 2020-11-16 19:50:58 +00:00			`fleet serve --auth_jwt_key="insecure"`
Documentation Structure (#1101) Initial structure and content for the Kolide documentation. 2017-01-25 21:51:00 +00:00			```

Linked development-infra docs from building-the-code docs. (#41) Added link to development-infrastructure docs at the end of building-the-code docs to walk contributors to the next step of serving Fleet locally. Added --auth_jwt_key="insecure" flag to fleet serve command in development-infrastructure docs. 2020-11-16 19:50:58 +00:00			`By default, Fleet will try to connect to servers running on default ports on localhost. Depending on your browser's settings, you may have to click through a security warning.`
Documentation Structure (#1101) Initial structure and content for the Kolide documentation. 2017-01-25 21:51:00 +00:00
rename old references to the binary (#1638) 2017-11-19 00:58:19 +00:00			If you're using Docker via [Docker Toolbox](https://www.docker.com/products/docker-toolbox), you may have to modify the default values use the output of `docker-machine ip` instead of `localhost`. There is an example configuration file included in this repository to make this process easier for you. Use the `--config` flag of the Fleet binary to specify the path to your config. See `fleet --help` for more options.