Sha256: 6ce357b2d54a2279c41ee3bddde0ba0f152e0c99492de6d4e1c0bec73e746248

Contents?: true

Size: 1.24 KB

Versions: 17

Compression:

Stored size: 1.24 KB

Contents

# HTTP Tunneling with ngrok

Before your application can take advantage of features that depend on incoming webhooks, you'll need to setup an HTTP tunnel using a service like [ngrok](https://ngrok.com).

## Use a Paid Plan

You should specifically sign up for a paid account. Although ngrok offers a free plan, their $8/year or $10/month [paid plan](https://ngrok.com/pricing) will allow you to reserve a custom subdomain for reuse each time you spin up your tunnel. This is a critical productivity improvement, because in practice you'll end up configuring your tunnel URL in a bunch of different places like `config/application.yml` but also in external systems like when you [configure payment providers to deliver webhooks to you](/docs/billing/stripe.md).

## Usage

Once you have ngrok installed, you can start your tunnel like so, replacing `YOUR-SUBDOMAIN` with whatever subdomain you reserved in your ngrok account:

```
ngrok http 3000 --subdomain=YOUR-SUBDOMAIN
```

## Updating Your Configuration

Before your Rails application will accept connections on your tunnel hostname, you need to update `config/application.yml` with:

```yaml
BASE_URL: https://YOUR-SUBDOMAIN.ngrok.io
```

You'll also need to restart your Rails server:

```
rails restart
```

Version data entries

17 entries across 17 versions & 1 rubygems

Version Path
bullet_train-1.3.16 docs/tunneling.md
bullet_train-1.3.15 docs/tunneling.md
bullet_train-1.3.14 docs/tunneling.md
bullet_train-1.3.13 docs/tunneling.md
bullet_train-1.3.12 docs/tunneling.md
bullet_train-1.3.11 docs/tunneling.md
bullet_train-1.3.10 docs/tunneling.md
bullet_train-1.3.9 docs/tunneling.md
bullet_train-1.3.8 docs/tunneling.md
bullet_train-1.3.7 docs/tunneling.md
bullet_train-1.3.6 docs/tunneling.md
bullet_train-1.3.5 docs/tunneling.md
bullet_train-1.3.4 docs/tunneling.md
bullet_train-1.3.3 docs/tunneling.md
bullet_train-1.3.2 docs/tunneling.md
bullet_train-1.3.1 docs/tunneling.md
bullet_train-1.3.0 docs/tunneling.md