Confluence
Confluence چیست؟
ابزار کانفلوئنس یک ویکی بر مبنای وب است که از سال ۲۰۰۲ توسط شرکت استرالیایی اتلسین توسعه داده شده است. علاوه بر ارائه‌ی یک ویرایشگر متن حرفه‌ای، Confluence امکان همگام‌سازی کامل با مایکروسافت آفیس و مجموعه وسیعی از افزونه‌ها را دارد. Confluence به اشتراک گذاشتن اطلاعات را بین تیم‌ها و اعضای یک مجموعه تسهیل کرده و موضوعات مختلف را با هم هماهنگ می‌سازد. این موارد در کنار ویژگی‌های مهم دیگر Confluence را به ابزاری توان‌مند و چند منظوره تبدیل کرده است. موارد زیر بخشی از قابلیت‌های Confluence است.
- نگهداری مستندات به صورت فایل
- نگهداری نسخه‌های مختلف یک فایل
- امکان ویرایش فایل‌های ورد و اکسل
- امکان ثبت نظرات
- ویرایش چندکاربره
فضا (Space) در Confluence چیست؟
اسپیس فضای اختصاص داده شده به هر موضوع تعریف‌شده توسط کاربر است. می‌توان بر اساس نیازها و گوناگونی موضوعات هر تیم، فضاهای متفاوتی را تعریف و دسترسی اعضا را به آن‌ها تنظیم کرد.
مزایای استفاده از Confluence
- دسته بندی جداگانه اطلاعات با موضوعات مختلف
- از بین رفتن سردرگمی میان اعضای تیم
- کنترل دسترسی کاربران بر اساس نیاز
- همگام‌سازی کاربران با ابزارهای دیگر مانند مایکروسافت
- راه‌اندازی ساده
- ساختار مناسب
مستندات Confluence در صفحه‌ها (یا به اصطلاح پیج‌ها) شامل دسته‌بندی‌های مختلف نگارش می‌شوند. نمای ظاهری صفحات به صورت درخت است. به لایه‌های بالاتر صفحات مادر و به صفحات لایه پایین‌تر صفحات فرزند گفته می‌شود که این ویژگی باعث سهولت کار با Confluence شده است.
امکانات نگارشی ابزار Confluence
ابزار Confluence امکانات متنوعی برای نگارش مستندات دارد. به جرات می‌توان گفت که Confluence با داشتن کامل‌ترین نوار ابزار نگارشی، مزیت رقابتی جدی‌ای در این حوزه دارد. هم‌چنین، می‌توان اسناد را با جست و جو یافت و مستندات دیگر را در این ابزار لینک کرده و حجم مصرفی را کاهش داد.
ویرایش چندکاربره
به عنوان یک قابلیت منحصر به فرد میان رغبا، Confluence امکان ویرایش یک مستند به طور همزمان توسط چند کاربر را ارائه می‌کند. کاربران می‌توانند تغییرات یک دیگر را در لحظه مشاهده کنند.
تاریخچه تغییرات در ابزار Confluence
در Confluence، تاریخچه تغییرات یک صفحه به طور کامل نگهداری شده و با اعمال هر ویرایش روی یک صفحه، نسخه‌ای جدید از آن ذخیره می‌شود. یکی دیگر از مزیت‌های استفاده از ابزار Confluence ذخیره آنلاین و در لحظه است. به عنوان مثال، اگر در حین ویرایش ارتباط خود را با سرور از دست دهید، تمامی تغییرات به شکل پیش‌نویس برای کاربر ذخیره می‌شود و امکان ویرایش دوباره آن وجود خواهد داشت. در ضمن، در صورت تمایل می‌توان نسخه‌های قبلی را بازگردانی کرد.
Confluence مناسب سازمان‌های بزرگ و کوچک
سازمان‌ها و شرکت‌ها، با توجه به تعداد کاربران خود، می‌توانند از یکی از حالت‌های stand alone یا datacenter Confluence استفاده کنند. در حالت اول، تعداد اعضا نمی‌تواند بیش از ۳۰۰ باشد. بنابر‌این، برای مجموعه‌های بزرگ‌تر، حالت دوم پیشنهاد می‌شود.
ساخت Confluence در کنسول هم‌روش
- به صفحه دارکوب در کنسول هم‌روش مراجعه کنید. سپس در قسمت «ساخت اپ»، ذیل «ساخت اپ آماده»، Confluence را انتخاب کنید. در این مرحله، نام و زیردامنه‌ای برای نسخه Confluence خود برگزینید.
در صفحه بعد، پس از انتخاب پلن مورد نظر، گزینه «ساخت اپ» را انتخاب کنید. پس از اندکی، نسخه Confluence شما مستقر خواهد‌شد. با توجه به سنگین بودن استقرار اولیه، ممکن است این فرایند چند دقیقه طول بکشد.
جهت راه‌اندازی نسخه Confluence، به دامنه‌ای که در مرحله نخست برگزیده‌اید مراجعه کنید.
- در صفحه بعد، server id نسخه Confluence خود را کپی کنید و در کنسول هم‌روش، وارد صفحه ویرایش اپ شوید. سپس، در قسمت «دریافت کد فعال‌سازی» license keyهای مربوطه را دریافت کنید. توجه برای دریافت license key خود اپ Confluence قسمت App Key را خالی بزارید.
- سپس، بقیه مراحل راه‌اندازی را طی کنید. برای اطلاعات بیشتر درباره مراحل راه‌اندازی می‌توانید به این لینک مراجعه کنید.
نصب پلاگین در Confluence
کانفلوئنس پلاگین‌های بسیاری دارد که امکانات آن را بسیار غنی‌تر می‌کنند. این پلاگین‌ها را می‌توانید از قسمت تنظیمات کانفلوئنس نصب کنید. دقت داشته باشید که برای دسترسی به تنظیمات، نیاز است دسترسی ادمین داشته باشید.
از نوار بالای صفحه کانفلوئنس، منوی تنظیمات را باز کرده و گزینه Manage Apps را بزنید. از منوی کناری، آیتم Find new apps را پیدا کرده و وارد آن شوید. در این قسمت می‌توانید پلاگین دلخواه خود را جستجو و نصب کنید.
فعال‌سازی پلاگین‌های نیازمند لایسنس
برای دریافت لایسنس یک پلاگین، ابتدا لازم است آیدی کانفلوئنس خود و کلید شناساگر پلاگین را داشته باشید.
برای به دست آوردن کلید پلاگین، ابتدا نسخه آزمایشی پلاگین را نصب کنید. این کار با زدن گزینه Free Trial یا Install در جلوی اسم پلاگین، قابل انجام است.
ممکن است اعلانی نمایش داده شود که باید برای دریافت لایسنس، به سایت MyAtlassian بروید. نیازی به این کار نیست و گزینه Close را بزنید. به قسمت Manage Apps برگردید و روی نام پلاگین نصب شده، کلیک کنید. اطلاعاتی در مورد پلاگین نمایش داده می‌شود. کلید شناساگر پلاگین ذیل عنوان App Key آمده است. این کلید را ذخیره کنید.
آیدی کانفلوئنس، همان سرور آیدی شماست که با آن کانفلوئنس را فعال کرده بودید. برای پیدا کردن این آیدی، از منوی تنظیمات وارد قسمت General Configuration شده و به زیربخش System Information بروید. آیدی کانفلوئنس تحت عنوان Server ID آورده شده است.
به کنسول هم روش مراجعه کنید و وارد صفحه ویرایش اپ شوید، سپس از قسمت دریافت کد فعال سازی با وارد کردن server id و app key مورد نظر خود، لایسنس پلاگین را دریافت کنید.. این لایسنس را در قسمت Manage app، در فیلدLicense Key وارد کرده و گزینه Update را بزنید. از این لحظه به بعد، این پلاگین بصورت رایگان در اپ کانفلوئنس شما قابل استفاده است.
بهروزرسانی Confluence
در صورتی که امکان ساخت نسخه‌ای جدیدتر نسبت به نسخه‌ی Confluence کنونی شما در کنسول هم‌روش وجود دارد، می‌توانید با انجام مراحل زیر، Confluence خود را بهروزرسانی کنید. ممکن است حین فرایند بهروزرسانی لازم باشد از kubectl استفاده کنید. اگر تا به حال با kubectl کار نکرده‌اید و یا نیاز به کمک دارید، برای اطلاعات بیشتر به این مستند مراجعه کنید. اگر حین انجام این فرایند با ابهام یا مشکلی مواجه شدید، لطفا با پشتیبانی هم‌روش ارتباط برقرار کنید.
یک نسخه‌ی جدید با ورژن مورد نظرتان را بسازید و مطابق با مراحل بالاتر در همین مستند، آن را راه‌اندازی کنید.
در تب Terminal صفحه‌ی جزئیات اپ نسخه‌ی کنونی، مقدار
admin.ui.allow.manual.backup.downloadرا در فایلconfluence.cfg.xmlبهtrueتغییر دهید. می‌توانید از دستور زیر استفاده کنید یا ابتدا یک ویرایشگر متن مثل vim را نصب کرده و با استفاده از آن این کار را انجام دهید.
sed -i -e "s/backup.download\">false/backup.download\">true/g" \
/var/atlassian/application-data/confluence/confluence.cfg.xml
نسخه‌ی کنونی را با استفاده از دکمه «ذخیره و دیپلوی» ریست کنید.
مطابق با این مستند، یک بکاپ از نسخه‌ی کنونی خود تهیه کنید. دقت کنید که گزینه‌ی Include attachments فعال باشد. اگر مرحله‌ی اول به درستی انجام شده باشد، در انتهای ساخت بکاپ، علاوه‌بر آدرس فایل بکاپ، لینک دانلود از مرورگر نیز وجود خواهد داشت. اگر به هر دلیلی دانلود از مرورگر امکان‌پذیر نبود، می‌توانید توسط دستور زیر فایل backup را به ماشین خود منتقل کنید. دقت کنید که این دستور بدون رخ دادن خطا انجام شود.
kubectl cp -n NAMESPACE CURRENT_CONFLUENCE_POD_NAME:/var/atlassian/application-data/confluence/temp/FILE_NAME.zip ./my-conf-backup.zip
نسخه‌ی کنونی را با استفاده از دکمه «غیر فعال کردن اپ» خاموش کنید.
در نسخه‌ی جدید، مطابق با این مستند و با استفاده از فایلی که در مرحله‌ی ۴ به ماشین خود منتقل کردید، نسخه‌ی جدید Conflunce را restore کنید. اگر امکان upload فایل backup وجود ندارد و می‌خواهید از روش To import a site from the home directory استفاده کنید، باید ابتدا با استفاده از دستور زیر، فایل backup را به پاد خود منتقل کنید. پس از آغاز فرایند restore، صبر کنید تا زیر progress bar عبارت Complete نشان داده شود.
kubectl cp -n NAMESPACE ./my-conf-backup.zip NEW_CONFLUENCE_POD_NAME:/var/atlassian/application-data/confluence/restore/my-conf-backup.zip
در تب «آدرس دامنه» صفحه‌ی جزئیات اپ، دامنه‌ی نسخه‌ی قدیمی را به مقدار دیگری تغییر دهید و روی دکمه‌ی «ذخیره تغییرات» کلیک کنید. اپ قدیمی هم‌چنان غیرفعال خواهد بود.
در تب «آدرس دامنه» صفحه‌ی جزئیات اپ، دامنه‌ای که برای نسخه‌ی قدیمی استفاده می‌کردید را برای نسخه‌ی جدید تنظیم کنید و روی دکمه‌ی «ذخیره تغییرات» کلیک کنید.
با استفاده از حساب کاربری ادمین وارد نسخه‌ی جدید شوید. پیامی مبنی بر تشخیص یک base url جدید نشان داده خواهد شد. روی لینک موجود در مودال کلیک و این تغییر را ثبت کنید.
نسخه‌ی جدید را بررسی کنید و اگر وضعیت مطلوبی دارد، نسخه‌ی قبل را حذف کنید. در نظر داشته باشید تا زمانی که نسخه‌ی قدیمی غیرفعال باشد، تنها هزینه‌ی دیسک برای آن لحاظ می‌شود.
مهاجرت Confluence
جهت انتقال Confluence خود از محیطی دیگر به کنسول هم‌روش، می‌توانید مراحل زیر را طی کنید.
مطابق با این مستند، یک بکاپ از نسخه‌ی کنونی خود تهیه کنید. دقت کنید که گزینه‌ی Include attachments فعال باشد. اگر تمایل به دانلود بکاپ از مرورگر دارید، مطمئن شوید گزینه‌ی
admin.ui.allow.manual.backup.downloadدر فایلconfluence.cfg.xmlمقدارtrueداشته باشد.پس از ساخت و راه‌اندازی نسخه‌ای از Confluence در کنسول هم‌روش، مطابق با این مستند و با استفاده از فایلی که در مرحله‌ی قبل به ماشین خود منتقل کردید، نسخه‌ی جدید Conflunce را restore کنید. اگر امکان upload فایل backup وجود ندارد و می‌خواهید از روش To import a site from the home directory استفاده کنید، باید ابتدا با استفاده از دستور زیر، فایل backup را به پاد خود منتقل کنید. پس از آغاز فرایند restore، صبر کنید تا زیر progress bar عبارت Complete نشان داده شود.
kubectl cp -n NAMESPACE ./my-conf-backup.zip NEW_CONFLUENCE_POD_NAME:/var/atlassian/application-data/confluence/restore/my-conf-backup.zip