Como instalar Raneto no Ubuntu 17.10

• Pré-requisitos
• Entrar
• Instalando o Node.js e o PM2
• Instalando o Raneto
• Configuração adicional
• Adicionando páginas
• Adicionando categorias

O Raneto é uma base de conhecimento gratuita e de código aberto, criada no Node.js, fácil de configurar e usar, além de fácil de administrar. Categorias e páginas são escritas no Markdown, o que facilita a edição. Se o Markdown não é o que você gosta, Raneto também permite que você use HTML.

Pré-requisitos

• Um VPS com o Ubuntu 17.10 instalado.
• Acesso SSH ao seu VPS.
• Compreensão básica do terminal Linux.

Entrar

Primeiro, precisamos fazer login no nosso servidor usando SSH. Para fazer isso, abra seu cliente SSH favorito.

ssh root@SERVER_IP

Depois de inserir sua senha (você pode obtê-la no painel do Vultr), você será conectado ao seu VPS.

Instalando o Node.js e o PM2

Raneto é executado no Node.js, um tempo de execução e estrutura em javascript. Neste tutorial, usaremos o Node.js. v8 por causa de seu suporte a longo prazo. Inicie a instalação digitando o seguinte comando.

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -

Após a execução desse script, você pode executar a instalação principal.

sudo apt-get install -y nodejs

Quando este instalador terminar, você terá uma cópia atualizada do Node.js instalada no seu VPS. Em seguida, instalaremos o PM2, um gerenciador de processos do Node.js. que facilita a execução do Raneto (e muitos outros aplicativos do Node.js.).

npm install pm2 -g

Agora temos todo o software necessário para instalar o Raneto.

Instalando o Raneto

Vamos usar o Git para clonar o repositório Raneto no nosso servidor.

git clone https://github.com/gilbitron/Raneto.git

Isso criará uma pasta chamada Raneto. Digite a pasta

cd Raneto

Instale o NPM.

npm install

Execute o Gulp digitando o seguinte.

npm run gulp

Depois que o Gulp terminar de executar, podemos iniciar nosso aplicativo usando um dos dois comandos a seguir.

npm start
# or
npm example/server.js

Agora você poderá acessar sua nova instalação do Raneto navegando para SERVER_IP:3000. O restante deste tutorial ensinará como configurar ainda mais o Raneto, criar novas páginas, adicionar categorias, ajustar a classificação, adicionar uma página inicial personalizada e editar o modelo.

Configuração adicional

Agora você tem uma instalação padrão do Raneto hospedada no seu VPS. Antes de começar a fazer qualquer outra coisa, sugiro que você faça algumas alterações na configuração e instalação padrão.

Vamos dar uma olhada config.default.js, que está localizada na examplepasta Este arquivo de configuração é bastante longo, mas não fique sobrecarregado, pois é muito comentado. Aqui estão as propriedades que você deve editar:

• site_title - Altere isso para o título do seu site.
• base_url- Isso deve estar definido no URL do seu site. Pode ser usado como uma variável ao editar páginas.
• support_email- Altere para um email válido. Ele será exibido no rodapé do site.
• copyright - Texto de rodapé.
• analytics - Adicione um código de rastreamento do Google Analytics aqui.
• allow_editing - Deseja editar arquivos usando o editor da web?
• authentication_for_read - Deseja que as pessoas façam login para visualizar o site?
• credentials - Adicione usuários aqui se o login estiver ativado.
• locale - Língua.
• datetime_format - Formato da data e hora.
• home_meta - Edite isso para alterar as meta informações da sua página inicial.
• table_of_content - Raneto deve exibir um índice?

Usando o Editor Online

Raneto vem com uma interface on-line fácil de usar para gerenciar páginas, categorias e muito mais. Embora não permita que você faça tudo, certamente é útil se você precisar fazer uma edição rápida em movimento.

Você pode acessá-lo ativando a configuração em config.default.js(como mencionado acima) e depois visitando seu VPS e clicando no botão de login no canto superior direito. Digite seu nome de usuário e senha (você pode alterá-los config.default.js) e clique em login. Basta clicar na página que você precisa editar, clicar no Actionsmenu suspenso e escolher a ação que deseja concluir. Você pode adicionar páginas pressionando o +botão ao lado do nome da categoria e pode criar categorias usando o campo de entrada no canto superior esquerdo.

Adicionando páginas

Adicionar páginas é tão simples quanto criar um novo .mddocumento Markdown ( ) na example/contentpasta.

Depois de criar um novo arquivo Markdown, é importante adicionar algumas informações básicas à parte superior do arquivo. Abra o arquivo no seu editor de texto favorito. Precisamos adicionar o seguinte na parte superior do arquivo.

/*
 Title: Enter your page title here, if none is added, the file-name will be used
 Description: Enter your page's description here (for search engines and the site search feature)
 ShowOnHome: true/false
 */

Se necessário, você também pode usar as seguintes variáveis ​​em suas páginas:

• %base_url% - Isso permite que você mencione o URL do seu site.
• %image_url% - Isso permite que você obtenha o URL base do seu diretório de imagens.

Adicionando categorias

Você pode adicionar categorias à sua base de conhecimento facilmente. Basta criar uma nova pasta no example/contentdiretório e colocar as páginas que você deseja que estejam nessa categoria nessa pasta. Por exemplo, digamos que queremos uma categoria chamada helpcom páginas chamadas contact, help-mee awesome. Os arquivos ficariam assim:

/example/content/help/contact.md
/example/content/help/help-me.md
/example/content/help/awesome.md

Você pode adicionar quantas subpastas quiser dentro das categorias.

As categorias também podem ter meta informações. Crie um arquivo chamado metana pasta da categoria. Os seguintes atributos são suportados (todos opcionais):

• Título - Substitui o título com base no nome da pasta.
• Classificar - Permite classificar a ordem das categorias, funciona da mesma maneira que classifica as páginas.
• ShowOnHome - verdadeiro / falso.

Página inicial personalizada

Se você deseja adicionar uma página inicial personalizada, basta adicionar um arquivo de descontos chamado index.mdà sua example/contentpasta.

Classificando páginas

Raneto classifica automaticamente as páginas em ordem alfabética, mas você pode aplicar uma classificação manual adicionando um Sortitem à meta da página. O valor da classificação deve ser um número inteiro, por exemplo:

Sort: 7

Agora, essa página seria exibida antes das páginas com um valor de classificação igual ou superior a 8, mas depois das páginas com um valor igual ou inferior a 6.

Alterando o modelo

Se você estiver familiarizado com HTML ou CSS, poderá alterar facilmente a aparência da sua instalação do Raneto. Raneto usa o Handlebars, uma linguagem de modelagem JavaScript, que modulariza a edição HTML. Você pode encontrar os arquivos de tema na themes/defaultpasta. Se desejar obter mais informações sobre a edição de modelos Renato, visite a seção de ajuda deles . Depois de terminar de editar o modelo, reinicie o aplicativo.