نمای کلی
اگر مدیر فضای کاری ChatGPT هستید و الگوی برنامه Enterprise برای سازمان خود را راهاندازی میکنید، از این راهنما استفاده کنید. الگو برنامه نهاییای نیست که اعضا استفاده میکنند. این یک جریان راهاندازی است که پس از ارائه پیکربندی لازم GitHub Enterprise، یک برنامه پیشنویس مخصوص فضای کاری ایجاد میکند.
برای GitHub Enterprise، راهاندازی ChatGPT را به میزبان GitHub Enterprise سازمان شما متصل میکند. شما یک برنامه GitHub ایجاد میکنید، URL بازگشت ChatGPT را ثبت میکنید، اعتبارنامهها را تولید میکنید، سپس آن مقادیر را در جریان راهاندازی الگوی ChatGPT جایگذاری میکنید. پس از اینکه ChatGPT برنامه پیشنویس را ایجاد کرد، میتوانید آن را منتشر کنید و مانند سایر برنامههای فضای کاری مدیریت کنید.
آنچه راهاندازی میکنید
شما در ChatGPT یک برنامه GitHub Enterprise مخصوص فضای کاری ایجاد میکنید. این برنامه از موارد زیر استفاده میکند:
یک برنامه GitHub ثبتشده روی میزبان GitHub Enterprise شما.
شناسه مشتری و راز مشتری برنامه GitHub برای مجوزدهی OAuth کاربر.
کلید خصوصی برنامه GitHub تا ChatGPT بتواند توکنهای نصب را برای عملیات محل نگهداری صادر کند.
یک راز وبهوک و URL وبهوک تا GitHub Enterprise بتواند رویدادهای نصب و محل نگهداری را به ChatGPT برگرداند.
نام میزبان GitHub Enterprise شما، مانند
github.example.com.
یک برنامه GitHub ایجاد کنید، نه یک برنامه مستقل OAuth GitHub. راهاندازی الگوی ChatGPT به اعتبارنامههای برنامه GitHub، یک کلید خصوصی و تنظیمات وبهوک نیاز دارد.
پیش از شروع
به این موارد نیاز دارید:
دسترسی مدیر یا مالک فضای کاری ChatGPT.
دسترسی مدیر GitHub Enterprise یا مالک سازمان که بتواند برنامههای GitHub را ایجاد و نصب کند.
فقط نام میزبان GitHub Enterprise، بدون
https://یا مسیر.تصمیمی درباره اینکه ChatGPT باید از کدام اقدامات محل نگهداری پشتیبانی کند، مانند جستوجوی فقطخواندنی محل نگهداری، گردشکارهای درخواست نظرسنجی، گردشکارهای مسئله، ویرایش فایل، GitHub Actions یا گردشکارهای گستردهتر Codex.
مکانی امن برای مدیریت کلید خصوصی برنامه GitHub و راز مشتری.
ChatGPT و GitHub Enterprise را در برگههای جداگانه باز نگه دارید. URL بازگشت را از خود نسازید. URL بازگشت دقیقِ نشاندادهشده در ChatGPT را کپی کنید.
مقادیر آمادهسازی
نام میزبان GitHub Enterprise: برای مثال،
github.example.com.URL بازگشت: آن را از جریان راهاندازی الگوی ChatGPT کپی کنید.
شناسه مشتری برنامه GitHub.
راز مشتری برنامه GitHub.
PEM کلید خصوصی برنامه GitHub.
راز وبهوک تولیدشده توسط ChatGPT.
URL وبهوک تولیدشده پس از ایجاد برنامه پیشنویس در ChatGPT.
راهاندازی الگو را در ChatGPT شروع کنید
در ChatGPT، به فضای کاریای بروید که برنامه باید در آن در دسترس باشد.
تنظیمات فضای کاری > برنامهها را باز کنید.
دایرکتوری را انتخاب کنید.
GitHub Enterprise را جستوجو کنید.
الگوی برنامه GitHub Enterprise را انتخاب کنید و راهاندازی را شروع کنید.
یک نام و توضیح روشن برای برنامه وارد کنید، مانند GitHub Enterprise یا GitHub Enterprise - Engineering.
نام میزبان GitHub Enterprise را وارد کنید، مانند
github.example.com.URL بازگشتِ نشاندادهشده در ChatGPT را کپی کنید. این برگه را باز نگه دارید.
اگر راز وبهوک تولیدشده هنگام راهاندازی نمایش داده شد، آن را کپی کنید.
نمونه URL بازگشت: https://chatgpt.com/connector/oauth/<callback_id>
شناسه بازگشت را حذف نکنید، اسلش پایانی اضافه نکنید، و آن را با یک URL عمومی ChatGPT جایگزین نکنید.
برنامه GitHub را در GitHub Enterprise ایجاد کنید
میزبان GitHub Enterprise خود را باز کنید، مانند
https://github.example.com.به سازمان یا حسابی بروید که باید مالک برنامه باشد.
Settings > Developer settings > GitHub Apps را باز کنید.
New GitHub App را انتخاب کنید.
یک نام روشن برای برنامه وارد کنید، مانند ChatGPT GitHub Enterprise Connector.
یک URL صفحه اصلی وارد کنید. اگر صفحه داخلی اختصاصی وجود ندارد، از URL سازمان GitHub Enterprise استفاده کنید.
در Callback URL، URL بازگشت دقیق کپیشده از ChatGPT را جایگذاری کنید.
Expire user authorization tokens را فعال نگه دارید، مگر اینکه تیم امنیتی شما دلیل مشخصی برای تغییر آن داشته باشد.
Request user authorization during installation را فعال کنید تا کاربران بتوانند هنگام نصب یا جریان اتصال، به برنامه مجوز دهند.
در بخش Where can this GitHub App be installed?، محدودترین گزینهای را انتخاب کنید که با عرضه شما سازگار است.
برنامه GitHub را ایجاد کنید.
مجوزها و رویدادها را پیکربندی کنید
حداقل مجوزهای لازم برای اقدامات ChatGPT را که قصد فعالسازی آنها را دارید انتخاب کنید.
برای کشف فقطخواندنی محل نگهداری و پرسشوپاسخ، با مجوزهای خواندن مانند موارد زیر شروع کنید:
فراداده: فقطخواندنی. GitHub برای برنامههای GitHub به فراداده نیاز دارد.
محتوا: فقطخواندنی، برای دسترسی به فایل و محتوای محل نگهداری.
مسائل: فقطخواندنی، اگر جستوجو یا خواندن مسئله لازم است.
درخواستهای نظرسنجی: فقطخواندنی، اگر جستوجوی درخواست نظرسنجی یا زمینه بازبینی لازم است.
Actions: فقطخواندنی، اگر وضعیت اجرای گردشکار، کارها، گزارشها یا مصنوعات لازم است.
برای گردشکارهای نوشتن، فقط در موارد لازم مجوز نوشتن اضافه کنید، مانند Contents، Pull requests، Issues، Actions یا Workflows. از محدودترین مجوزهایی استفاده کنید که اقدامات موردنظر ChatGPT را پشتیبانی میکنند.
رویدادهای وبهوک باید با گردشکارهایی که پشتیبانی میکنید مطابقت داشته باشند. رویدادهای رایج شامل Installation، Installation repositories، Push، Pull request، Issues، Issue comment، Workflow run و Workflow job هستند.
اعتبارنامههای برنامه GitHub را تولید و کپی کنید
در تنظیمات برنامه GitHub، Client ID را کپی کنید.
یک Client secret تولید کنید و فوراً آن را کپی کنید.
در بخش Private keys، یک کلید خصوصی تولید کنید.
فایل .pem را دانلود کنید و آن را بهصورت امن ذخیره کنید.
فایل .pem را بهصورت محلی باز کنید و متن کامل PEM، از جمله خطوط آغاز و پایان، را کپی کنید.
کلید خصوصی حساس است. با آن مانند یک اعتبارنامه رفتار کنید. اگر افشا شد، یک کلید خصوصی جدید تولید کنید، راهاندازی برنامه ChatGPT را بهروزرسانی کنید و کلید بهخطرافتاده را در GitHub Enterprise حذف کنید.
راهاندازی را در ChatGPT تکمیل کنید
به برگه راهاندازی الگوی ChatGPT بازگردید.
Client ID برنامه GitHub را در OAuth client ID جایگذاری کنید.
Client secret برنامه GitHub را در OAuth client secret جایگذاری کنید.
Scopes را بدون تغییر بگذارید، مگر اینکه سازمان شما عمداً نیاز داشته باشد پیشفرضهای الگو را بازنویسی کند.
تأیید کنید نام میزبان GitHub Enterprise فقط نام میزبان است، مانند
github.example.com.PEM کلید خصوصی برنامه GitHub را در GitHub App private key جایگذاری یا بارگذاری کنید.
تأیید کنید راز وبهوک تولیدشده موجود است.
برنامه پیشنویس را ایجاد کنید.
جزئیات برنامه پیشنویس ایجادشده را در ChatGPT باز کنید و URL وبهوک تولیدشده را کپی کنید.
URL وبهوک باید شبیه این باشد: https://connectors.api.openai.org/connectors/<connector_id>/webhook
راهاندازی وبهوک را در GitHub Enterprise تکمیل کنید
به تنظیمات برنامه GitHub در GitHub Enterprise بازگردید.
تنظیمات General برنامه GitHub را باز کنید.
اگر Active webhooks از قبل فعال نیست، آن را فعال کنید.
URL وبهوک ChatGPT را در Webhook URL جایگذاری کنید.
راز وبهوک ChatGPT را در Webhook secret جایگذاری کنید.
تأیید SSL را فعال نگه دارید.
تأیید کنید رویدادهای وبهوک مشترکشده با مجوزها و اقداماتی که فعال کردهاید مطابقت دارند.
تغییرات را ذخیره کنید.
برنامه را در ChatGPT منتشر و مدیریت کنید
ایجاد برنامه پیشنویس بهطور خودکار آن را در دسترس اعضا قرار نمیدهد. پس از بازبینی پیشنویس:
برنامه پیشنویس را منتشر کنید.
تأیید کنید برنامه در تنظیمات فضای کاری > برنامهها > فعالشده ظاهر میشود.
دسترسی کاربر را برای نقشهایی که باید از آن استفاده کنند پیکربندی کنید.
کنترل اقدامات را برای اقدامات خواندن و نوشتن بازبینی کنید.
مجوزهای برنامه را بازبینی کنید تا تعیین کنید ChatGPT چه زمانی پیش از استفاده از برنامه از اعضا سؤال کند.
از یک کاربر آزمایشی مجاز بخواهید برنامهها در ChatGPT را باز کند و تأیید کند برنامه ظاهر میشود.
این مجوزهای برنامه برای گفتوگوهای ChatGPT اعمال میشوند. عوامل فضای کاری از کنترلهای مختص هر عامل که سازنده عامل تنظیم کرده استفاده میکنند تا مشخص شود کدام اقدامات برنامه در دسترساند و چه زمانی از کاربران نهایی خواسته میشود آنها را تأیید کنند. برای رفتار عامل، ببینید: عوامل فضای کاری ChatGPT برای Enterprise و Business.
برنامه GitHub را نصب و آزمایش کنید
در GitHub Enterprise، برنامه GitHub را روی سازمان یا حساب نصب کنید.
همه محلهای نگهداری یا محلهای نگهداری انتخابشده را مطابق با خطمشی فضای کاری انتخاب کنید.
بهعنوان یک کاربر مجاز، جریان اتصال را از ChatGPT شروع کنید.
وقتی درخواست شد، به برنامه GitHub مجوز دهید.
ابتدا یک اقدام خواندن کوچک اجرا کنید، مانند فهرست کردن محلهای نگهداری قابلدسترسی یا واکشی یک درخواست نظرسنجی شناختهشده.
اگر اقدامات نوشتن فعالاند، پیش از عرضه گستردهتر، آن را با یک محل نگهداری کمریسک آزمایش کنید.
نام میزبان و رفتار OAuth
ChatGPT از نام میزبان برای استخراج نقاط پایان GitHub Enterprise استفاده میکند. فقط میزبان را وارد کنید، مانند github.example.com یا octocorp.ghe.com.
مسیر API، مسیر محل نگهداری یا github.com را وارد نکنید، مگر اینکه دقیقاً میزبان GitHub Enterprise برای این برنامه باشد.
عیبیابی
عدم تطابق URI تغییرمسیر: تأیید کنید URL بازگشت برنامه GitHub دقیقاً با URL بازگشت نشاندادهشده در ChatGPT مطابقت دارد.
ChatGPT نمیتواند برنامه پیشنویس را ایجاد یا ذخیره کند: تأیید کنید همه فیلدهای لازم، از جمله نام میزبان، OAuth client ID، OAuth client secret، کلید خصوصی و راز وبهوک، موجود هستند.
احراز هویت موفق است اما فراخوانیهای محل نگهداری ناموفقاند: تأیید کنید برنامه GitHub نصب شده و به محل نگهداری دسترسی دارد.
API مقدار ۴۰۳ یا مجوزهای ناکافی برمیگرداند: مجوز برنامه GitHubِ جاافتاده را اضافه کنید و در صورت درخواست، از مالک نصب بخواهید مجوزهای بهروزشده را تأیید کند.
هیچ محل نگهداریای ظاهر نمیشود: تأیید کنید نصب برنامه شامل محلهای نگهداری مورد انتظار است و کاربری که در ChatGPT مجوز میدهد به آنها دسترسی دارد.
تحویلهای وبهوک ناموفقاند: تأیید کنید URL وبهوک و راز وبهوک با مقادیر ChatGPT مطابقت دارند، تأیید SSL را فعال نگه دارید و مطمئن شوید میزبان GitHub Enterprise میتواند به
connectors.api.openai.orgدسترسی داشته باشد.خطاهای کلید خصوصی: تأیید کنید محتوای کامل PEM، از جمله خطوط آغاز و پایان، کپی شده است.
