ux-research-agent-slackbot / docs /slack_setup_guide.md
debug-log
Claude Opus 4.6
feat: Insight Repository β€” GitLab μ΄ˆκΈ°ν™” + HF μžλ™ 배포
501bc8c
|
Raw History Blame Contribute Delete
5.1 kB
# UX λ¦¬μ„œμΉ˜ 봇 - Slack App μ„€μ • κ°€μ΄λ“œ
μ›Ήμ•±(Streamlit)κ³Ό μ—°λ™ν•˜μ—¬ μŠ¬λž™λ΄‡μ„ μš΄μ˜ν•˜κΈ° μœ„ν•œ Slack API μ„€μ • λ°©λ²•μž…λ‹ˆλ‹€.
## 1. μ•± 생성 (Create App)
1. [Slack API: Your Apps](https://api.slack.com/apps) νŽ˜μ΄μ§€λ‘œ μ΄λ™ν•©λ‹ˆλ‹€.
2. **"Create New App"** λ²„νŠΌμ„ ν΄λ¦­ν•©λ‹ˆλ‹€.
3. **"From scratch"**λ₯Ό μ„ νƒν•©λ‹ˆλ‹€.
4. **App Name**(예: `UX-Insight-Bot`)을 μž…λ ₯ν•˜κ³ , 봇을 μ„€μΉ˜ν•  μ›Œν¬μŠ€νŽ˜μ΄μŠ€λ₯Ό μ„ νƒν•œ λ’€ **Create App**을 λˆ„λ¦…λ‹ˆλ‹€.
## 2. κΆŒν•œ μ„€μ • (Scopes)
봇이 λ©”μ‹œμ§€λ₯Ό 읽고 μ“Έ 수 μžˆλ„λ‘ κΆŒν•œμ„ λΆ€μ—¬ν•΄μ•Ό ν•©λ‹ˆλ‹€.
1. μ™Όμͺ½ μ‚¬μ΄λ“œλ°” λ©”λ‰΄μ—μ„œ **"OAuth & Permissions"**λ₯Ό ν΄λ¦­ν•©λ‹ˆλ‹€.
2. μŠ€ν¬λ‘€μ„ λ‚΄λ € **"Scopes"** μ„Ήμ…˜μ˜ **"Bot Token Scopes"**λ₯Ό μ°ΎμŠ΅λ‹ˆλ‹€.
3. **"Add an OAuth Scope"** λ²„νŠΌμ„ 눌러 μ•„λž˜ κΆŒν•œλ“€μ„ μ°¨λ‘€λ‘œ μΆ”κ°€ν•©λ‹ˆλ‹€:
- `app_mentions:read`: 봇을 λ©˜μ…˜(@Bot)ν–ˆμ„ λ•Œ λ©”μ‹œμ§€λ₯Ό 읽을 수 μžˆμŠ΅λ‹ˆλ‹€.
- `chat:write`: 봇이 채널에 λ‹΅λ³€ λ©”μ‹œμ§€λ₯Ό 보낼 수 μžˆμŠ΅λ‹ˆλ‹€.
- `files:write`: 봇이 μ΄λ―Έμ§€λ‚˜ νŒŒμΌμ„ μ—…λ‘œλ“œν•  수 μžˆμŠ΅λ‹ˆλ‹€ (뢄석 κ²°κ³Ό 곡유 λ“±).
- `files:read`: **(μ€‘μš”)** μ‚¬μš©μžκ°€ 올린 이미지/μ˜μƒ/λ¬Έμ„œ νŒŒμΌμ„ 봇이 λ‹€μš΄λ‘œλ“œν•˜μ—¬ 뢄석할 수 μžˆμŠ΅λ‹ˆλ‹€.
- `reactions:write`: **(ν•„μˆ˜)** 봇이 λ©”μ‹œμ§€μ— 이λͺ¨μ§€(확인 ν‘œμ‹œ λ“±)λ₯Ό 달기 μœ„ν•΄ ν•„μš”ν•©λ‹ˆλ‹€.
- `channels:history`: **(ν•„μˆ˜)** 곡개 μ±„λ„μ˜ μŠ€λ ˆλ“œ λ¬Έλ§₯을 읽기 μœ„ν•΄ ν•„μš”ν•©λ‹ˆλ‹€.
- `groups:history`: **(ν•„μˆ˜)** λΉ„κ³΅κ°œ μ±„λ„μ˜ μŠ€λ ˆλ“œ λ¬Έλ§₯을 읽기 μœ„ν•΄ ν•„μš”ν•©λ‹ˆλ‹€.
- `im:history`: **(ν•„μˆ˜)** DM(1:1 λ©”μ‹œμ§€)의 μŠ€λ ˆλ“œ λ¬Έλ§₯을 읽기 μœ„ν•΄ ν•„μš”ν•©λ‹ˆλ‹€.
- `mpim:history`: **(ν•„μˆ˜)** κ·Έλ£Ή DM의 μŠ€λ ˆλ“œ λ¬Έλ§₯을 읽기 μœ„ν•΄ ν•„μš”ν•©λ‹ˆλ‹€.
## 3. μ•± μ„€μΉ˜ 및 봇 토큰 λ°œκΈ‰
1. 같은 νŽ˜μ΄μ§€ μƒλ‹¨μ˜ **"OAuth Tokens for Your Workspace"** μ„Ήμ…˜μœΌλ‘œ μ΄λ™ν•©λ‹ˆλ‹€.
2. **"Install to Workspace"** λ²„νŠΌμ„ ν΄λ¦­ν•˜κ³  ν—ˆμš©(Allow)ν•©λ‹ˆλ‹€.
3. μƒμ„±λœ **Bot User OAuth Token**을 λ³΅μ‚¬ν•˜μ—¬ μ•ˆμ „ν•œ 곳에 λ³΄κ΄€ν•©λ‹ˆλ‹€.
- ν˜•μ‹: `xoxb-...`
- μš©λ„: `.env` 파일의 `SLACK_BOT_TOKEN` κ°’μœΌλ‘œ μ‚¬μš©λ©λ‹ˆλ‹€.
## 4. μ†ŒμΌ“ λͺ¨λ“œ ν™œμ„±ν™” (Socket Mode)
Hugging Face Spaces와 같이 μ™ΈλΆ€ 접속이 μ œν•œμ μ΄κ±°λ‚˜ νƒ€μž„μ•„μ›ƒ(3초)이 μ—„κ²©ν•œ ν™˜κ²½μ—μ„œλŠ” **μ†ŒμΌ“ λͺ¨λ“œ**κ°€ κ°€μž₯ μ•ˆμ •μ μž…λ‹ˆλ‹€.
1. μ™Όμͺ½ μ‚¬μ΄λ“œλ°” λ©”λ‰΄μ—μ„œ **"Socket Mode"**λ₯Ό ν΄λ¦­ν•©λ‹ˆλ‹€.
2. **"Enable Socket Mode"** μŠ€μœ„μΉ˜λ₯Ό μΌ­λ‹ˆλ‹€.
3. 토큰 이름을 μ§€μ •(예: `socket-token`)ν•˜κ³  **Generate**λ₯Ό ν΄λ¦­ν•©λ‹ˆλ‹€.
4. μƒμ„±λœ **App-level Token**을 λ³΅μ‚¬ν•˜μ—¬ μ•ˆμ „ν•œ 곳에 λ³΄κ΄€ν•©λ‹ˆλ‹€.
- ν˜•μ‹: `xapp-...`
- μš©λ„: `.env` 파일의 `SLACK_APP_TOKEN` κ°’μœΌλ‘œ μ‚¬μš©λ©λ‹ˆλ‹€.
## 5. 이벀트 ꡬ독 μ„€μ • (Event Subscriptions)
**주의: 이 섀정은 'OAuth & Permissions' 메뉴가 μ•„λ‹ˆλΌ 'Event Subscriptions' λ©”λ‰΄μ—μ„œ μ§„ν–‰ν•΄μ•Ό ν•©λ‹ˆλ‹€.**
1. μ™Όμͺ½ μ‚¬μ΄λ“œλ°” λ©”λ‰΄μ—μ„œ **"Event Subscriptions"**λ₯Ό ν΄λ¦­ν•©λ‹ˆλ‹€.
2. **"Enable Events"** μŠ€μœ„μΉ˜λ₯Ό μΌ­λ‹ˆλ‹€.
3. μŠ€ν¬λ‘€μ„ λ‚΄λ € **"Subscribe to bot events"** μ„Ήμ…˜μ„ μ°ΎμŠ΅λ‹ˆλ‹€.
4. **"Add Bot User Event"** λ²„νŠΌμ„ ν΄λ¦­ν•©λ‹ˆλ‹€.
5. 검색창에 **`message.im`**을 μž…λ ₯ν•˜μ—¬ μ„ νƒν•©λ‹ˆλ‹€. (μ„€λͺ…: Message was posted in a direct message channel)
- λ§Œμ•½ λͺ©λ‘μ— μ—†λ‹€λ©΄ `message.channels` 등을 λ¨Όμ € μΆ”κ°€ν•΄λ³΄μ„Έμš”. 보톡 `message.im`은 λ¦¬μŠ€νŠΈμ— μžˆμŠ΅λ‹ˆλ‹€.
6. `app_mention`도 ν•¨κ»˜ μΆ”κ°€λ˜μ–΄ μžˆλŠ”μ§€ ν™•μΈν•©λ‹ˆλ‹€.
7. ν•˜λ‹¨μ˜ **"Save Changes"** λ²„νŠΌμ„ κΌ­ λˆ„λ¦…λ‹ˆλ‹€.
## 6. App Home μ„€μ • (μ€‘μš”: DM ν™œμ„±ν™”)
μ‚¬μš©μžκ°€ λ΄‡μ—κ²Œ 1:1 λ©”μ‹œμ§€(DM)λ₯Ό 보낼 수 μžˆλ„λ‘ ν•˜λ €λ©΄ 이 섀정이 ν•„μˆ˜μž…λ‹ˆλ‹€.
1. μ™Όμͺ½ μ‚¬μ΄λ“œλ°” λ©”λ‰΄μ—μ„œ **"App Home"**을 ν΄λ¦­ν•©λ‹ˆλ‹€.
2. μŠ€ν¬λ‘€μ„ λ‚΄λ € **"Show Tabs"** μ„Ήμ…˜μ˜ **"Messages Tab"**을 μ°ΎμŠ΅λ‹ˆλ‹€.
3. **"Allow users to send Slash commands and messages from the messages tab"** μ²΄ν¬λ°•μŠ€λ₯Ό **체크**ν•©λ‹ˆλ‹€.
- 이 μ˜΅μ…˜μ΄ 켜져 μžˆμ–΄μ•Ό λ΄‡κ³Όμ˜ 1:1 μ±„νŒ…μ°½μ΄ ν™œμ„±ν™”λ©λ‹ˆλ‹€.
4. **"Allow users to send Slash commands and messages from the messages tab"** λ°”λ‘œ μ•„λž˜μ— μžˆλŠ” **Review Link**λ‚˜ κ΄€λ ¨ 섀정을 ν™•μΈν•˜μ„Έμš”. (보톡 체크만 ν•˜λ©΄ λ©λ‹ˆλ‹€)
## 7. μ•± μž¬μ„€μΉ˜ (κ°€μž₯ μ€‘μš”!)
**섀정을 λ³€κ²½ν–ˆλ‹€λ©΄ λ°˜λ“œμ‹œ 앱을 μž¬μ„€μΉ˜ν•΄μ•Ό μ μš©λ©λ‹ˆλ‹€.**
1. μ™Όμͺ½ μ‚¬μ΄λ“œλ°” λ©”λ‰΄μ—μ„œ **"Install App"**을 ν΄λ¦­ν•©λ‹ˆλ‹€.
2. **"Reinstall to Workspace"** λ²„νŠΌμ„ ν΄λ¦­ν•˜μ—¬ λ‹€μ‹œ μ„€μΉ˜(ν—ˆμš©)ν•©λ‹ˆλ‹€.
- 이 과정을 거쳐야 App Home μ„€μ •μ΄λ‚˜ κΆŒν•œ λ³€κ²½ 사항이 μ‹€μ‹œκ°„μœΌλ‘œ λ°˜μ˜λ©λ‹ˆλ‹€.
## 8. ν™˜κ²½ λ³€μˆ˜ 등둝
λ°œκΈ‰λ°›μ€ 토큰을 ν”„λ‘œμ νŠΈμ˜ `.env` 파일과 Hugging Face Secrets에 등둝해야 ν•©λ‹ˆλ‹€.
```bash
SLACK_BOT_TOKEN=xoxb-xxxxxxxxx...
SLACK_APP_TOKEN=xapp-xxxxxxxxx...
```
이제 Slack API 섀정이 μ™„λ£Œλ˜μ—ˆμŠ΅λ‹ˆλ‹€!
이 섀정이 λλ‚˜λ©΄ μ½”λ“œλ₯Ό μ—…λ°μ΄νŠΈν•˜μ—¬ 봇을 μ‹€ν–‰ν•  수 μžˆμŠ΅λ‹ˆλ‹€.