Перейти до основного вмісту

SiYuan

Опис

SiYuan — це зручний інструмент для створення, редагування та організації нотаток з підтримкою тексту, зображень, діаграм та багатьох інших можливостей для спрощення роботи з інформацією. Підтримує мову розмітки Markdown.

обережно

У попередньо встановленій версії програмного забезпечення синхронізація між пристроями не передбачена. Робота з програмним забезпеченням можлива лише з браузера.

Початок роботи

SiYuan встановлюється з образом і автоматично вмикається під час завантаження серверу.

Після встановлення образу веб-інтерфейс SiYuan буде доступний за посиланням https://example.com/, де example.com - hostname Вашого серверу.

Для входу до веб-інтерфейсу використовуйте дані, надіслані вам електронною поштою.

Додатково, дані для входу до веб-інтерфейсу можна знайти на сервері у файлі:

/root/.app_credentials

Для доступу до цього файлу Вам потрібно зайти на сервер SSH. Ви можете зробити це:

  • Через SSH-ключ, якщо Ви вибрали його під час створення серверу
  • Через пароль користувача root, що надсилається поштою при активації серверу

Зміна домену

Якщо Ви бажаєте використовувати свій домен або піддомен для доступу до веб-інтерфейсу SiYuan, Вам потрібно зайти на сервер SSH під користувачем root і виконати команду:

add_domain

Вам буде запропоновано ввести домен або піддомен у форматі subdomain.example.com.

примітка

Переконайтеся, що Ваш домен існує і вказує на IPv4-адресу серверу!

Після закінчення роботи команди для зазначеного домену або піддомену буде випущено Let's Ecnrypt сертифікат, і веб-інтерфейс стане доступним за посиланням https://example.com/, де example.com - вказаний домен (піддомен).

Створення документів

При першому вході ви потрапите до дерева документів SiYuan User Guide, яке є короткою користувацькою документацією.

Рекомендуємо ознайомитися з розділом Please Start Here, в якому описані можливості редактора.

Alt text

Щоб створити нове дерево документів, натисніть на три точки на панелі інструментів і оберіть New notebook, введіть довільне ім'я та натисніть Create.

Alt text

Щоб створити вкладений документ, натисніть на кнопку + навпроти батьківського документа.

Alt text

Встановлення плагінів

SiYuan підтримує плагіни, які можна знайти в магазині плагінів.

Щоб отримати доступ до магазину плагінів, перейдіть до меню налаштувань, натиснувши workspace у верхньому лівому куті сторінки та вибравши Settings, а потім підрозділ Marketplace.

Alt text

Ознайомтеся з можливими ризиками для безпеки та, щоб продовжити, прийміть їх, натиснувши на Trust.

Alt text

Магазин плагінів буде доступний на вкладці Плагіни.

Alt text

Оновлення ПЗ

Для оновлення інсталяції SiYuan потрібно зайти на сервер через SSH під користувачем root та виконати дві команди:

cd /siyuan/ && docker compose pull
systemctl restart siyuan.service

Встановлене ПЗ

НазваЛіцензія
SiYuanAGPL-3.0 license
CaddyApache License 2.0

Корисні посилання

Для отримання додаткової інформації про встановлені пакети, будь ласка, зверніться до їх офіційних документацій: