@@ -8,12 +8,6 @@ Messaging and Voice Channels
8
8
9
9
.. edit-link ::
10
10
11
- If you're testing this on your local computer (i.e. not a server), you
12
- will need to use `ngrok <https://rasa.com/docs/rasa-x/get-feedback-from-test-users/#use-ngrok-for-local-testing >`_.
13
- This gives your machine a domain name so that Facebook, Slack, etc. know where to send messages to
14
- reach your local machine.
15
-
16
-
17
11
To make your assistant available on a messaging platform you need to provide credentials
18
12
in a ``credentials.yml `` file.
19
13
An example file is created when you run ``rasa init ``, so it's easiest to edit that file
@@ -44,3 +38,31 @@ Learn how to make your assistant available on:
44
38
connectors/rocketchat
45
39
connectors/mattermost
46
40
connectors/custom-connectors
41
+
42
+
43
+ .. _using-ngrok :
44
+
45
+ Testing Channels on Your Local Machine with Ngrok
46
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47
+
48
+ You can use `ngrok <https://ngrok.com/ >`_ to create a connection to your local
49
+ computer that is publicly available on the internet.
50
+ You don't need this when running Rasa on a server because, you can set up a domain
51
+ name to point to that server's IP address, or use the IP address itself.
52
+
53
+ After installing ngrok, run:
54
+
55
+ .. copyable ::
56
+
57
+ ngrok http 5005; rasa run
58
+
59
+ Your webhook address will look like the following:
60
+
61
+ - ``https://yyyyyy.ngrok.io/webhooks/<CHANNEL>/webhook ``, e.g.
62
+ - ``https://yyyyyy.ngrok.io/webhooks/facebook/webhook ``
63
+
64
+ .. warning ::
65
+
66
+ With the free-tier of ngrok, you can run into limits on how many connections you can make per minute.
67
+ As of writing this, it is set to 40 connections / minute.
68
+
0 commit comments