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, в котором описаны возможности редактора.
Для создания нового дерева документов нажмите на три точки в панели инструментов и выберите New notebook, введите произвольное имя и нажмите Create.
Чтобы создать вложенный документ, нажмите на кнопку + напротив родительского документа.
Установка плагинов
SiYuan поддерживает плагины, которые можно найти в магазине плагинов.
Чтобы получить доступ к магазину плагинов перейдите в меню настроек, нажав на workspace в левом верхнем углу страницы и выбрав Settings, и далее в подраздел Marketplace.
Ознакомьтесь с возможными рисками безопасности и, для продолжения, примите их, нажав на Trust.
Магазин плагинов будет доступен во вкладке Plugins.
Обновление ПО
Для обновления инсталляции SiYuan потребуется зайти на сервер по SSH под пользователем root и выполнить две команды:
cd /siyuan/ && docker compose pull
systemctl restart siyuan.service
Установленное ПО
| Название | Лицензия |
|---|---|
| SiYuan | AGPL-3.0 license |
| Caddy | Apache License 2.0 |
Полезные ссылки
Для получения дополнительной информации об установленных пакетах, пожалуйста, обратитесь к их официальной документации: