SiYuan
Descrição
SiYuan é uma ferramenta prática para criar, editar e organizar notas com suporte a texto, imagens, diagramas e muitos outros recursos para simplificar o trabalho com informações. Compatível com a linguagem de marcação Markdown.
A versão pré-instalada do software não oferece suporte à sincronização entre dispositivos. O software só pode ser usado a partir de um navegador.
Primeiros passos
O SiYuan é instalado com uma imagem e inicia automaticamente quando o servidor é inicializado.
Após a instalação da imagem, a interface web do SiYuan estará acessível em https://example.com/, em que example.com é o nome de host do seu servidor.
Para acessar a interface web, use as credenciais enviadas a você por e-mail.
Além disso, as credenciais de login podem ser encontradas no servidor no arquivo:
/root/.app_credentials
Para acessar este arquivo, você precisará fazer login no servidor via SSH. Você pode se conectar ao servidor via SSH:
- Com uma chave SSH, se esta opção estiver ativada antes da criação do servidor
- Com a senha do usuário
rootenviada por e-mail quando o servidor é ativado
Alteração de domínio
Se você quiser usar seu próprio domínio ou subdomínio para acessar a interface web do SiYuan, precisará fazer login no servidor via SSH como usuário root e executar o comando:
add_domain
Você será solicitado a inserir um domínio ou subdomínio no formato subdomain.example.com.
Certifique-se de que seu domínio existe e aponta para o endereço IPv4 do seu servidor!
Quando o comando for concluído, um certificado Let’s Encrypt será emitido para o domínio ou subdomínio especificado, e a interface web ficará acessível em https://example.com/, em que example.com é o domínio (subdomínio) especificado anteriormente.
Criação de documentos
No primeiro login, você entrará na árvore de documentos SiYuan User Guide, que é uma breve documentação do usuário.
Recomendamos que você se familiarize com a seção Please Start Here, que descreve os recursos do editor.
Para criar uma nova árvore de documentos, clique nos três pontos da barra de ferramentas e selecione New notebook, insira qualquer nome e clique em Create.
Para criar um documento aninhado, clique no botão + em frente ao documento pai.
Instalação de plugins
O SiYuan oferece suporte a plugins, que podem ser encontrados na loja de plugins.
Para acessar a loja de plugins, vá ao menu de configurações clicando em workspace no canto superior esquerdo da página e selecionando Settings, depois a subseção Marketplace.
Analise os possíveis riscos de segurança e, para continuar, aceite-os clicando em Trust.
A loja de plugins estará disponível na aba Plugins.
Atualização do software
Para atualizar a instalação do SiYuan, você precisa fazer login no servidor via SSH como usuário root e executar dois comandos:
cd /siyuan/ && docker compose pull
systemctl restart siyuan.service
Software instalado
| Nome | Licença |
|---|---|
| SiYuan | licença AGPL-3.0 |
| Caddy | Licença Apache 2.0 |
Links úteis
Para mais informações sobre os pacotes instalados, consulte a documentação oficial deles: