Skip to content

Commit dee36da

Browse files
committed
Update the getting started guide
1 parent 90c0ae0 commit dee36da

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/guides/getting-started-with-bolt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ The default constructor expects the following two env variables exist when start
154154

155155
|Env Variable|Description|
156156
|-|-|
157-
|**SLACK_BOT_TOKEN**|The valid bot token value starting with `xoxb-` in your development workspace. To issue a bot token, you need to install your Slack App that has a bot user to your development workspace. Visit the [Slack App configuration page](http://api.slack.com/apps), choose the app you're working on, and go to **Settings** > **Install App** on the left pane. <br/><br/> If you run an app that is installable for multiple workspaces, no need to specify this. Consult [App Distribution (OAuth)]({{ site.url | append: site.baseurl }}/guides/app-distribution) for further information instead.|
157+
|**SLACK_BOT_TOKEN**|The valid bot token value starting with `xoxb-` in your development workspace. To issue a bot token, you need to install your Slack App that has a bot user to your development workspace. Visit the [Slack App configuration page](http://api.slack.com/apps), choose the app you're working on, and go to **Settings** > **Install App** on the left pane (Add [`app_mentions:read`](https://api.slack.com/scopes/app_mentions:read) bot scope if you see the message saying "Please add at least one feature or permission scope to install your app.").<br/><br/> If you run an app that is installable for multiple workspaces, no need to specify this. Consult [App Distribution (OAuth)]({{ site.url | append: site.baseurl }}/guides/app-distribution) for further information instead.|
158158
|**SLACK_SIGNING_SECRET**|The secret value shared only with the Slack Platform. It is used for verifying incoming requests from Slack. Request verification is crucial for security as Slack apps have internet-facing endpoints. To know the value, visit the [Slack App configuration page](http://api.slack.com/apps), choose the app you're working on, go to **Settings** > **Basic Information** on the left pane, and find **App Credentials** > **Signing Secret** on the page. Refer to [the document](https://api.slack.com/docs/verifying-requests-from-slack) for further information.|
159159

160160
If you prefer configuring an **App** in a different way, write some code to initialize **AppConfig** on your own.
@@ -284,7 +284,7 @@ OK, you should be done. Just in case, here is the checklist:
284284

285285
* ✅ JDK 8 or higher installed (if not, run `brew install openjdk@11` for macOS / visit [OpenJDK website](https://openjdk.java.net/install/) for others)
286286
* ✅ Gradle installed (if not, run `brew install gradle` for macOS / visit [their website](https://gradle.org/) for others)
287-
*`build.gradle` with valid Kolitn language settings and **bolt-jetty** dependency
287+
*`build.gradle` with valid Kotlin language settings and **bolt-jetty** dependency
288288
*`src/main/kotlin/MyApp.kt` with a main method
289289
*[Create a Slack App](https://api.slack.com/apps?new_app=1), add [`app_mentions:read`](https://api.slack.com/scopes/app_mentions:read) bot scope, install the app to your development workspace
290290
* ✅ Copy [**Bot User OAuth Access Token**](https://api.slack.com/docs/token-types#bot) and [**Signing Secret**](https://api.slack.com/docs/verifying-requests-from-slack) from [your Slack App admin pages](https://api.slack.com/apps) and set them to env variables

docs/guides/ja/getting-started-with-bolt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ server.start();
154154

155155
|環境変数名|説明|
156156
|-|-|
157-
|**SLACK_BOT_TOKEN**|開発用ワークスペース(Development Workspace)での有効なボットトークン(形式は `xoxb-` から始まります)です。このボットトークンを発行するには Slack アプリを開発用ワークスペースにインストールする必要があります。[Slack アプリ管理画面](http://api.slack.com/apps)にアクセスして、開発中のアプリを選択、左ペインの **Settings** > **Install App** から実行します。 <br/><br/>複数のワークスペースにインストール可能なアプリとして実行する場合はこの環境変数を設定する必要はありません。そのようなアプリの開発については「[アプリの配布 (OAuth)]({{ site.url | append: site.baseurl }}/guides/ja/app-distribution)」を参考にしてください。|
157+
|**SLACK_BOT_TOKEN**|開発用ワークスペース(Development Workspace)での有効なボットトークン(形式は `xoxb-` から始まります)です。このボットトークンを発行するには Slack アプリを開発用ワークスペースにインストールする必要があります。[Slack アプリ管理画面](http://api.slack.com/apps)にアクセスして、開発中のアプリを選択、左ペインの **Settings** > **Install App** から実行します(「Please add at least one feature or permission scope to install your app.」というメッセージが表示されている場合は [`app_mentions:read`](https://api.slack.com/scopes/app_mentions:read) bot scope を追加してください)。 <br/><br/>複数のワークスペースにインストール可能なアプリとして実行する場合はこの環境変数を設定する必要はありません。そのようなアプリの開発については「[アプリの配布 (OAuth)]({{ site.url | append: site.baseurl }}/guides/ja/app-distribution)」を参考にしてください。|
158158
|**SLACK_SIGNING_SECRET**|この秘密の値は Slack プラットフォームとだけ共有する情報です。これは Slack アプリが受けたリクエストが本当に Slack API サーバーからのリクエストであるかを検証するために使用します。Slack アプリは公開されたエンドポイントを持つため、リクエストの検証はセキュリティのために重要です。この値は [Slack アプリ管理画面](http://api.slack.com/apps)にアクセスして、開発中のアプリを選択、左ペインの **Settings** > **Basic Information** へ遷移して **App Credentials** > **Signing Secret** の情報を表示させると確認できます。より詳細な情報は「[Verifying requests from Slack(英語)](https://api.slack.com/docs/verifying-requests-from-slack)」を参考にしてください。|
159159

160160
なお、**App** を別の方法(例: 規定の環境変数名を使わない)で初期化したい場合は **AppConfig** を自前で初期化するコードを書いてください。
@@ -285,7 +285,7 @@ fun main() {
285285

286286
* ✅ JDK 8 またはそれよりも新しいバージョンをインストール(もしまだであれば macOS は `brew install openjdk@11` を実行 / 他の OS 環境の場合は [OpenJDK のウェブサイト](https://openjdk.java.net/install/) へアクセス)
287287
* ✅ Gradle をインストール(もしまだであれば macOS は `brew install gradle` を実行 / 他の OS 環境の場合は [公式サイト](https://gradle.org/) へアクセス)
288-
*`build.gradle` **bolt-jetty** 依存ライブラリを追加、適切な **application** プラグイン設定も追加
288+
*`build.gradle` に適切な Kotlin の言語設定と **bolt-jetty** 依存ライブラリを追加
289289
* ✅ main メソッドを持つ `src/main/kotlin/MyApp.kt` を作成
290290
*[Slack アプリをつくり](https://api.slack.com/apps?new_app=1) [`app_mentions:read`](https://api.slack.com/scopes/app_mentions:read) という Bot Token Scope を追加、アプリを開発用ワークスペースにインストール
291291
*[Slack アプリ管理画面](https://api.slack.com/apps) から [**Bot User OAuth Access Token**](https://api.slack.com/docs/token-types#bot)[**Signing Secret**](https://api.slack.com/docs/verifying-requests-from-slack) の値をコピーしてきて環境変数に設定

0 commit comments

Comments
 (0)