You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/what-it-do.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,14 +16,14 @@ We've found a useful pattern here is for the senior-est, most DevOps-y person on
16
16
17
17
In order for you to get started using the awesome power of Lando, you need to have the following:
18
18
19
-
* A [Landofile](https://docs.lando.dev/config), generally this is called `.lando.yml`
19
+
* A [Landofile](https://docs.lando.dev/landofile), generally this is called `.lando.yml`
20
20
* Your application's codebase
21
21
22
22
If you are unclear on how to manually set this up, check out our [lando init](https://docs.lando.dev/cli/init.html) command which can help you initialize code from various sources for use with Lando.
23
23
24
24
## So, what does this Landofile look like anyway?
25
25
26
-
As mentioned above, the Landofile is generally named `.lando.yml` but is both [configurable](https://docs.lando.dev/config) and [overridable](https://docs.lando.dev/config). It needs a `name`, but beyond that, it can contain any combination things, although generally it only uses a small subset as follows:
26
+
As mentioned above, the Landofile is generally named `.lando.yml` but is both [configurable](https://docs.lando.dev/landofile) and [overridable](https://docs.lando.dev/landofile). It needs a `name`, but beyond that, it can contain any combination things, although generally it only uses a small subset as follows:
27
27
28
28
```yaml
29
29
name: my-app
@@ -55,25 +55,25 @@ Note that the values in each key above are not particularly relevant to what we
55
55
56
56
**name** - Nothing special here. This should be a unique way for you to identify your app.
57
57
58
-
**compose** - This is a list of `docker-compose` files you can tell Lando to start. The paths are relative to the root of your project. Generally, this option is not used in favor of Lando [recipes](https://docs.lando.dev/config/recipes.html) and/or [services](https://docs.lando.dev/config/services.html) but is an option that makes sense under some circumstances.
58
+
**compose** - This is a list of `docker-compose` files you can tell Lando to start. The paths are relative to the root of your project. Generally, this option is not used in favor of Lando [recipes](https://docs.lando.dev/landofile/recipes.html) and/or [services](https://docs.lando.dev/landofile/services.html) but is an option that makes sense under some circumstances.
59
59
60
60
Note that services located in these files will still get injected with Lando's [default environment variables](https://docs.lando.dev/config/env.html#default-environment-variables) and also be [networked](https://docs.lando.dev/config/networking.html) like any other Lando service but will not get any of the extra Lando *secret sauce*.
61
61
62
62
If you are interested in using something Lando does not currently offer as a service or recipe, we recommend looking at the [custom compose](https://docs.lando.dev/compose) service.
63
63
64
64
**[env_file](https://docs.lando.dev/config/env.html#environment-files)** - A list of environment files relative to your project's root directory. Each file should contain a list of `KEY=VALUE` pairs that will then get injected into the environment of **every** service.
65
65
66
-
**[events](https://docs.lando.dev/config/events.html)** - Events allow the user to run arbitrary commands, or combinations of commands, on arbitrary services, or combinations of services before or after certain parts of the Lando runtime. A good example is clearing out an application's cache after a database is imported.
66
+
**[events](https://docs.lando.dev/landofile/events.html)** - Events allow the user to run arbitrary commands, or combinations of commands, on arbitrary services, or combinations of services before or after certain parts of the Lando runtime. A good example is clearing out an application's cache after a database is imported.
67
67
68
-
**[recipe](https://docs.lando.dev/config/recipes.html)** - Recipes are combinations of [services](https://docs.lando.dev/config/services.html), [proxies](https://docs.lando.dev/config/proxy.html), and [tooling](https://docs.lando.dev/config/tooling.html) designed as a start-state-of-sane-defaults for a particular use case - e.g. `drupal9`.
68
+
**[recipe](https://docs.lando.dev/landofile/recipes.html)** - Recipes are combinations of [services](https://docs.lando.dev/landofile/services.html), [proxies](https://docs.lando.dev/landofile/proxy.html), and [tooling](https://docs.lando.dev/landofile/tooling.html) designed as a start-state-of-sane-defaults for a particular use case - e.g. `drupal9`.
69
69
70
-
**[config](https://docs.lando.dev/config/recipes.html#config)** - Config allows you to set some of the more important things your recipe provides. These settings are usually different depending on the recipe you select.
70
+
**[config](https://docs.lando.dev/landofile/recipes.html#config)** - Config allows you to set some of the more important things your recipe provides. These settings are usually different depending on the recipe you select.
71
71
72
-
**[proxy](https://docs.lando.dev/config/proxy.html)** - Proxy settings allow users to map arbitrary domain names to arbitrary ports inside of arbitrary services. Think: I go to the browser and type in `myapp.lndo.site` or `millard.filmore.for.lyfe` and it loads my application.
72
+
**[proxy](https://docs.lando.dev/landofile/proxy.html)** - Proxy settings allow users to map arbitrary domain names to arbitrary ports inside of arbitrary services. Think: I go to the browser and type in `myapp.lndo.site` or `millard.filmore.for.lyfe` and it loads my application.
73
73
74
-
**[services](https://docs.lando.dev/config/services.html)** - Services are simplified but still highly configurable Docker containers. They are able to run [build steps](https://docs.lando.dev/config/services.html#build-steps) such as installing a `php-extension` or running `yarn install` and can also be [overridden](https://docs.lando.dev/config/services.html#overrides) down to the `docker-compose` level. They also get some automatic [networking](https://docs.lando.dev/config/networking.html) and [security](https://docs.lando.dev/config/security.html) features.
74
+
**[services](https://docs.lando.dev/landofile/services.html)** - Services are simplified but still highly configurable Docker containers. They are able to run [build steps](https://docs.lando.dev/landofile/services.html#build-steps) such as installing a `php-extension` or running `yarn install` and can also be [overridden](https://docs.lando.dev/landofile/services.html#overrides) down to the `docker-compose` level. They also get some automatic [networking](https://docs.lando.dev/config/networking.html) and [security](https://docs.lando.dev/config/security.html) features.
75
75
76
-
**[tooling](https://docs.lando.dev/config/tooling.html)** - Tooling allows users to run arbitrary commands, or combinations of commands, on arbitrary services, or combinations of services when invoked.
76
+
**[tooling](https://docs.lando.dev/landofile/tooling.html)** - Tooling allows users to run arbitrary commands, or combinations of commands, on arbitrary services, or combinations of services when invoked.
77
77
78
78
This is helpful so you can run `lando yarn install` instead of `docker exec -it SERVICE yarn install` or so `lando test` can run `composer test` and `yarn test` in their respective services. You can also specify options, including interactive ones, to build out more complicated commands like `lando pull-my-database-from-aws --user=me --password=***` or to have a single command run on many services - e.g. `lando db-import dump.sql -h database2`.
79
79
@@ -83,10 +83,10 @@ This is helpful so you can run `lando yarn install` instead of `docker exec -it
83
83
84
84
There are various ways to craft your Landofile but we've found and observed a strategy to be *generally a good approach* as follows:
85
85
86
-
1. Shop around for a [recipe](https://docs.lando.dev/config/recipes.html) that can serve as a good starting point. [lando init](https://docs.lando.dev/cli/init.html) is helpful for this.
87
-
2. Add in additional [services](https://docs.lando.dev/config/recipes.html) when you need more **JUICE**.
88
-
3. Define more complex [tooling](https://docs.lando.dev/config/tooling.html) and [events](https://docs.lando.dev/config/events.html) to simplify difficult command patterns and automate common tasks.
89
-
4. Add in some [build steps](https://docs.lando.dev/config/services.html#build-steps) to further automate setting your services up or to mix in additional project dependencies.
86
+
1. Shop around for a [recipe](https://docs.lando.dev/landofile/recipes.html) that can serve as a good starting point. [lando init](https://docs.lando.dev/cli/init.html) is helpful for this.
87
+
2. Add in additional [services](https://docs.lando.dev/landofile/recipes.html) when you need more **JUICE**.
88
+
3. Define more complex [tooling](https://docs.lando.dev/landofile/tooling.html) and [events](https://docs.lando.dev/landofile/events.html) to simplify difficult command patterns and automate common tasks.
89
+
4. Add in some [build steps](https://docs.lando.dev/landofile/services.html#build-steps) to further automate setting your services up or to mix in additional project dependencies.
90
90
5. Define [custom services](https://docs.lando.dev/compose) as a catch all for anything else you need.
91
91
6. Create [custom recipes or services](https://docs.lando.dev/contrib/contrib-plugins.html) to lock down your new power tools.
0 commit comments