github.com/epicpaas/deis@v1.0.2-0.20141114233758-6bbccb748f60/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  This Docker image is based on the official
     6  [ubuntu-debootstrap:14.04](https://registry.hub.docker.com/_/ubuntu/) image.
     7  
     8  Please add any [issues](https://github.com/deis/deis/issues) you find with this software to
     9  the [Deis Project](https://github.com/deis/deis).
    10  
    11  ## Usage
    12  
    13  Please consult the [Makefile](Makefile) for current instructions on how to build, test, push,
    14  install, and start **deis/router**.
    15  
    16  ## Environment Variables
    17  
    18  * **DEBUG** enables verbose output if set
    19  * **ETCD_PORT** sets the TCP port on which to connect to the local etcd
    20    daemon (default: *4001*)
    21  * **ETCD_PATH** sets the etcd directory where the router announces
    22    its configuration (default: */deis/router*)
    23  * **ETCD_TTL** sets the time-to-live before etcd purges a configuration
    24    value, in seconds (default: *10*)
    25  * **PORT** sets the TCP port on which the router listens (default: *80*)
    26  
    27  
    28  ## License
    29  
    30  © 2014 OpDemand LLC
    31  
    32  Licensed under the Apache License, Version 2.0 (the "License"); you may
    33  not use this file except in compliance with the License. You may obtain
    34  a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>
    35  
    36  Unless required by applicable law or agreed to in writing, software
    37  distributed under the License is distributed on an "AS IS" BASIS,
    38  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    39  See the License for the specific language governing permissions and
    40  limitations under the License.