Ir para o conteúdo

📌 Guia de Comandos do Legatum Vivum

1. Introdução

Este documento serve como um guia prático para os comandos essenciais no gerenciamento e manutenção do Legatum Vivum. Ele cobre desde a navegação e edição de arquivos até a publicação do site utilizando MkDocs e Nginx.

📌 Objetivo: Garantir que qualquer pessoa envolvida no projeto possa executar as principais operações sem dificuldades técnicas.


2. Estrutura do Guia

Este guia está organizado em três níveis de comandos:

  • 🟢 Básico → Comandos essenciais para navegação e manipulação de arquivos.
  • 🟡 Intermediário → Comandos para edição e versionamento do projeto.
  • 🔴 Avançado → Publicação e manutenção do ambiente de produção.

3. Comandos Essenciais

🟢 3.1 Comandos Básicos (Navegação e Manipulação de Arquivos)

📂 Navegação e estrutura do projeto:

cd ~/dados/legatumvivum   # Acessa o diretório principal do projeto
ls -lh                    # Lista arquivos com detalhes
pwd                       # Exibe o caminho completo do diretório atual
tree                      # Mostra a estrutura do diretório em formato de árvore

📄 Manipulação de arquivos e diretórios:

touch novo_arquivo.md      # Cria um novo arquivo Markdown
mkdir novo_diretorio       # Cria um novo diretório
rm arquivo.md              # Remove um arquivo
rm -r diretorio/           # Remove um diretório e todo seu conteúdo
mv arquivo.md novo.md      # Renomeia ou move um arquivo
cp arquivo.md copia.md     # Copia um arquivo para outro local

🟡 3.2 Comandos Intermediários (Edição e Controle de Versão)

📝 Edição de arquivos no terminal:

nano arquivo.md            # Edita um arquivo com o editor Nano
vim arquivo.md             # Edita um arquivo com o editor Vim
code arquivo.md            # Abre o arquivo no VS Code (se instalado)

🔄 Git (Controle de versão):

git status                 # Verifica mudanças no repositório
git add arquivo.md         # Adiciona um arquivo para commit
git commit -m "Descrição"  # Confirma mudanças com uma mensagem
git push                   # Envia as alterações para o repositório remoto
git pull                   # Atualiza o repositório local com as mudanças remotas

📌 OBS: Certifique-se de configurar o Git corretamente antes do primeiro uso:

git config --global user.name "Seu Nome"
git config --global user.email "seu@email.com"

🔴 3.3 Comandos Avançados (Publicação e Manutenção)

🌐 Gerando e testando o site com MkDocs:

mkdocs serve               # Inicia um servidor local para testar o site
mkdocs build --clean       # Gera a versão estática do site (remove arquivos antigos)

🚀 Publicação no servidor via Rsync:

rsync -avz --delete site/ usuario@servidor:/caminho/destino

📌 OBS: Esse comando sincroniza os arquivos gerados pelo MkDocs com o servidor VPS.

🛠 Manutenção do servidor VPS (Ubuntu + Nginx):

systemctl status nginx     # Verifica o status do servidor web
systemctl restart nginx    # Reinicia o Nginx para aplicar mudanças
ufw allow 80               # Libera a porta HTTP (se necessário)
ufw allow 443              # Libera a porta HTTPS

📜 Certificados SSL (Let's Encrypt / Certbot):

certbot renew              # Renova certificados SSL automaticamente
certbot --nginx            # Reconfigura SSL com Nginx

4. Próximos Passos

🔹 Melhorias futuras: - Criar scripts automatizados para tarefas repetitivas. - Configurar deploy automático com integração contínua. - Adicionar mais comandos úteis baseados na experiência prática.

🚀 Este documento será atualizado conforme novas necessidades surgirem no projeto.