Skip to content

Commit

Permalink
Merge pull request #289 from bensojona/f-atlas-docs
Browse files Browse the repository at this point in the history
Atlas Docs
  • Loading branch information
meatballhat committed Jul 31, 2015
2 parents 56ab84a + f0e8953 commit 94d2ac1
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Dpl supports the following providers:

* [AppFog](#appfog)
* [Atlas by HashiCorp](#atlas)
* [Biicode](#biicode)
* [Bintray](#bintray)
* [BitBalloon](#bitballoon)
Expand Down Expand Up @@ -354,6 +355,31 @@ It is possible to set file-specific `Cache-Control` and `Expires` headers using
dpl --provider=appfog --email=<email> --password=<password>
dpl --provider=appfog --email=<email> --password=<password> --app=<app>

### Atlas:

The Atlas provider uses the [`atlas-upload-cli`](https://github.com/hashicorp/atlas-upload-cli) command. The [Atlas Upload CLI](https://github.com/hashicorp/atlas-upload-cli) is a lightweight command line interface for uploading application code to [Atlas](https://atlas.hashicorp.com/homepage?utm_source=github&utm_medium=travis-ci&utm_campaign=dpl) to kick off Atlas-based deployment processes from Travis CI.

You first need to create an [Atlas account](https://atlas.hashicorp.com/account/new?utm_source=github&utm_medium=travis-ci&utm_campaign=dpl), then, generate an [Atlas API token](https://atlas.hashicorp.com/settings/tokens) for Travis CI.

#### Options:

* **token** (Required): Atlas API token.
* **app** (Required): Atlas application name (`<atlas-username>/<app-name>`).
* **exclude**: Glob pattern of files or directories to exclude (this may be specified multiple times).
* **include**: Glob pattern of files/directories to include (this may be specified multiple times, any excludes will override conflicting includes).
* **address**: The address of the Atlas server.
* **vcs**: Use VCS to determine which files to include/exclude.
* **metadata**: Arbitrary key-value (string) metadata to be sent with the upload; may be specified multiple times.
* **debug**: Turn on debug output.
* **version**: Print the version of this application.

#### Examples:

dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME
dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME --debug --vcs --version
dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME --exclude="*.log" --include="build/*" --include="bin/*"
dpl --provider=atlas --token=ATLAS_TOKEN --app=ATLAS_USERNAME/APP_NAME --metadata="foo=bar" --metadata="bar=baz"

### Divshot.io:

#### Options:
Expand Down

0 comments on commit 94d2ac1

Please sign in to comment.