Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3846masa/docker-ngrokd
Make your private ngrok with docker-compose.
https://github.com/3846masa/docker-ngrokd
Last synced: 9 days ago
JSON representation
Make your private ngrok with docker-compose.
- Host: GitHub
- URL: https://github.com/3846masa/docker-ngrokd
- Owner: 3846masa
- License: mit
- Archived: true
- Created: 2016-10-04T10:41:39.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-05T04:50:07.000Z (about 8 years ago)
- Last Synced: 2024-08-01T20:51:41.023Z (4 months ago)
- Size: 5.86 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ngrokd
[Product Page](https://github.com/inconshreveable/ngrok)
[DockerHub](https://hub.docker.com/r/3846masa/ngrokd/)
## Client Usage
### Get client ngrok
Pull [3846masa/ngrok] and `make release-client` (Recommended).
Or download from [GitHub Releases](https://github.com/3846masa/ngrok/releases).
[3846masa/ngrok]: https://github.com/3846masa/ngrok
### Settings
Make file `$HOME/.ngrok`, write settings and rewrite `server_addr`.
```yaml
server_addr: example.com:4443
trust_host_root_certs: false
```
## Server Usage
### Env
| ENV | Description | Required |
|:------------:|:------------------------------------------------------|:------------:|
| VHOST_NAME | Based domain. (e.g. `*.example.com` -> `example.com`) | **Required** |
| CF_API_KEY | CloudFlare API key (See [below][cf-api]) | Optional |
| CF_API_EMAIL | CloudFlare API email (See [below][cf-api]) | Optional |
| VIRTUAL_HOST | [nginx-proxy] config. (e.g. `*.example.com`) | Optional |
| VIRTUAL_PORT | [nginx-proxy] config. (Recommend: `80`) | Optional |
| HTTPS_METHOD | [nginx-proxy] config. (Recommend: `noredirect`) | Optional |
[nginx-proxy]: https://github.com/jwilder/nginx-proxy
[cf-api]: #cloudflare-api
### Using Docker CLI
#### Simple
```bash
$ docker run -e VHOST_NAME=example.com 3846masa/ngrokd
```
#### Advanced
```bash
$ docker run 3846masa/ngrokd ngrokd -domain=example.com -log-level=WARNING [...opts]
```
### Using Docker Compose
Edit `docker-compose.yml` and Run `docker-compose up -d`.
### DNS Settings
Set `*.example.com` (A/CNAME) Record to your server.
### CloudFlare API
When client send `-subdomain` option, **this image can setup CloudFlare Universal SSL automatically**.
Using CloudFlare Universal SSL, you should do the following settings.
##### Crypto
- When you use **Flexible SSL**, you can access **via SSL only**.
- If you will access HTTP, please use **Full SSL**.
- [nginx-proxy] and self-signed SSL is easy way.
##### API Key
- [Access account page][cf-account].
- Account > API Key > Global API Key
[cf-account]: https://www.cloudflare.com/a/account
## LICENSE
(c) 3846masa [MIT](./LICENSE)
## Author
![3846masa][3846masa] 3846masa
[3846masa]: http://gravatar.com/avatar/cfeae69aae4f4fc102960f01d35d2d86?s=25