HedgeDoc؛ ویرایشگر Markdown مشترک و هم‌زمان برای تیم

مزیت اصلی Markdown این است که متن ساده می‌ماند: همان یادداشتی که امروز در HedgeDoc می‌نویسید، فردا بدون تبدیل در مخزن کد، ویکی یا سایت مستندات قابل استفاده است. برخلاف فایل‌های Word که با هر بار ارسال یک نسخهٔ تازه می‌سازند، در HedgeDoc فقط یک نسخهٔ زنده وجود دارد و همه همان را می‌بینند.

جاهایی که HedgeDoc نسبت به فایل و پیام‌رسان کار را جلو می‌اندازد:

وقتی HedgeDoc را در سفارش انتخاب می‌کنید، اسکریپت نصب پس از روشن‌شدن سرور روی Ubuntu 22.04‏، Docker و افزونهٔ compose را نصب می‌کند و دو سرویس را در /opt/hedgedoc بالا می‌آورد: پایگاه دادهٔ PostgreSQL 16 بر پایهٔ Alpine با رمز تصادفی و HedgeDoc نسخهٔ ۱٫۱۰٫۳ از مخزن رسمی پروژه. HedgeDoc داخل ایمیج روی پورت ۳۰۰۰ کار می‌کند که به پورت ۸۰ سرور وصل می‌شود.

کلید نشست تصادفی ساخته و در فایلی با دسترسی محدود نگه داشته می‌شود. دامنه روی IP سرور و حالت SSL خاموش تنظیم می‌شود؛ وقتی دامنه و HTTPS راه انداختید، CMD_DOMAIN و CMD_PROTOCOL_USESSL را مطابق آن تغییر دهید تا پیوندها و کوکی‌ها درست ساخته شوند. فایل‌ها و تصاویری که در یادداشت‌ها بارگذاری می‌شوند در پوشهٔ uploads ذخیره می‌شوند.

پس از پایان نصب، نشانی سرور، نشانی ساخت یادداشت تازه و پوشهٔ نصب در تب «اپلیکیشن» صفحهٔ سرور نمایش داده می‌شوند و قوانین فایروال برای پورت‌های ۸۰ و ۴۴۳ خودکار اعمال می‌شوند. هیچ حساب کاربری از پیش ساخته نمی‌شود؛ اولین حساب را خودتان با ثبت‌نام ایمیلی می‌سازید.

هر یادداشت به‌طور پیش‌فرض یک نشانی تصادفی طولانی می‌گیرد که حدس زدنش سخت است. چون در نصب ما گزینهٔ نشانی دلخواه روشن است، با باز کردن مسیری مثل نام پروژه، یادداشتی با همان نام ساخته می‌شود؛ این برای صفحه‌های ثابت تیم راحت است اما یعنی نشانی‌های قابل‌حدس هم ممکن‌اند.

مالک هر یادداشت تعیین می‌کند چه کسی بخواند و چه کسی ویرایش کند. برای مستند رسمی تیم حالت «فقط اعضای واردشده ویرایش کنند» مناسب است و برای انتشار عمومی حالت «همه بخوانند، فقط مالک ویرایش کند». برچسب‌ها در ابتدای یادداشت کمک می‌کنند یادداشت‌ها را در صفحهٔ تاریخچه پیدا کنید.

تاریخچهٔ نسخه‌ها اشتباه‌ها را جبران می‌کند: اگر کسی بخشی را پاک کرد، نسخهٔ قبل را ببینید و متن را برگردانید. برای یادداشت‌های مهم، هر چند وقت یک بار نسخهٔ Markdown را در مخزن کد یا ویکی ذخیره کنید.

HedgeDoc با Node.js اجرا می‌شود و کنار آن PostgreSQL هم حافظه مصرف می‌کند. برای تیمی چندنفره پلن mini کافی است؛ اگر جلسه‌هایی با ده‌ها ویرایشگر هم‌زمان دارید یا کنار HedgeDoc سرویس‌های دیگری روی همان سرور اجرا می‌کنید، پلن standard با دو گیگابایت حافظه تجربهٔ روان‌تری می‌دهد.

