Sha256: bcde986ece5beda630e0b5bedd5a48b86c41d214a31c25b746fc118c426b3f43

Contents?: true

Size: 1.48 KB

Versions: 15

Compression:

Stored size: 1.48 KB

Contents

---
title: Local Development
---

## Prerequisites

Stealth bundles [Sidekiq](https://github.com/mperham/sidekiq) in order to process background jobs. Therefore, it is required to run Redis in order to boot up a Stealth server.

## Starting the Server

Once you have made your current working directory your Stealth bot, you can install gems:

```
bundle install
```

To boot your bot:

```
stealth server
```

You can also use `stealth s`. This will use the [foreman](https://github.com/ddollar/foreman) gem to start the web server and Sidekiq processes together. Redis will have to be running for the server to start.

That's it! You are now running Stealth.

## Introspectable Tunnels to localhost

When developing locally, messaging services require access to your server in order to transmit user messages. We recommend downloading and using [ngrok](https://ngrok.com/download) to create a local tunnel to your development machine.

1. Download [ngrok](https://ngrok.com/download)
2. Start your Stealth server as detailed above.
3. Open up an ngrok tunnel to your Stealth server and port (default 5000) like this: `ngrok http 5000`. ngrok will output a unique ngrok local tunnel URL to your machine.

When you provide your local ngrok URL to a messaging service, you will have to add `/incoming/<service>`. For example:

 * `https://abc1234.ngrok.io/incoming/facebook`
 * `https://abc1234.ngrok.io/incoming/twilio`

More details on service specific settings can be found on the GitHub page for each service gem.

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
stealth-1.1.6 docs/02-local-development.md
stealth-1.1.5 docs/02-local-development.md
stealth-1.1.4 docs/02-local-development.md
stealth-1.1.3 docs/02-local-development.md
stealth-1.1.2 docs/02-local-development.md
stealth-1.1.1 docs/02-local-development.md
stealth-1.1.0 docs/02-local-development.md
stealth-1.1.0.rc3 docs/02-local-development.md
stealth-1.1.0.rc2 docs/02-local-development.md
stealth-1.1.0.rc1 docs/02-local-development.md
stealth-1.0.4 docs/02-local-development.md
stealth-1.0.3 docs/02-local-development.md
stealth-1.0.2 docs/02-local-development.md
stealth-1.0.1 docs/02-local-development.md
stealth-1.0.0 docs/02-local-development.md