Cómo instalar Raneto en Ubuntu 17.10

• Prerrequisitos
• Iniciando sesión
• Instalación de Node.js y PM2
• Instalando Raneto
• Configuración adicional
• Agregar páginas
• Agregar categorías

Raneto es una base de conocimiento gratuita y de código abierto, construida sobre Node.js que es fácil de configurar y usar, así como fácil de administrar. Las categorías y páginas están escritas en Markdown, lo que facilita la edición. Si Markdown no es lo tuyo, Raneto también te permite usar HTML.

Prerrequisitos

• Un VPS con Ubuntu 17.10 instalado.
• Acceso SSH a su VPS.
• Conocimientos básicos del terminal de Linux.

Iniciando sesión

Primero, necesitamos iniciar sesión en nuestro servidor usando SSH. Para hacer esto, abra su cliente SSH favorito.

ssh root@SERVER_IP

Después de ingresar su contraseña (puede obtenerla desde el panel de control de Vultr), iniciará sesión en su VPS.

Instalación de Node.js y PM2

Raneto se ejecuta en Node.js, un entorno de ejecución y marco de JavaScript. En este tutorial, utilizaremos Node.js v8 debido a su soporte a largo plazo. Inicie la instalación escribiendo el siguiente comando.

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

Una vez que este script haya terminado de ejecutarse, puede ejecutar la instalación principal.

sudo apt-get install -y nodejs

Una vez que este instalador haya finalizado, tendrá una copia actualizada de Node.js instalada en su VPS. A continuación, instalaremos PM2, un administrador de procesos para Node.js que facilita la ejecución de Raneto (y muchas otras aplicaciones de Node.js).

npm install pm2 -g

Ahora tenemos todo el software que necesitamos para instalar Raneto.

Instalando Raneto

Vamos a usar Git para clonar el repositorio de Raneto en nuestro servidor.

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

Esto creará una carpeta llamada Raneto. Ingrese la carpeta.

cd Raneto

Instalar NPM.

npm install

Ejecute Gulp escribiendo lo siguiente.

npm run gulp

Una vez que Gulp ha terminado de ejecutarse, podemos iniciar nuestra aplicación usando uno de los dos comandos siguientes.

npm start
# or
npm example/server.js

Ahora podrá acceder a su nueva instalación de Raneto navegando a SERVER_IP:3000. El resto de este tutorial le enseñará cómo configurar aún más Raneto, crear nuevas páginas, agregar categorías, ajustar la clasificación, agregar una página de inicio personalizada y editar la plantilla.

Configuración adicional

Ahora tiene una instalación Raneto predeterminada alojada en su VPS. Antes de comenzar a hacer cualquier otra cosa, le sugiero que haga algunos cambios en la configuración y configuración predeterminadas.

Echemos un vistazo a config.default.js, que se encuentra en la examplecarpeta. Este archivo de configuración es bastante largo, pero no se sienta abrumado, ya que está muy comentado. Estas son las propiedades que debe editar:

• site_title - Cambie esto al título de su sitio web.
• base_url- Esto debe establecerse en la URL de su sitio. Se puede usar como variable al editar páginas.
• support_email- Cambie esto a un correo electrónico válido. Se mostrará en el pie de página del sitio.
• copyright - Texto de pie de página.
• analytics - Agregue un código de seguimiento de Google Analytics aquí.
• allow_editing - ¿Desea poder editar archivos con el editor web?
• authentication_for_read - ¿Desea que las personas inicien sesión para ver el sitio web?
• credentials - Agregue usuarios aquí si el inicio de sesión está habilitado.
• locale - Idioma.
• datetime_format - Formato de la fecha y hora.
• home_meta - Edite esto para cambiar la metainformación de su página de inicio.
• table_of_content - ¿Debería Raneto mostrar una tabla de contenido?

Usando el editor en línea

Raneto viene con una interfaz en línea fácil de usar para administrar páginas, categorías y más. Si bien no le permite hacer todo, sin duda es útil si necesita hacer una edición rápida sobre la marcha.

Puede acceder habilitando la configuración en config.default.js(como se mencionó anteriormente) y luego visitando su VPS y haciendo clic en el botón de inicio de sesión en la esquina superior derecha. Ingrese su nombre de usuario y contraseña (puede cambiarlos config.default.js) y haga clic en iniciar sesión. Simplemente haga clic en la página que necesita editar, haga clic en el Actionsmenú desplegable y elija la acción que desea completar. Puede agregar páginas presionando el +botón al lado del nombre de la categoría, y puede crear categorías usando el campo de entrada en la esquina superior izquierda.

Agregar páginas

Agregar páginas es tan simple como crear un nuevo .mddocumento Markdown ( ) en la example/contentcarpeta.

Una vez que haya creado un nuevo archivo Markdown, es importante que agregue información básica en la parte superior del archivo. Abra el archivo en su editor de texto favorito. Necesitamos agregar lo siguiente en la parte superior del archivo.

/*
 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
 */

Si lo necesita, también puede usar las siguientes variables en sus páginas:

• %base_url% - Esto le permite mencionar la URL de su sitio web.
• %image_url% - Esto le permite obtener la URL base de su directorio de imágenes.

Agregar categorías

Puede agregar categorías a su base de conocimiento fácilmente. Simplemente cree una nueva carpeta en el example/contentdirectorio y coloque las páginas que desea que estén en esa categoría en esa carpeta. Por ejemplo, digamos que queríamos una categoría llamada helpcon páginas llamadas contact, help-mey awesome. Los archivos se verían así:

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

Puede agregar tantas subcarpetas como desee dentro de las categorías.

Las categorías también pueden tener metainformación. Cree un archivo llamado metaen la carpeta de categoría. Se admiten los siguientes atributos (todos opcionales):

• Título: anula el título según el nombre de la carpeta.
• Ordenar: le permite ordenar el orden de las categorías, funciona de la misma manera que ordenar las páginas.
• ShowOnHome: verdadero / falso.

Página de inicio personalizada

Si desea agregar una página de inicio personalizada, todo lo que necesita hacer es agregar un archivo de rebajas llamado index.mda su example/contentcarpeta.

Ordenar páginas

Raneto clasifica automáticamente las páginas alfabéticamente, pero puede aplicar una clasificación manual agregando un Sortelemento al meta de la página. El valor de sort debe ser un número entero, por ejemplo:

Sort: 7

Esta página ahora aparecería antes de las páginas con un valor de clasificación de 8 o más, pero después de las páginas con un valor de 6 o menos.

Cambiar la plantilla

Si está familiarizado con HTML o CSS, puede cambiar fácilmente el aspecto de su instalación de Raneto. Raneto usa Handlebars, un lenguaje de plantillas JavaScript, que modulariza la edición de HTML. Puede encontrar los archivos de tema en la themes/defaultcarpeta. Si desea obtener más información sobre la edición de plantillas de Renato, puede visitar su sección de ayuda . Una vez que haya terminado de editar la plantilla, asegúrese de reiniciar la aplicación.