SiYuan

Opis

SiYuan to wygodne narzędzie do tworzenia, edytowania i organizowania notatek z obsługą tekstu, obrazów, diagramów i wielu innych funkcji upraszczających pracę z informacjami. Obsługuje język znaczników Markdown.

uwaga

Preinstalowana wersja oprogramowania nie obsługuje synchronizacji między urządzeniami. Z oprogramowania można korzystać wyłącznie z poziomu przeglądarki.

Pierwsze kroki

SiYuan jest instalowany wraz z obrazem i uruchamia się automatycznie po uruchomieniu serwera.

Po zainstalowaniu obrazu interfejs webowy SiYuan będzie dostępny pod adresem https://example.com/, gdzie example.com to nazwa hosta Twojego serwera.

Aby uzyskać dostęp do interfejsu webowego, użyj danych logowania wysłanych do Ciebie e-mailem.

Dodatkowo dane logowania można znaleźć na serwerze w pliku:

/root/.app_credentials

Aby uzyskać dostęp do tego pliku, musisz zalogować się do serwera przez SSH. Możesz połączyć się z serwerem przez SSH:

• Za pomocą klucza SSH, jeśli ta opcja została włączona przed utworzeniem serwera
• Za pomocą hasła użytkownika root wysłanego e-mailem przy aktywacji serwera

Zmiana domeny

Jeśli chcesz używać własnej domeny lub subdomeny do uzyskiwania dostępu do interfejsu webowego SiYuan, musisz zalogować się do serwera przez SSH jako użytkownik root i wykonać polecenie:

add_domain

Zostaniesz poproszony o podanie domeny lub subdomeny w formacie subdomain.example.com.

notatka

Upewnij się, że Twoja domena istnieje i wskazuje na adres IPv4 Twojego serwera!

Po zakończeniu działania polecenia dla wskazanej domeny lub subdomeny zostanie wydany certyfikat Let’s Encrypt, a interfejs webowy będzie dostępny pod adresem https://example.com/, gdzie example.com to wcześniej podana domena (subdomena).

Tworzenie dokumentów

Przy pierwszym logowaniu trafisz do drzewa dokumentów SiYuan User Guide, które stanowi krótką dokumentację użytkownika.

Zalecamy zapoznanie się z sekcją Please Start Here, która opisuje możliwości edytora.

Aby utworzyć nowe drzewo dokumentów, kliknij trzy kropki na pasku narzędzi i wybierz New notebook, wpisz dowolną nazwę i kliknij Create.

Aby utworzyć dokument zagnieżdżony, kliknij przycisk + obok dokumentu nadrzędnego.

Instalowanie wtyczek

SiYuan obsługuje wtyczki, które można znaleźć w sklepie z wtyczkami.

Aby uzyskać dostęp do sklepu z wtyczkami, przejdź do menu ustawień, klikając workspace w lewym górnym rogu strony i wybierając Settings, a następnie podsekcję Marketplace.

Zapoznaj się z potencjalnym ryzykiem bezpieczeństwa i, aby kontynuować, zaakceptuj je, klikając Trust.

Sklep z wtyczkami będzie dostępny na karcie Plugins.

Aktualizacja oprogramowania

Aby zaktualizować instalację SiYuan, musisz zalogować się do serwera przez SSH jako użytkownik root i uruchomić dwa polecenia:

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

Zainstalowane oprogramowanie

Nazwa	Licencja
SiYuan	licencja AGPL-3.0
Caddy	Licencja Apache 2.0

Przydatne linki

Więcej informacji o zainstalowanych pakietach znajdziesz w ich oficjalnej dokumentacji:

• SiYuan
• Caddy