github.com/blystad/deis@v0.11.0/router/README.md (about)

     1  # Deis Router
     2  
     3  An nginx proxy for use in the [Deis](http://deis.io) open source PaaS.
     4  
     5  [![image](https://d207aa93qlcgug.cloudfront.net/img/icons/framed-icon-checked-repository.svg)](https://index.docker.io/u/deis/router/)
     6  
     7  [**Trusted Build**](https://index.docker.io/u/deis/router/)
     8  
     9  This Docker image is based on the trusted build
    10  [deis/base](https://index.docker.io/u/deis/base/), which itself is based
    11  on the official [ubuntu:12.04](https://index.docker.io/_/ubuntu/) image.
    12  
    13  Please add any issues you find with this software to the
    14  [Deis project](https://github.com/deis/deis/issues).
    15  
    16  ## Usage
    17  
    18  * `make build` builds the *deis/router* image inside a vagrant VM
    19  * `make run` installs and starts *deis/router*, then displays log
    20    output from the container
    21  
    22  ## Environment Variables
    23  
    24  * **DEBUG** enables verbose output if set
    25  * **ETCD_PORT** sets the TCP port on which to connect to the local etcd
    26    daemon (default: *4001*)
    27  * **ETCD_PATH** sets the etcd directory where the router announces
    28    its configuration (default: */deis/router*)
    29  * **ETCD_TTL** sets the time-to-live before etcd purges a configuration
    30    value, in seconds (default: *10*)
    31  * **PORT** sets the TCP port on which the router listens (default: *80*)
    32  
    33  
    34  ## License
    35  
    36  © 2014 OpDemand LLC
    37  
    38  Licensed under the Apache License, Version 2.0 (the "License"); you may
    39  not use this file except in compliance with the License. You may obtain
    40  a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>
    41  
    42  Unless required by applicable law or agreed to in writing, software
    43  distributed under the License is distributed on an "AS IS" BASIS,
    44  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    45  See the License for the specific language governing permissions and
    46  limitations under the License.