|
Download docs/slack_setup_guide.md from YGCXLab/ux-research-agent-slackbot: direct link, hf CLI and curl.
- Browser
- Download file 5.1 kB
-
https://huggingface.co/spaces/YGCXLab/ux-research-agent-slackbot/resolve/main/docs/slack_setup_guide.md
- Command line
-
hf download hf://spaces/YGCXLab/ux-research-agent-slackbot/docs/slack_setup_guide.md
-
curl -L -o slack_setup_guide.md https://huggingface.co/spaces/YGCXLab/ux-research-agent-slackbot/resolve/main/docs/slack_setup_guide.md
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 μ€μ μ΄ μλ£λμμ΅λλ€! | |
| μ΄ μ€μ μ΄ λλλ©΄ μ½λλ₯Ό μ λ°μ΄νΈνμ¬ λ΄μ μ€νν μ μμ΅λλ€. | |