รันเซิร์ฟเวอร์ Connect
Control Center Connect ดำเนินการลงชื่อเข้าใช้ผู้ให้บริการ (GitHub, Google Calendar, Linear, Slack) ให้กับเซิร์ฟเวอร์ที่ยังไม่ได้ลงทะเบียนแอปของตัวเอง คู่มือนี้แสดงวิธีรัน Connect ของคุณเอง เพื่อให้แอปของผู้ให้บริการ คีย์ลับ และรายชื่อเซิร์ฟเวอร์ที่ได้รับอนุญาตให้ใช้ทั้งหมดอยู่กับคุณ
Connect มองเห็นอะไรและมองไม่เห็นอะไร ดูได้ที่ อ้างอิง Connect อ่านก่อนหากคุณกำลังตัดสินใจว่าจะรันหรือไม่
ข้อกำหนดเบื้องต้น
หัวข้อที่มีชื่อว่า “ข้อกำหนดเบื้องต้น”- ที่อยู่ HTTPS สาธารณะสำหรับ Connect เช่น
https://connect.example.comอยู่หลังพร็อกซีที่ยุติ TLS เท่านั้นhttpธรรมดาใช้ได้เฉพาะบน loopback - Docker หรือ
cc_serverที่คุณสามารถรีสตาร์ตพร้อมตัวแปรสภาพแวดล้อมเพิ่มเติมได้ - สิทธิ์ในการลงทะเบียนแอปกับผู้ให้บริการทุกรายที่คุณต้องการให้บริการ
- เซิร์ฟเวอร์ที่จะใช้งาน และเจ้าของเซิร์ฟเวอร์ที่คุณติดต่อได้ตลอดเวลา: เซิร์ฟเวอร์แต่ละตัวมี id การติดตั้งที่ต้องถูกเพิ่มในรายการอนุญาตของ Connect
ขั้นตอนที่ 1: เลือกที่อยู่
หัวข้อที่มีชื่อว่า “ขั้นตอนที่ 1: เลือกที่อยู่”เลือกและเก็บที่อยู่ไว้ตั้งแต่ตอนนี้ CONNECT_PUBLIC_URL เป็นส่วนหนึ่งของทุกอย่างที่ Connect ทำ: ลายเซ็นคำขอ ข้อมูลรับรองที่ถูกปิดผนึก URL การเปลี่ยนเส้นทางของผู้ให้บริการ และ id การติดตั้งของแต่ละเซิร์ฟเวอร์ ล้วนผูกกับมัน การเปลี่ยนแปลงภายหลังหมายถึงต้องลงทะเบียนการเปลี่ยนเส้นทางใหม่ และทุกคนต้องลงชื่อเข้าใช้อีกครั้ง
ขั้นตอนที่ 2: ลงทะเบียนแอปของผู้ให้บริการ
หัวข้อที่มีชื่อว่า “ขั้นตอนที่ 2: ลงทะเบียนแอปของผู้ให้บริการ”ลงทะเบียนเฉพาะผู้ให้บริการที่คุณต้องการให้บริการ ผู้ให้บริการที่ตัวแปรไม่ครบจะถูกตัดออกจากการตั้งค่าของ Connect และเซิร์ฟเวอร์จะเห็นว่ามันใช้ไม่ได้ ในตารางด้านล่าง <base> คือ CONNECT_PUBLIC_URL ของคุณ
| ผู้ให้บริการ | ลงทะเบียน | เก็บไว้ |
|---|---|---|
| GitHub App | Callback URL <base>/oauth/github/callback Setup URL <base>/oauth/github/setup และเปิด Redirect on update ปล่อย Request user authorization (OAuth) during installation ให้ปิดไว้: เมื่อเปิด GitHub จะไม่สนใจ Setup URL เปิด Expire user authorization tokens ไว้ |
App id, slug, client id, client secret, a private key |
OAuth client ชนิด Web application โดยมี redirect URI คือ <base>/oauth/google/callback และเปิดใช้ Google Calendar API |
client id, client secret | |
| Linear | แอป OAuth ที่มี callback URL คือ <base>/oauth/linear/callback และ <base>/oauth/linear_app/callback |
เฉพาะ client id |
| Slack | Redirect URL <base>/oauth/slack_oidc/callback และ <base>/oauth/slack/callback Event Subscriptions อยู่ที่ <base>/v1/hooks/slack/events (app_mention, message.*, assistant_thread_*, app_uninstalled, tokens_revoked) Slash command อยู่ที่ <base>/v1/hooks/slack/commands เปิด token rotation |
App id, client id, client secret, signing secret |
ให้สิทธิ์ที่เก็บของ GitHub App ดังนี้: Metadata อ่าน, Contents อ่านและเขียน, Pull requests อ่านและเขียน, Issues อ่านและเขียน และ Checks, Actions กับ Commit statuses อ่าน เพื่อให้คำขอรีวิวของทีมทำงานได้ ให้เพิ่ม Members อ่านของ organization Webhook ปิดไว้ได้: เซิร์ฟเวอร์จะทำการโพลล์
Connect ต้องการ private key ของ GitHub App (Generate a private key ในการตั้งค่าของ App) โดยใช้ลงนามคำขอของ App ที่หาการติดตั้งซึ่งครอบคลุมรีโพสิทอรี (หรือเมื่อรีโพสิทอรีไม่มี ก็คือการติดตั้งของเจ้าของ) และออกโทเค็นการติดตั้งสำหรับรีโพสิทอรีเดียว โดยแต่ละครั้งทำหลังจากการลงชื่อเข้าใช้ของบุคคลที่ขอพิสูจน์แล้วว่าเข้าถึงรีโพสิทอรีนั้นได้
เซิร์ฟเวอร์ทุกตัวบน Connect ของคุณใช้บอตของ App ร่วมกัน บอตอาจอ่าน คอมเมนต์ ติดป้าย และแสดงปฏิกิริยาในฐานะบอตสำหรับเซิร์ฟเวอร์ใดก็ได้ การรีวิว pull request ในฐานะบอตได้เฉพาะสำหรับเซิร์ฟเวอร์ที่คุณระบุไว้ใน CONNECT_GITHUB_REVIEW_BOT_INSTALLS (id การติดตั้งของมัน คั่นด้วยจุลภาค) เซิร์ฟเวอร์อื่นทั้งหมดจะเผยแพร่รีวิวด้วยโทเค็นของผู้รีวิวเอง การพุชไม่เคยทำในฐานะบอต หากต้องการให้เซิร์ฟเวอร์ของคุณเองรีวิวในฐานะบอต ให้เพิ่ม id การติดตั้งของมันในนั้นแล้วรีสตาร์ต เก็บไฟล์คีย์ไว้เป็นความลับ เหมือนคีย์การปิดผนึก Linear ไม่ต้องการความลับ: Connect ส่งโค้ดกลับให้เซิร์ฟเวอร์ ซึ่งแลกเปลี่ยนโค้ดนั้นด้วยตัวเอง
ขั้นตอนที่ 3: รวบรวม id การติดตั้ง
หัวข้อที่มีชื่อว่า “ขั้นตอนที่ 3: รวบรวม id การติดตั้ง”Connect จะตอบเฉพาะเซิร์ฟเวอร์ที่อยู่ในรายการอนุญาต บนเซิร์ฟเวอร์แต่ละตัว ให้ชี้ไปยัง Connect ของคุณ แล้วอ่าน id การติดตั้งของมัน:
- ไปที่ การตั้งค่า → เซิร์ฟเวอร์ → ลงชื่อเข้าใช้ครั้งเดียว เปิดการ์ด Control Center Connect และเลือก ใช้เซิร์ฟเวอร์ Connect ที่กำหนดเอง
- ป้อนที่อยู่ของคุณแล้วบันทึก การ์ดจะแสดง id การติดตั้ง ของเซิร์ฟเวอร์
ในเทอร์มินัลของโฮสต์เซิร์ฟเวอร์ ขั้นตอนเดียวกันเป็นดังนี้:
cc_server connect enable --url https://connect.example.comcc_server connect statusstatus จะพิมพ์ id การติดตั้ง จนกว่าจะถึงขั้นตอนที่ 5 จะแสดง install_blocked ซึ่งเป็นสิ่งที่คาดไว้
id การติดตั้งได้มาจากที่อยู่ของ Connect ดังนั้นเซิร์ฟเวอร์เดียวกันจะมี id ต่างกันสำหรับ Connect แต่ละตัว และจะเปลี่ยนก็ต่อเมื่อเจ้าของของมันหมุนเวียนคีย์
ขั้นตอนที่ 4: สร้างคีย์การปิดผนึก
หัวข้อที่มีชื่อว่า “ขั้นตอนที่ 4: สร้างคีย์การปิดผนึก”Connect จะเข้ารหัสข้อมูลรับรองทุกชิ้นที่ส่งกลับด้วยคีย์การปิดผนึก สร้างหนึ่งคีย์และเก็บไว้เป็นไฟล์ลับ:
docker run --rm ghcr.io/samuelalev/cc-connect:latest \ cc-connect-config seal-key > seal_keyschmod 600 seal_keysการทำคีย์การปิดผนึกหายจะทำให้ทุกคนต้องออกจากระบบ: หากไม่มีคีย์นี้ จะเปิดการปิดผนึกใด ๆ ไม่ได้
ขั้นตอนที่ 5: เริ่มคอนเทนเนอร์
หัวข้อที่มีชื่อว่า “ขั้นตอนที่ 5: เริ่มคอนเทนเนอร์”ทุกการเผยแพร่จะเผยแพร่ ghcr.io/samuelalev/cc-connect พร้อมหลักฐานต้นทางของการสร้าง ในระบบโปรดักชันให้ปักแท็กเวอร์ชันไว้
docker run -d --name cc-connect -p 8790:8790 \ -e CONNECT_PUBLIC_URL=https://connect.example.com \ -e CONNECT_ALLOWED_INSTALLS=<install id>,<install id> \ -e CONNECT_SEAL_KEYS_FILE=/run/secrets/seal_keys \ -v "$PWD/seal_keys:/run/secrets/seal_keys:ro" \ -e CONNECT_GITHUB_APP_ID=123456 \ -e CONNECT_GITHUB_APP_SLUG=acme-control-center \ -e CONNECT_GITHUB_CLIENT_ID=Iv23li0123456789abcd \ -e CONNECT_GITHUB_CLIENT_SECRET_FILE=/run/secrets/github \ -v "$PWD/github_secret:/run/secrets/github:ro" \ -e CONNECT_GITHUB_APP_PRIVATE_KEY_FILE=/run/secrets/github_key \ -v "$PWD/github_app_key.pem:/run/secrets/github_key:ro" \ -v cc-connect-data:/data \ ghcr.io/samuelalev/cc-connect:latestชี้พร็อกซีย้อนกลับของคุณไปที่พอร์ต 8790 และตั้งค่า CONNECT_TRUST_PROXY เป็นจำนวนพร็อกซีที่อยู่หน้า Connect เพื่อให้ขีดจำกัดต่อที่อยู่ของมันเห็นที่อยู่ของแต่ละไคลเอนต์ อิมเมจรันด้วยผู้ใช้ที่ไม่มีสิทธิ์พิเศษ เก็บสถานะไว้ใน volume /data และมีการตรวจสุขภาพในตัว (cc-connect --healthcheck ซึ่งทดสอบ /healthz: โปรเซสตอบกลับ) /readyz ยังตรวจว่าที่เก็บสถานะและการผูกตอบสนอง และหาก Redis ถูกใช้ก็ยังรันด้วย maxmemory-policy noeviction อยู่ ให้ชี้การตรวจความพร้อมของ orchestrator ไปที่นั่น
หน้ายินยอมการลงชื่อเข้าใช้ตอบกลับด้วยการ POST แบบฟอร์มที่ Connect ยอมรับเฉพาะจากหน้าของตัวเอง: Sec-Fetch-Site เมื่อถูกส่งมา ต้องเป็น same-origin และ Origin เมื่อถูกส่งมา ต้องเป็น origin ของ CONNECT_PUBLIC_URL การ POST ที่ไม่มีทั้งสองอย่างจะถูกปฏิเสธ ดังนั้นพร็อกซีต้องส่งผ่านทั้งสองส่วนหัวโดยไม่เปลี่ยนแปลง และ CONNECT_PUBLIC_URL ต้องเป็นที่อยู่ที่เบราว์เซอร์ของคนใช้งานจริงใช้ หากการดำเนินการต่อในหน้านั้นแสดง “ลิงก์นี้หมดอายุแล้ว” เสมอ และบันทึกแสดง oauth.done_refused พร้อมเหตุผล origin หรือ no_origin แสดงว่าอย่างใดอย่างหนึ่งในสองอย่างนั้นผิด
เมื่อการตั้งค่าเปิดกว้าง ไม่ปลอดภัย หรือตั้งค่าไว้เพียงครึ่งเดียว Connect จะปฏิเสธการเริ่มทำงาน (รหัสออก 78) และพิมพ์ว่าตัวแปรใดผิด รายการอนุญาตที่หายไป ที่อยู่ http ที่ไม่ได้อยู่บน loopback คีย์การปิดผนึกที่รูปแบบผิด หรือการตั้งค่า NAME และ NAME_FILE พร้อมกัน จะทำให้มันหยุด
จุดตรวจสอบ: บนเซิร์ฟเวอร์แต่ละตัว การ์ด Connect แสดง ปกติ และ การลงชื่อเข้าใช้แต่ละประเภทเกิดขึ้นที่ไหน จะติดป้าย Connect ให้ผู้ให้บริการแต่ละรายที่คุณลงทะเบียนไว้ cc_server connect status จะพิมพ์ Health: ok และช่องทางเดียวกัน
การโฮสต์ Connect ภายใน cc_server
หัวข้อที่มีชื่อว่า “การโฮสต์ Connect ภายใน cc_server”เซิร์ฟเวอร์สามารถโฮสต์ Connect เองได้โดยไม่ต้องใช้คอนเทนเนอร์แยก บริการที่ mount ไว้เป็นตัวเดียวกับที่อิมเมจรัน
- ใส่ตัวแปร
CONNECT_*ไว้ในไฟล์.envของเซิร์ฟเวอร์ ตามขั้นตอนที่ 5 เซิร์ฟเวอร์จะปฏิเสธการเริ่มทำงานเมื่อมีข้อมูลลับของ Connect ตัวใดถูก export ไว้ในสภาพแวดล้อมของมัน รวมถึงCONNECT_SENTRY_DSNด้วย - เพิ่ม
CC_SERVER_CONNECT_HOST=on - รีสตาร์ตเซิร์ฟเวอร์ บันทึกของมันจะพิมพ์
embedded Connect at <url>
CC_SERVER_CONNECT_HOST=onCONNECT_ALLOWED_INSTALLS=<install id>CONNECT_SEAL_KEYS=<output of cc-connect-config seal-key>CONNECT_GITHUB_APP_ID=123456CONNECT_GITHUB_APP_SLUG=acme-control-centerCONNECT_GITHUB_CLIENT_ID=Iv23li0123456789abcdCONNECT_GITHUB_CLIENT_SECRET=<secret>CONNECT_GITHUB_APP_PRIVATE_KEY_FILE=/etc/cc/github_app_key.pemจากนั้น Connect จะให้บริการที่ <server>/connect:
CONNECT_PUBLIC_URLมีค่าเริ่มต้นเป็นต้นทางของ URL สาธารณะของเซิร์ฟเวอร์บวก/connectเมื่ออยู่หลังพร็อกซี ให้ตั้งค่านี้อย่างชัดเจน เส้นทางต้องเป็น/connectเท่านั้น และต้องใช้ HTTPS เว้นแต่จะเป็น loopback- มีเพียงตัวแปร
CONNECT_*เท่านั้นที่ส่งไปยังบริการที่ mount ไว้ ดังนั้นมันจะไม่ยืมแอปผู้ให้บริการของเซิร์ฟเวอร์เอง CONNECT_ALLOWED_INSTALLSยังจำเป็นอยู่ รวมถึงสำหรับเซิร์ฟเวอร์ที่โฮสต์มันเองด้วย- การ mount ที่ตั้งค่าผิดจะทำให้เซิร์ฟเวอร์เริ่มทำงานไม่ได้ แทนที่จะให้บริการตัวกลางแบบเปิด
- เซิร์ฟเวอร์ demo จะไม่ mount มันเด็ดขาด
ลงทะเบียนการเปลี่ยนเส้นทางของผู้ให้บริการด้วย https://<server>/connect แล้วชี้เซิร์ฟเวอร์แต่ละตัว (รวมถึงตัวที่โฮสต์มันด้วย) ไปยังที่อยู่นั้นตามที่อธิบายในขั้นตอนที่ 3
อ้างอิงการตั้งค่า
หัวข้อที่มีชื่อว่า “อ้างอิงการตั้งค่า”การตั้งค่าแต่ละรายการคือตัวแปรสภาพแวดล้อมหนึ่งตัว ข้อมูลลับใดก็ได้สามารถอ่านจากไฟล์ที่ mount ไว้ได้: ใช้ NAME_FILE แทน NAME Connect จะอ่านไฟล์นั้นใหม่ไม่เกินทุก 30 วินาที และคงค่าที่ใช้ได้ล่าสุดไว้ ข้อมูลลับที่ระบุว่า สองค่า จะยอมรับ NAME_PREVIOUS (หรือ NAME_PREVIOUS_FILE) ด้วยระหว่างการหมุนเวียน
ที่อยู่และการเข้าถึง
หัวข้อที่มีชื่อว่า “ที่อยู่และการเข้าถึง”| ตัวแปร | ค่าเริ่มต้น | ความหมาย |
|---|---|---|
CONNECT_PUBLIC_URL |
จำเป็น | URL สาธารณะรูปแบบมาตรฐาน HTTPS หรือ http ที่ loopback เท่านั้น มี path หมายถึงการ mount ห้ามมี query string หรือ fragment |
CONNECT_ALLOWED_INSTALLS |
จำเป็น | id การติดตั้งคั่นด้วยจุลภาค จะรับ * ได้เฉพาะเมื่อใช้คู่กับ CONNECT_SIGNED_CONFIG_FILE |
CONNECT_DENY_INSTALLS |
id การติดตั้งที่จะถูกปฏิเสธแม้ได้รับอนุญาตแล้ว | |
CONNECT_GITHUB_ALLOWED_OWNERS |
id เจ้าของ GitHub แบบตัวเลข เมื่อตั้งค่าแล้วจะออกโทเค็นรีโปเฉพาะรีโปที่เจ้าของเหล่านี้เป็นเจ้าของ มันไม่ได้จำกัดว่าใครลงชื่อเข้าใช้ บุคคลที่ได้รับอนุญาตให้ใช้ Connect นี้ยังได้รับโทเค็นผู้ใช้ของ App ของตนเอง หากต้องการให้บริการองค์กรเดียว ให้คง App ไว้เป็นส่วนตัวขององค์กรนั้น | |
CONNECT_GITHUB_REVIEW_BOT_INSTALLS |
id การติดตั้งที่อนุญาตให้บอตของ App รีวิว pull request ค่าเริ่มต้นคือว่าง * ถูกปฏิเสธ และแต่ละ id ต้องได้รับอนุญาตด้วย |
|
CONNECT_HOST, CONNECT_PORT |
0.0.0.0, 8790 |
ที่อยู่และพอร์ตสำหรับผูก |
CONNECT_TRUST_PROXY |
0 |
จำนวนฮ็อปของพร็อกซีที่เชื่อถือได้ใน X-Forwarded-For (0 ถึง 8) ใช้สำหรับขีดจำกัดต่อที่อยู่ ค่าการ hint เครือข่ายของหน้าลงชื่อเข้าใช้ และที่อยู่ที่บันทึกไว้เท่านั้น เมื่ออยู่หลังพร็อกซี 0 จะนับทุกไคลเอนต์เป็นพร็อกซี และบันทึกจะบอกไว้หนึ่งครั้ง |
ช่องทางผู้ให้บริการ
หัวข้อที่มีชื่อว่า “ช่องทางผู้ให้บริการ”| ตัวแปร | ค่าเริ่มต้น | ความหมาย |
|---|---|---|
CONNECT_GITHUB_APP_ID, CONNECT_GITHUB_APP_SLUG, CONNECT_GITHUB_CLIENT_ID |
GitHub App | |
CONNECT_GITHUB_CLIENT_SECRET |
ข้อมูลลับ สองค่า | |
CONNECT_GITHUB_APP_PRIVATE_KEY |
ข้อมูลลับ private key ของ App (PEM) | |
CONNECT_GOOGLE_CLIENT_ID, CONNECT_GOOGLE_CLIENT_SECRET |
ไคลเอนต์ Google ข้อมูลลับเป็นสองค่า | |
CONNECT_LINEAR_CLIENT_ID |
แอป Linear ไม่มีข้อมูลลับ | |
CONNECT_SLACK_APP_ID, CONNECT_SLACK_CLIENT_ID |
แอป Slack | |
CONNECT_SLACK_CLIENT_SECRET, CONNECT_SLACK_SIGNING_SECRET |
ข้อมูลลับ สองค่า | |
CONNECT_KLIPY_APP_KEY |
คีย์การค้นหา GIF ของ Klipy ข้อมูลลับ สองค่า | |
CONNECT_KLIPY_MODE |
proxy |
proxy เก็บคีย์ไว้ใน Connect; key ส่งคีย์ให้เซิร์ฟเวอร์ |
CONNECT_<LANE>_SECRET_GENERATION |
1 |
GitHub, Google และ Slack: รุ่นที่บันทึกในการปิดผนึกใหม่ |
CONNECT_<LANE>_MIN_SEAL_GENERATION |
1 |
GitHub, Google และ Slack: การปิดผนึกที่เก่ากว่าต้องลงชื่อเข้าใช้ใหม่ |
CONNECT_<LANE>_ACCEPTS_NEW |
true |
ทุกช่องทาง: false หยุดการลงชื่อเข้าใช้ใหม่ ส่วนที่มีอยู่จะรีเฟรชต่อไป |
การปิดผนึก สถานะ และการจัดเก็บ
หัวข้อที่มีชื่อว่า “การปิดผนึก สถานะ และการจัดเก็บ”| ตัวแปร | ค่าเริ่มต้น | ความหมาย |
|---|---|---|
CONNECT_SEAL_BACKEND |
local |
local หรือ gcp-kms |
CONNECT_SEAL_KEYS |
ข้อมูลลับ จำเป็นสำหรับ local รายการ kid:key คั่นด้วยจุลภาค โดยใหม่สุดอยู่หน้า รายการเก่ายังถอดรหัสได้ |
|
CONNECT_KMS_KEY |
projects/…/locations/…/keyRings/…/cryptoKeys/… จำเป็นสำหรับ gcp-kms |
|
CONNECT_STATE |
memory |
memory สำหรับอินสแตนซ์เดียว redis สำหรับหลายอินสแตนซ์ ที่เก็บสถานะที่เต็มจะปฏิเสธการลงชื่อเข้าใช้และคำขอใหม่ แทนที่จะลืมรายการที่ยังใช้งานอยู่ |
CONNECT_REDIS_URL |
ข้อมูลลับ redis:// หรือ rediss:// ต้องเป็น Redis 6.2 ขึ้นไปที่ตั้ง maxmemory-policy noeviction ไว้ ทั้งสองอย่างจะถูกตรวจตอนเริ่มทำงาน |
|
CONNECT_REDIS_CA_FILE |
ชุดใบรับรอง CA ที่ rediss:// ใช้ |
|
CONNECT_BINDINGS |
file |
ที่เก็บการผูกทีม Slack: file หรือ firestore |
CONNECT_DATA_DIR |
data (/data ในอิมเมจ) |
เก็บ bindings.json ถูกล็อกโดย Connect หนึ่งตัว: Connect ตัวที่สองบนไดเรกทอรีเดียวกันจะไม่เริ่มทำงาน |
CONNECT_FIRESTORE_PROJECT, CONNECT_FIRESTORE_DATABASE |
(default) database |
ใช้กับ CONNECT_BINDINGS=firestore Connect จะไม่เริ่มทำงานเมื่อ Firestore ไม่ตอบ |
การตั้งค่า บันทึก และขีดจำกัด
หัวข้อที่มีชื่อว่า “การตั้งค่า บันทึก และขีดจำกัด”| ตัวแปร | ค่าเริ่มต้น | ความหมาย |
|---|---|---|
CONNECT_SIGNED_CONFIG_FILE |
การตั้งค่าที่ลงนามแบบออฟไลน์ ส่งตามที่เป็น ใช้โดย Connect ที่ Control Center โฮสต์ | |
CONNECT_CONFIG_PUBLIC_KEYS |
คีย์ที่การตั้งค่าที่ลงนามต้องผ่านการตรวจสอบ | |
CONNECT_CONFIG_EPOCH |
1 |
หมายเลขรุ่นของการตั้งค่าที่ Connect ที่โฮสต์เองสร้างขึ้น |
CONNECT_LOG_HMAC_KEY |
สุ่มต่อโปรเซส | ข้อมูลลับ ตั้งค่าเพื่อให้แท็กที่ใช้แทน id การติดตั้งคงที่ข้ามการรีสตาร์ตและอินสแตนซ์ |
CONNECT_SENTRY_DSN |
ข้อมูลลับ DSN ของ Sentry ที่เป็น https ใช้รายงานบรรทัดข้อผิดพลาด: ชนิดของข้อผิดพลาด เฟรมสแตก เส้นทาง และรหัสคำขอ ไม่เคยเป็นข้อความ เนื้อหา หรือส่วนหัว | |
CONNECT_SENTRY_ENVIRONMENT |
self-hosted |
สภาพแวดล้อมของ Sentry |
CONNECT_VERSION, CONNECT_IMAGE_DIGEST |
รายงานโดย /v1/version |
|
CONNECT_RATE_INSTALL_PER_MINUTE |
600 |
จำนวนคำขอต่อการติดตั้ง |
CONNECT_RATE_IP_PER_MINUTE |
300 |
จำนวนคำขอต่อที่อยู่ (ที่อยู่ IPv6 นับต่อ /64) |
CONNECT_RATE_GLOBAL_PER_SECOND |
500 |
จำนวนคำขอทั้งอินสแตนซ์ |
CONNECT_RATE_SLACK_HOOK_IP_PER_MINUTE |
600 |
การส่งเหตุการณ์และคำสั่ง Slack ต่อที่อยู่ นับแยกจากคำขออื่น |
CONNECT_RATE_SLACK_HOOK_GLOBAL_PER_SECOND |
100 |
การส่งเหตุการณ์และคำสั่ง Slack ทั้งอินสแตนซ์ |
CONNECT_RATE_SLACK_TEAM_PER_MINUTE |
600 |
จำนวนเหตุการณ์ Slack ต่อทีม |
CONNECT_RATE_KLIPY_PER_MINUTE |
120 |
จำนวนการค้นหา GIF ต่อการติดตั้ง |
CONNECT_RATE_KLIPY_IP_PER_MINUTE |
240 |
การค้นหา GIF ต่อที่อยู่ ข้ามทุกเซิร์ฟเวอร์ |
CONNECT_RATE_LOGINS_IP_PER_10_MINUTES |
60 |
การลงชื่อเข้าใช้ที่เริ่มต่อที่อยู่ |
CONNECT_RATE_GITHUB_TOKENS_ACCOUNT_PER_HOUR |
30 |
โทเค็น GitHub ที่ออกต่อบัญชี GitHub หนึ่งบนเซิร์ฟเวอร์หนึ่ง (การลงชื่อเข้าใช้ การรีเฟรช โทเค็นรีโพ) |
CONNECT_RATE_GITHUB_TOKENS_ACCOUNT_CEILING_PER_HOUR |
4 × ค่าข้างบน (120) |
ค่าเดียวกันต่อบัญชี GitHub ข้ามทุกเซิร์ฟเวอร์ |
CONNECT_RATE_GITHUB_TOKENS_IP_PER_HOUR |
600 |
โทเค็น GitHub ที่ออกต่อที่อยู่ |
CONNECT_RATE_GITHUB_EXCHANGE_CEILING_PER_HOUR |
500 |
การลงชื่อเข้าใช้ GitHub ใหม่ทั้งแอป |
CONNECT_RATE_GITHUB_APP_MINTS_INSTALL_PER_HOUR |
120 |
โทเค็นบอตต่อเซิร์ฟเวอร์ |
CONNECT_RATE_GITHUB_APP_MINTS_ACCOUNT_PER_HOUR |
240 |
โทเค็นบอตต่อบัญชี GitHub ที่ขอ ข้ามเซิร์ฟเวอร์ |
CONNECT_RATE_GITHUB_APP_CEILING_PER_HOUR |
3000 |
โทเค็นบอตทั้งแอป |
CONNECT_RATE_GITHUB_TOKEN_CEILING_PER_HOUR |
1500 |
การรีเฟรชและโทเค็นรีโพทั้งแอป การลงชื่อเข้าใช้ใหม่มีขีดจำกัดของตัวเองด้านบน |
CONNECT_GITHUB_TOKEN_CAP_WARN |
10 |
โทเค็นรีโพที่ยังใช้งานได้ซึ่งบัญชี GitHub หนึ่งบัญชีถือได้ ก่อนที่ Connect จะบันทึกคำเตือน |
CONNECT_RATE_RETIRE_IP_PER_HOUR |
10 |
id การติดตั้งที่ถูกยกเลิกต่อที่อยู่ (ต่อ /48 สำหรับ IPv6) |
การเรียกที่เกินขีดจำกัดจะได้รับคำตอบ rate_limited เซิร์ฟเวอร์จะลองใหม่ภายหลัง และจะไม่ออกจากระบบใครเพราะเหตุนี้
การรันหลายอินสแตนซ์
หัวข้อที่มีชื่อว่า “การรันหลายอินสแตนซ์”สำหรับองค์กรส่วนใหญ่ อินสแตนซ์เดียวที่ใช้ CONNECT_STATE=memory ก็เพียงพอ หลายอินสแตนซ์ที่อยู่หลังที่อยู่เดียวกันต้องใช้ CONNECT_STATE=redis และ CONNECT_BINDINGS=firestore เพื่อให้การลงชื่อเข้าใช้ที่เริ่มบนอินสแตนซ์หนึ่งเสร็จสิ้นบนอีกอินสแตนซ์ได้ และทุกอินสแตนซ์เห็นการผูก Slack และ id การติดตั้งที่ถูกยกเลิกเหมือนกัน CONNECT_DATA_DIR ที่ใช้ร่วมกันใช้ไม่ได้: Connect ตัวแรกจะล็อกมัน ขีดจำกัดคำขอต่อการติดตั้ง ต่อที่อยู่ และต่ออินสแตนซ์เป็นของแต่ละอินสแตนซ์ ส่วนขีดจำกัดการลงชื่อเข้าใช้ โทเค็น GitHub โทเค็นบอต การค้นหา GIF ต่อที่อยู่ การยกเลิก และทีม Slack ถูกใช้ร่วมกันผ่านที่เก็บสถานะ
การหมุนเวียนคีย์ของผู้ให้บริการ
หัวข้อที่มีชื่อว่า “การหมุนเวียนคีย์ของผู้ให้บริการ”จะไม่มีใครถูกออกจากระบบ:
- สร้างคีย์ใหม่ที่ผู้ให้บริการ และเก็บคีย์เก่าไว้
- ย้ายค่าเก่าไปยัง
NAME_PREVIOUSวางค่าใหม่ในNAMEและเพิ่มCONNECT_<LANE>_SECRET_GENERATIONไฟล์ที่ mount ไว้จะถูกอ่านภายใน 30 วินาที - รอให้การลงชื่อเข้าใช้แต่ละรายการรีเฟรช จากนั้นลบคีย์เก่าที่ผู้ให้บริการ และนำ
NAME_PREVIOUSออก
ในการหมุนเวียนคีย์การปิดผนึก ให้วางรายการ cc-connect-config seal-key ใหม่ไว้หน้าสุดของ CONNECT_SEAL_KEYS และเก็บรายการเก่าไว้จนกว่าการปิดผนึกทั้งหมดจะรีเฟรชแล้ว
การเปลี่ยนแอป
หัวข้อที่มีชื่อว่า “การเปลี่ยนแอป”เซิร์ฟเวอร์จะจดจำ id แอปและ client id ที่ Connect ของคุณประกาศในการใช้งานครั้งแรก หากคุณเปลี่ยนแอปใด การ์ด Connect ของแต่ละเซิร์ฟเวอร์จะแสดง แอปของ Connect เปลี่ยนแปลงแล้ว และการลงชื่อเข้าใช้ผ่าน Connect จะถูกระงับจนกว่าเจ้าของจะคลิก เชื่อถือแอปใหม่ แจ้งเจ้าของเซิร์ฟเวอร์ทุกคนก่อนสลับ เพื่อให้พวกเขารู้ว่าคำเตือนนี้มาจากคุณ
การบล็อกเซิร์ฟเวอร์
หัวข้อที่มีชื่อว่า “การบล็อกเซิร์ฟเวอร์”เพิ่ม id การติดตั้งของมันลงใน CONNECT_DENY_INSTALLS แล้วรีสตาร์ต เจ้าของจะเห็นข้อความ “Connect บล็อกรหัสการติดตั้งของเซิร์ฟเวอร์นี้ ติดต่อผู้ดูแลเซิร์ฟเวอร์ Connect ของคุณ” และการลงชื่อเข้าใช้ทั้งหมดผ่าน Connect บนเซิร์ฟเวอร์นั้นจะหยุดทำงาน
เซิร์ฟเวอร์ยังยกเลิก id การติดตั้งเก่าของตัวเองเมื่อเจ้าของหมุนเวียนคีย์ มันพิสูจน์ว่า id นั้นเป็นของตนด้วยการปิดผนึกข้อมูลรับรองหนึ่งชุดที่ Connect นี้สร้างให้ ดังนั้นมีเพียงเซิร์ฟเวอร์ที่เคยลงชื่อเข้าใช้ให้ใครสักคนเท่านั้นที่ยกเลิก id ได้ Connect เก็บ id ที่ถูกยกเลิกไว้ตลอดไป คีย์เก่าและการปิดผนึกทุกชุดที่ทำสำหรับมันจึงหยุดทำงาน และปล่อยทีม Slack ที่ผูกกับ id เก่า โทเค็นที่ออกไปแล้วจะหมดอายุเอง: ภายใน 8 ชั่วโมงสำหรับของบุคคล และ 1 ชั่วโมงสำหรับของบอต Connect เก็บ id ที่ถูกยกเลิกได้สูงสุด 100,000 รายการ เมื่อเกินนั้น การหมุนเวียนจะถูกปฏิเสธ และบันทึกจะแจ้งไว้ในระดับ error
การแก้ปัญหา
หัวข้อที่มีชื่อว่า “การแก้ปัญหา”เซิร์ฟเวอร์แจ้งว่า Connect บล็อกมัน
หัวข้อที่มีชื่อว่า “เซิร์ฟเวอร์แจ้งว่า Connect บล็อกมัน”id การติดตั้งของมันไม่อยู่ใน CONNECT_ALLOWED_INSTALLS อยู่ใน CONNECT_DENY_INSTALLS หรือถูกยกเลิกโดยการหมุนเวียนคีย์ id นี้จะเปลี่ยนเมื่อเจ้าของหมุนเวียนคีย์ ให้ขอ id ใหม่จากพวกเขา
การลงชื่อเข้าใช้ทั้งหมดไปยังผู้ให้บริการหนึ่งล้มเหลว
หัวข้อที่มีชื่อว่า “การลงชื่อเข้าใช้ทั้งหมดไปยังผู้ให้บริการหนึ่งล้มเหลว”ตัวแปรบางตัวของมันอาจหายไป Connect จึงตัดช่องทางนั้นออก ให้ตรวจสอบบันทึกการเริ่มทำงานและตารางด้านบน GitHub ต้องการทั้งห้ารายการ ได้แก่ App id, slug, client id, client secret และ private key ส่วน Google ต้องการทั้ง client id และ secret
การลงชื่อเข้าใช้ล้มเหลวเนื่องจาก redirect ไม่ตรงกัน
หัวข้อที่มีชื่อว่า “การลงชื่อเข้าใช้ล้มเหลวเนื่องจาก redirect ไม่ตรงกัน”redirect ที่ลงทะเบียนกับผู้ให้บริการไม่ตรงกับ CONNECT_PUBLIC_URL ทุกตัวอักษร ให้ตรวจสอบโปรโตคอล โฮสต์ พอร์ต และเส้นทาง /connect ของ Connect ที่ mount ไว้
ทุกคนต้องลงชื่อเข้าใช้อีกครั้ง
หัวข้อที่มีชื่อว่า “ทุกคนต้องลงชื่อเข้าใช้อีกครั้ง”คีย์การปิดผนึกเปลี่ยนแปลงหรือหาย เซิร์ฟเวอร์เครื่องหนึ่งหมุนเวียนคีย์ของมัน หรือข้อมูลของเซิร์ฟเวอร์เครื่องหนึ่งถูกกู้คืนไปยังอีกเครื่องหนึ่ง ข้อมูลรับรองที่ปิดผนึกจะเปิดได้เฉพาะสำหรับการติดตั้งและ Connect ที่สร้างมันเท่านั้น