Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acidlemon/mirage
docker front end & reverse proxy for development
https://github.com/acidlemon/mirage
Last synced: about 2 months ago
JSON representation
docker front end & reverse proxy for development
- Host: GitHub
- URL: https://github.com/acidlemon/mirage
- Owner: acidlemon
- Created: 2014-07-21T04:10:06.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-07-10T07:43:53.000Z (about 5 years ago)
- Last Synced: 2024-06-20T11:53:23.053Z (3 months ago)
- Language: Go
- Homepage:
- Size: 75.2 KB
- Stars: 76
- Watchers: 2
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
mirage - reverse proxy frontend for docker
===========================================
mirage is reverse proxy for docker container and container manager.
mirage can launch and terminate docker container and serve http request
with specified subdomain. Additionaly, mirage passes variable to Dockerfile
using environment variables.
Usage
------
1. Setup mirage and edit configuration (see Setup section for detail.)
2. Run mirage.
Following instructions use below settings.
```
host:
webapi: docker.dev.example.net
reverse_proxy_suffix: .dev.example.net
listen:
HTTP: 80
```
Prerequisite: you should resolve `*.dev.example.net` to your docker host.
### Using CLI
3. Launch docker container using curl.
```
curl http://docker.dev.example.net/api/launch \
-d subdomain=cool-feature \
-d branch=feature/cool \
-d image=myapp:latest
```
4. Now, you can access to container using "http://cool-feature.dev.exmaple.net/".
5. Terminate container using curl.
```
curl http://docker.dev.example.net/api/terminate \
-d subdomain=cool-feature
```
### Using Web Interface
3. Access to mirage web interface via "http://docker.dev.example.net/".
4. Press "Launch New Container".
5. Fill launch options.
- subdomain: cool-feature
- branch: feature/cool
- image: myapp:latest
6. Now, you can access to container using "http://cool-feature.dev.exmaple.net/".
7. Press "Terminate" button.
### Customization
Mirage now supports custom parameter. Write your parameter on config.yml.
Mirage contains default parameter "branch" as below.
```
parameters:
- name: branch
env: GIT_BRANCH
rule: ""
required: true
```
You can add custom parameter. "rule" option is regexp string.
Setup
------
1. Download [binary](https://github.com/acidlemon/mirage/releases) or `go get`
2. Rename `config_sample.yml` to `config.yml`
3. Edit `config.yml` to your environment
4. Change your domain setting to fit your `config.yml`
5. Run `mirage`
License
--------
The MIT License (MIT)
(c) 2014 acidlemon. (c) 2014 KAYAC Inc.