Skip to content

Commit

Permalink
Simplifies the readme slightly
Browse files Browse the repository at this point in the history
The mention of Tugboat isn't true, and the caveats about environment
variables are explained in the docs.
  • Loading branch information
ejholmes committed Aug 10, 2017
1 parent 1b7f367 commit 8f52d52
Showing 1 changed file with 1 addition and 23 deletions.
24 changes: 1 addition & 23 deletions README.md
Expand Up @@ -46,32 +46,10 @@ Apps default to only being exposed internally, unless you add a custom domain to

### Deploying

Any tagged Docker image can be deployed to Empire as an app. Empire doesn't enforce how you tag your Docker images, but we recommend tagging the image with the git sha that it was built from, and deploying that. We have a tool for performing deployments called [Tugboat][tugboat] that supports deploying Docker images to Empire.
Any tagged Docker image can be deployed to Empire as an app. Empire doesn't enforce how you tag your Docker images, but we recommend tagging the image with the git sha that it was built from (any any immutable identifier), and deploying that.

When you deploy a Docker image to Empire, it will extract a `Procfile` from the WORKDIR. Like Heroku, you can specify different process types that compose your service (e.g. `web` and `worker`), and scale them individually. Each process type in the Procfile maps directly to an ECS Service.

**Caveats**

Because `docker run` does not exec commands within a shell, commands specified within the Procfile will also not be exec'd within a shell. This means that you cannot specify environment variables in the Procfile. The following is not valid:

```
web: acme-inc server -port=$PORT
```

If you need to specify environment variables as part of the command, we recommend splitting out your Procfile commands into small bash shims instead:

```
web: ./bin/web
```

```bash
#!/bin/bash

set -e

exec acme-inc server -port=$PORT
```

## Contributing

Pull requests are more than welcome! For help with setting up a development environment, see [CONTRIBUTING.md](./CONTRIBUTING.md)
Expand Down

0 comments on commit 8f52d52

Please sign in to comment.