Doc Most: Захоплення знань, що розквітають в хмарах
Привіт, друзі! Сподіваюся, у вас сьогодні все добре. Відео, яке я ділюся з вами сьогодні, присвячене додатку для ведення нотаток, яке нещодавно з’явилося у моєму полі зору. Ми вже розглядали кілька різних додатків для нотаток: від Memos до Joplin, і, звісно, Hedgedoc. Саме Hedgedoc я використовувала протягом останніх дев’яти-десяти місяців. І мушу сказати, він чудовий, мені дуже подобалося його використання.
Але нещодавно на горизонті матеріалізувався новий (для мене) додаток під назвою Doc Most. Власне, про нього я дізналася з інформаційного бюлетеня Ітана Ша, присвяченого самостійному хостингу. Якщо ви ще не підписалися, дуже раджу це зробити! (трохи самореклами: мене навіть згадали в цьому бюлетені, тому щиро вдячна Ітану за це!). Посилання на все, про що йтиметься у відео, ви знайдете в описі.
Отже, як я вже казала, я довго користувалася Hedgedoc (навіть написала сценарій для цього відео саме в ньому!). Але сьогодні я вирішила відійти від сценарію і провести це відео в більш живому, невимушеному форматі. Так, це ускладнює процес редагування, але мені здається, що так буде природніше. Якщо вам сподобається це відео, будь ласка, поставте лайк і підпишіться. В описі є й інші способи підтримати мій канал, ставши патроном або учасником. Вони дають ранній (або безплатний!) доступ до всього контенту.
І з цим довгим вступом, давайте перейдемо безпосередньо до Doc Most!
Що робить Doc Most таким особливим?
Це вебсайт Doc Most. За замовчуванням він у світлому режимі, але я перемкнула його в темний. Це програмне забезпечення для спільного використання, вікі-розділу та документації з відкритим вихідним кодом. Мені це дуже подобається! До речі, саме це пропонує Hedgedoc. Але в Doc Most є деякі речі, які мені подобаються більше.
Головна ідея: Створюйте, співпрацюйте та діліться знаннями без проблем. Doc Most ідеально підходить для управління вашою вікі, базою знань, документацією та багато іншого.
Ось деякі з його ключових особливостей:
- Редактор з багатим текстом у реальному часі, що дозволяє працювати над текстом спільно та миттєво бачити зміни.
- Система дозволів – дозволяє налаштовувати доступ для користувачів, щоб забезпечити безпеку та контроль над вашими даними.
- Простори. Про них поговоримо детальніше. Уявіть собі їх як групи документації – книги, проєкти, розділені за певними категоріями. Це дозволяє краще структурувати інформацію.
- Коментарі – можливість обговорювати окремі фрагменти тексту.
- Історія сторінок – щоб ви могли відстежувати зміни і, за потреби, повертатися до попередніх версій.
Вони також пропонують: посилання на GitLab та інструкцію з встановлення; скріншот з прикладом робочого середовища.
На сторінці документації ви також знайдете інформацію про аутентифікацію, що дуже важливо для захисту ваших даних.
Самостійний хостинг: ваш власний простір
Зверніть увагу: на момент запису цього відео, 19 липня 2024 року, багато чого може змінитися. Розробники часто вносять оновлення, які роблять інформацію застарілою. Тому, якщо ви дивитеся це відео через тиждень або більше, будь ласка, перевіряйте актуальність інформації в документації. Налаштування, змінні середовища, дизайн інтерфейсу можуть змінитися. Я не контролюю ці зміни, тому, якщо щось буде по-іншому, просто сприйміть це. Можете залишити коментар, щоб інші користувачі знали про зміни.
В описі до відео ви знайдете посилання на документацію Doc Most, щоб ви могли самостійно ознайомитися з налаштуваннями, встановленням та конфігурацією.
Doc Most у дії: огляд мого робочого простору
У мене запущено кілька екземплярів на моєму демонстраційному сервері. Я вже увійшла до свого облікового запису.
У мене є кілька робочих просторів і кілька сторінок, які я вже наповнила. Оскільки я адміністратор, у мене є доступ до всього. Також можна налаштувати різні ролі та дозволи для різних користувачів у різних просторах.
На верхній панелі – панель навігації. Тут можна побачити робочі простори, до яких ви маєте доступ.
На лівій панелі у нас:
- Огляд. Тут ми зараз знаходимося.
- Пошук. Пошук здійснюється за назвами сторінок та за змістом.
- Налаштування простору. Тут можна змінювати назву робочого простору, його ідентифікатор, налаштувати опис. Щоб запросити нових членів, необхідний SMTP-сервер.
Ви можете додавати нові сторінки, просто натиснувши відповідне посилання.
Давайте перейдемо до розділу «Новий простір»: там є лише кілька сторінок. Можна додавати емодзі, щоб зробити їх більш персональними.
Зверніть увагу: ліворуч можна легко вкладати сторінки. Це робить структурування дуже зручним. Також можна змінювати порядок сторінок, перетягуючи їх.
Якщо ми відкриємо сторінку, ми побачимо:
- Назву сторінки угорі.
- Текст.
- Заголовки (H1, H2, тощо).
- Коментарі.
- Виділені фрагменти тексту.
Коли ви клікаєте на певний фрагмент тексту, з’являються коментарі, пов’язані з ним. Можна форматувати текст, додавати заголовки. Можна виділяти текст, змінювати формат: жирний шрифт, курсив, підкреслення, закреслення, код, посилання, колір тексту, або залишити коментар.
Я дуже люблю функцію коментарів!
Ще одна корисна функція – перетягування фрагментів тексту. З її допомогою можна легко змінювати порядок розділів.
У верхній частині екрана є значок коментарів. З його допомогою можна відкривати/закривати коментарі. Також там є опція «Повноекранний режим». Там також є історія сторінки. Можна переглядати старі версії сторінок, і, за потреби, відновити їх.
Єдине побажання: Я не знайшла інформації про те, як часто сторінки автоматично зберігаються. Також немає функції ручного збереження. Я хотіла б бачити таку функцію, і, можливо, можливість налаштовувати інтервал автозбереження. Можливо, це вже там є, але я не знайшла.
На лівій панелі також є розділ «Сторінки». Біля кожної сторінки є три крапки. Через них можна скопіювати посилання або видалити сторінку. Також можна додати нову сторінку до поточної.
Коли ви клікаєте на назву сторінки ліворуч, можна додати емодзі – це зручно для позначення різних типів контенту.
У Doc Most я дуже ціную організацію просторів – це дозволяє краще структурувати інформацію.
Я, як і раніше, кажу Doc Most – саме тому, що я маю його у своїх нотатках. Мені цього дуже не вистачало у Hedgedoc.
Налаштування профілю та робочого середовища
Тепер перейдемо до верхнього правого кута, де є моє ім’я та аватар. Клікнувши на нього, ми побачимо:
- Налаштування робочого простору
- Керування учасниками
- Інформація про обліковий запис
- Мій профіль
- Параметри
Спочатку налаштування робочого простору. Тут можна побачити учасників, їх статус. Ви можете призначати ролі (власника, адміністратора або члена). Ще бачите, хто з учасників запрошений, але ще не прийняв запрошення. Можна запросити нових учасників, заповнивши відповідну інформацію та надіславши запрошення (за умови налаштування SMTP-сервера).
Далі йдуть групи. Можна створити додаткові групи для більш ефективного управління користувачами (наприклад, «Відділ обслуговування клієнтів», «Технічна підтримка» та ін.).
Також можна створювати нові робочі простори.
У розділі «Параметри» можна налаштувати тему (темна/світла), параметри відображення. Цей розділ налаштовує параметри саме вашого облікового запису.
У розділі «Профіль» можна змінювати ім’я, фото та пароль. Змінити електронну пошту, на жаль, неможливо.
Встановлення Doc Most: практичний посібник
Doc Most дуже зручний у використанні. Він дозволяє створювати та редагувати сторінки, додавати коментарі, організовувати контент.
Тепер давайте подивимося, як встановити Doc Most. Проаналізуємо Docker-композицію та деякі моменти, які необхідно враховувати.
Перейдемо знову до розділу з інструкціями. Все буде в описі під відео.
Від вас потрібні певні передумови:
- Docker
- Ubuntu (якщо ви використовуєте Ubuntu, але це не обов’язково)
Ви можете встановити Docker-композицію на основі попередньо згенерованого файлу (як я) або вручну.
Важливо! Параметр app URL
є необов’язковим (але корисним!), особливо якщо ви плануєте надсилати електронні листи.
Ось приклад Docker-композиції. Найновіша версія Docker-композиції може видавати помилку, якщо ви вказуєте version
. Тому цю опцію вже можна видалити.
У нас є:
docm
database
redis cache
У docm
:
- Зображення (image) – остання версія Doc Most.
- Залежності (database and redis cache).
- Змінні середовища (environmental variables):
app URL
(необов’язково, але корисно, якщо ви хочете ділитися з іншими та надсилати запрошення електронною поштою).app secret
(секретний ключ для безпеки). Я використовую менеджер паролів, який генерує випадковий рядок.database URL
(URL бази даних, PostrgreSQL). Обов’язково, якщо ви збираєтеся надсилати запрошення електронною поштою.redis URL
(кеш для прискорення роботи).ports
(порти). За замовчуванням використовується порт 3000.restart policy
(політика перезапуску):unless-stopped
, що означає, що контейнер перезавантажуватиметься автоматично, доки ви не зупините його вручну.volumes
(томи, де зберігається контент).
У базі даних (database):
- Використовується PostrgreSQL 16 (Alpine).
- Змінні середовища:
- User
- Password (важливо узгодити з
database URL
)
restart policy
– unless-stopped
.
Томи (volumes): для зберігання даних в Docker.
У Redis Cache:
- Зображення (image): Redis Alpine.
restart policy
.- Том (volume).
Усе дуже просто! Давайте встановимо. Я покажу це ще раз, навіть попри те, що у мене вже запущена робоча копія.
Повертаємося до Portainer. Я видалю старий контейнер, щоб показати все спочатку.
Повертаємося до Stacks. Створюємо новий stack. Вставляємо Docker-композицію. Видаляємо version
. Видаляю app URL
, тому що я збираюся робити це локально. Якщо ви плануєте використовувати Doc Most публічно, вкажіть app URL
. Важливо! Якщо ви будете надсилати запрошення, необхідно налаштувати SMTP.
Також може знадобитися налаштувати SMTP.
Залежно від налаштувань SMTP додайте змінні середовища.
За налаштуванням ставимо знак двокрапки :. Вказуємо хост, логін, тощо.
Натискаємо «Deploy».
Це має відбутися швидко, оскільки образи Docker вже завантажені.
Почекаємо.
Ось! Все працює!
Переходимо за адресою в браузері. Нам пропонують створити робочий простір.
Все успішно! Тепер можна створювати сторінки, структурувати їх.
Я дуже задоволена Doc Most. Є кілька моментів, які хотілося б покращити, але в цілому – це гарний продукт, який замінить Hedgedoc.
Якщо вам сподобалося відео, ставте лайки та підписуйтесь. Це безплатний спосіб повідомити мене, що вам цікавий такий контент. Щоб підтримати мене ще більше, ви можете стати учасником каналу або патроном, або зробити пожертву через PayPal (посилання в описі). Це не обов’язково, але я буду вдячна!
Дякую, що провели зі мною ці хвилини! До зустрічі в наступному відео!