Sha256: 859fd51f43c3291014b52c1a39730fa3ea6e96d4886e0d5977d0044218ab1bef

Contents?: true

Size: 1.19 KB

Versions: 34

Compression:

Stored size: 1.19 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 $25/month paid plan 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:

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

You'll also need to restart your Rails server:

```
rails restart
```

Version data entries

34 entries across 34 versions & 1 rubygems

Version Path
bullet_train-1.1.0 docs/tunneling.md
bullet_train-1.0.99 docs/tunneling.md
bullet_train-1.0.98 docs/tunneling.md
bullet_train-1.0.97 docs/tunneling.md
bullet_train-1.0.96 docs/tunneling.md
bullet_train-1.0.95 docs/tunneling.md
bullet_train-1.0.93 docs/tunneling.md
bullet_train-1.0.92 docs/tunneling.md
bullet_train-1.0.90 docs/tunneling.md
bullet_train-1.0.89 docs/tunneling.md
bullet_train-1.0.88 docs/tunneling.md
bullet_train-1.0.87 docs/tunneling.md
bullet_train-1.0.86 docs/tunneling.md
bullet_train-1.0.85 docs/tunneling.md