github.com/ddev/ddev@v1.23.2-0.20240519125000-d824ffe36ff3/containers/ddev-traefik-router/README.md (about)

     1  # ddev-traefik-router docker image
     2  
     3  ## Overview
     4  
     5  ddev-traefik-router is a simple wrapper on the upstream [traefik](https://hub.docker.com/_/traefik) image.
     6  
     7  This container is used to allow all [DDEV](https://github.com/ddev/ddev) sites to exist side by side on shared ports (typically 80, 443, etc.). It serves as a reverse proxy to those sites, and forwards traffic to the appropriate site depending on the hostname.
     8  
     9  This container image is part of DDEV, and not typically used stand-alone.
    10  
    11  ### Features
    12  
    13  * traefik
    14  * A few extra packages and configuration
    15  * A healthcheck
    16  
    17  ## Instructions
    18  
    19  Use [DDEV](https://ddev.readthedocs.io)
    20  
    21  ### Building and pushing to Docker Hub
    22  
    23  See [DDEV docs](https://ddev.readthedocs.io/en/stable/developers/release-management/#pushing-docker-images-with-the-github-actions-workflow)
    24  
    25  ### Running
    26  To run the container by itself:
    27  
    28  ```bash
    29  docker run -it --rm ddev/ddev-traefik-router:<tag> bash
    30  ```
    31  
    32  ## Source:
    33  
    34  [https://github.com/ddev/ddev/tree/master/containers/ddev-traefik-router](https://github.com/ddev/ddev/tree/master/containers/ddev-traefik-router)
    35  
    36  ## Maintained by:
    37  
    38  The [DDEV Docker Maintainers](https://github.com/ddev)
    39  
    40  ## Where to get help:
    41  
    42  * [DDEV Community Discord](https://discord.gg/5wjP76mBJD)
    43  * [Stack Overflow](https://stackoverflow.com/questions/tagged/ddev)
    44  
    45  ## Where to file issues:
    46  
    47  https://github.com/ddev/ddev/issues
    48  
    49  ## Documentation:
    50  
    51  * https://ddev.readthedocs.io/
    52  * https://ddev.com/
    53  
    54  ## What is DDEV?
    55  
    56  [DDEV](https://github.com/ddev/ddev) is an open source tool for launching local web development environments in minutes. It supports PHP, Node.js, and Python (experimental).
    57  
    58  These environments can be extended, version controlled, and shared, so you can take advantage of a Docker workflow without Docker experience or bespoke configuration. Projects can be changed, powered down, or removed as easily as they’re started.
    59  
    60  ## License
    61  
    62  View [license information](https://github.com/ddev/ddev/blob/master/LICENSE) for the software contained in this image.
    63  
    64  As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
    65  
    66  As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
    67