یادداشت‌های متنی حجم ناچیزی دارند و فضای دیسک بیشتر صرف تصاویر بارگذاری‌شده می‌شود. قیمت‌های زیر مستقیم از جدول پلن‌ها می‌آیند و هزینه ساعتی از کیف پول کم می‌شود.

اگر از قبل یک پایگاه دادهٔ PostgreSQL مدیریت‌شده دارید، می‌توانید سرویس db را از فایل compose حذف کنید و نشانی آن را در CMD_DB_URL بدهید؛ در این حالت بکاپ شبانهٔ پایگاه داده را سرویس مدیریت‌شده انجام می‌دهد و سرور HedgeDoc سبک‌تر می‌شود.

یک الگوی رایج در تیم‌ها ترکیب این ابزارهاست: بحث و پیش‌نویس در HedgeDoc انجام می‌شود، چون نوشتن هم‌زمان در آن سریع است، و نسخهٔ نهایی که باید ماندگار و قابل جست‌وجو باشد به ویکی منتقل می‌شود. چون هر دو Markdown را می‌فهمند، این انتقال با یک کپی ساده انجام می‌شود.

انتخاب بین این ابزارها به نوع متنی که می‌نویسید بستگی دارد:

نصب خودکار است و کار شما از انتخاب پلن تا امن کردن دسترسی‌ها این مسیر را دارد:

مهم‌ترین تصمیم امنیتی HedgeDoc این است که چه کسی بتواند یادداشت بسازد. در تنظیم پیش‌فرض نصب خودکار ما ویرایش ناشناس و ثبت‌نام با ایمیل روشن است؛ برای یک سرور عمومی این یعنی هر کسی می‌تواند از سرور شما برای انتشار محتوا استفاده کند و مسئولیتش با صاحب سرور است. برای تیم خصوصی، هر دو را خاموش کنید و حساب‌ها را خودتان بسازید.

ورود و کوکی نشست روی HTTP رمزگذاری نمی‌شوند. یک زیردامنه در مدیریت DNS بسازید و Edge Proxy را روشن کنید که HTTPS را روی لبه برقرار می‌کند، WebSocket لازم برای ویرایش هم‌زمان را عبور می‌دهد و با سرور روی پورت ۸۰ ارتباط دارد. سپس CMD_DOMAIN را روی دامنه و CMD_PROTOCOL_USESSL را true کنید. در فایروال شبکه پورت‌های اضافه را ببندید.

دو چیز را نگه دارید: پایگاه دادهٔ PostgreSQL که متن یادداشت‌ها، کاربران و تاریخچه را دارد و پوشهٔ uploads که تصاویر را دارد. برای پایگاه داده از دستور pg_dump داخل سرویس db خروجی بگیرید؛ کپی مستقیم پوشهٔ db-data هنگام اجرای پایگاه داده قابل اعتماد نیست. خروجی را همراه پوشهٔ uploads در فضای ذخیره‌سازی ابری نگه دارید. بکاپ تصویری کل سرور را هم می‌توانید هر زمان از پنل بسازید؛ زمان‌بندی خودکار ندارد و ۲ تومان برای هر گیگابایت در ساعت هزینه دارد؛ جزئیات در صفحهٔ پشتیبان‌گیری.

برای انتقال، همان فایل compose را روی سرور تازه اجرا کنید، خروجی پایگاه داده را بازگردانید و پوشهٔ uploads را کپی کنید. اگر دامنه ثابت بماند، پیوندهای قبلی یادداشت‌ها همچنان کار می‌کنند.

محدودیت‌ها: نصب خودکار فقط هنگام سفارش سرور تازه انتخاب می‌شود و روی سرور موجود از پنل اضافه نمی‌شود؛ دامنه و HTTPS را خودتان تنظیم می‌کنید؛ پشتیبانی راست‌به‌چپ کامل نیست؛ HedgeDoc ساختار پوشه و جست‌وجوی سراسری قوی مثل ویکی ندارد؛ و ورود با سرویس‌های خارجی مثل GitHub به تنظیم جداگانه نیاز دارد.