website: add docs for mailgun provider
This commit is contained in:
Jack Pearkes
parent
e3d54cb487
commit
872f852a59
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
layout: "mailgun"
|
||||
page_title: "Provider: Mailgun"
|
||||
sidebar_current: "docs-mailgun-index"
|
||||
---
|
||||
|
||||
# Provider
|
||||
|
||||
The Mailgun provider is used to interact with the
|
||||
resources supported by Mailgun. The provider needs to be configured
|
||||
with the proper credentials before it can be used.
|
||||
|
||||
Use the navigation to the left to read about the available resources.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
# Configure the Mailgun provider
|
||||
provider "mailgun" {
|
||||
api_key = "${var.mailgun_api_key}"
|
||||
}
|
||||
|
||||
# Create a new domain
|
||||
resource "mailgun_domain" "default" {
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `api_key` - (Required) Mailgun API key
|
||||
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
layout: "mailgun"
|
||||
page_title: "Mailgun: mailgun_domain"
|
||||
sidebar_current: "docs-mailgun-resource-domain"
|
||||
---
|
||||
|
||||
# mailgun\_domain
|
||||
|
||||
Provides a Mailgun App resource. This can be used to
|
||||
create and manage applications on Mailgun.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
# Create a new mailgun domain
|
||||
resource "mailgun_app" "default" {
|
||||
name = "test.example.com"
|
||||
}
|
||||
|
||||
# Create SMTP Credentials
|
||||
resource "mailgun_domain" "default" {
|
||||
name = "test.example.com"
|
||||
spam_action = "disabled"
|
||||
smtp_password = "foobar"
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The domain to add to Mailgun
|
||||
* `smtp_password` - (Optional) Password for SMTP authentication
|
||||
* `spam_action` - (Optional) `disabled` or `tag` Disable, no spam
|
||||
filtering will occur for inbound messages. Tag, messages
|
||||
will be tagged wtih a spam header.
|
||||
* `wildcard` - (Optional) Boolean determines whether
|
||||
the domain will accept email for sub-domains.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `name` - The name of the domain.
|
||||
* `smtp_login` - The login email for the SMTP server.
|
||||
* `smtp_password` - The password to the SMTP server.
|
||||
* `wildcard` - Whether or not the domain will accept email for sub-domains.
|
||||
* `spam_action` - The spam filtering setting.
|
||||
|
|
@ -99,6 +99,10 @@
|
|||
<li<%= sidebar_current("docs-providers-heroku") %>>
|
||||
<a href="/docs/providers/heroku/index.html">Heroku</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-providers-mailgun") %>>
|
||||
<a href="/docs/providers/mailgun/index.html">Mailgun</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,26 @@
|
|||
<% wrap_layout :inner do %>
|
||||
<% content_for :sidebar do %>
|
||||
<div class="docs-sidebar hidden-print affix-top" role="complementary">
|
||||
<ul class="nav docs-sidenav">
|
||||
<li<%= sidebar_current("docs-home") %>>
|
||||
<a href="/docs/index.html">« Documentation Home</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-mailgun-index") %>>
|
||||
<a href="/docs/providers/mailgun/index.html">Mailgun Provider</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-mailgun-resource") %>>
|
||||
<a href="#">Resources</a>
|
||||
<ul class="nav nav-visible">
|
||||
<li<%= sidebar_current("docs-mailgun-resource-domain") %>>
|
||||
<a href="/docs/providers/mailgun/r/domain.html">mailgun_domain</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<%= yield %>
|
||||
<% end %>
|
||||
|
|
@ -10,6 +10,7 @@ body.layout-consul,
|
|||
body.layout-dnsimple,
|
||||
body.layout-cloudflare,
|
||||
body.layout-heroku,
|
||||
body.layout-mailgun,
|
||||
body.layout-digitalocean,
|
||||
body.layout-aws,
|
||||
body.layout-docs,
|
||||
|
|
@ -17,7 +18,7 @@ body.layout-inner,
|
|||
body.layout-downloads,
|
||||
body.layout-intro{
|
||||
background: @light-black url('../images/sidebar-wire.png') left 62px no-repeat;
|
||||
|
||||
|
||||
>.container{
|
||||
.col-md-8[role=main]{
|
||||
min-height: 800px;
|
||||
|
|
|
|||
|
|
@ -1618,6 +1618,7 @@ body.layout-consul,
|
|||
body.layout-dnsimple,
|
||||
body.layout-cloudflare,
|
||||
body.layout-heroku,
|
||||
body.layout-mailgun,
|
||||
body.layout-digitalocean,
|
||||
body.layout-aws,
|
||||
body.layout-docs,
|
||||
|
|
@ -1630,6 +1631,7 @@ body.layout-consul > .container .col-md-8[role=main],
|
|||
body.layout-dnsimple > .container .col-md-8[role=main],
|
||||
body.layout-cloudflare > .container .col-md-8[role=main],
|
||||
body.layout-heroku > .container .col-md-8[role=main],
|
||||
body.layout-mailgun > .container .col-md-8[role=main],
|
||||
body.layout-digitalocean > .container .col-md-8[role=main],
|
||||
body.layout-aws > .container .col-md-8[role=main],
|
||||
body.layout-docs > .container .col-md-8[role=main],
|
||||
|
|
@ -1643,6 +1645,7 @@ body.layout-consul > .container .col-md-8[role=main] > div,
|
|||
body.layout-dnsimple > .container .col-md-8[role=main] > div,
|
||||
body.layout-cloudflare > .container .col-md-8[role=main] > div,
|
||||
body.layout-heroku > .container .col-md-8[role=main] > div,
|
||||
body.layout-mailgun > .container .col-md-8[role=main] > div,
|
||||
body.layout-digitalocean > .container .col-md-8[role=main] > div,
|
||||
body.layout-aws > .container .col-md-8[role=main] > div,
|
||||
body.layout-docs > .container .col-md-8[role=main] > div,
|
||||
|
|
|
|||
Loading…
Reference in New Issue