Instalación

OAR es un relay que ejecutas en tu propia máquina. Al instalarlo, el comando oar queda disponible en esa máquina. En macOS y Linux, una sola línea hace todo el trabajo: encuentra o descarga Node.js, instala OAR, escribe la configuración y arranca el relay. En Windows, el instalador necesita que Node.js ya esté instalado, y siempre puedes instalar con npm o desde un checkout de git.

Requisitos #

No hace falta nada más para instalar. Los proveedores los añades cuando OAR ya está en marcha.

macOS y Linux #

curl -fsSL oar.sh/install | sh

Puedes leer antes el script en oar.sh/install. Necesita curl o wget, y tar cuando tiene que descargar Node.js. Se niega a ejecutarse como root: OAR se instala por usuario, y nada necesita root.

Qué hace #

1. Mira lo que tiene la máquina e imprime un plan: qué Node.js usa, dónde instala OAR, qué escribe en el perfil de tu shell y cómo se arrancará el relay.
2. Pregunta Continue? [Y/n]. Enter o y continúa; cualquier otra respuesta no cambia nada.
3. Instala el paquete @oar-sh/oar (la última versión, salvo que fijes una versión o un canal).
4. Ejecuta oar setup --defaults --start: escribe la configuración (un token de autenticación nuevo, acceso solo para esta máquina, el primer puerto libre a partir de 3333 o el puerto que fijes con OAR_PORT) y arranca el relay. Imprime la URL del relay y un código QR.
5. Imprime la versión, te dice que el relay está en marcha y lista los comandos oar, oar setup y oar doctor.

En Linux con una sesión de usuario de systemd, el relay se arranca como un servicio de usuario de systemd, así que vuelve tras un reinicio. En los demás casos (macOS, contenedores, WSL sin systemd) se arranca en segundo plano, y oar start lo vuelve a arrancar tras un reinicio.

Dónde se instala #

Cuál de los tres casos se aplica depende del Node.js que tenga la máquina.

Solo OAR usa su propio Node.js. El comando oar de ~/.local/bin pone ese Node.js al final del PATH, así que un Node.js tuyo sigue teniendo prioridad en las sesiones del relay.

En los dos últimos casos, cuando ~/.local/bin no está en tu PATH, el instalador incluye el cambio en su plan y luego añade una línea de comentario (# added by the OAR installer) y una línea export PATH al archivo de inicio de tu shell: ~/.zshrc para zsh, ~/.bash_profile para bash en macOS, ~/.bashrc para bash en Linux y ~/.profile en los demás casos. Las terminales nuevas encuentran oar; en la actual, ejecuta la línea export PATH=... que imprime el instalador.

Opciones #

Los flags van después de sh -s --. Las variables van antes de sh.

Cualquier otro flag detiene el instalador con unknown option.

curl -fsSL oar.sh/install | sh -s -- --yes
curl -fsSL oar.sh/install | OAR_VERSION=0.9.19 OAR_PORT=3400 sh
curl -fsSL oar.sh/install | OAR_DRY_RUN=1 sh

Volver a ejecutarlo #

El instalador puede volver a ejecutarse en cualquier momento. Instala de nuevo el paquete (la última versión, salvo que fijes una), así que también sirve como actualización. Conserva una configuración existente, reutiliza el propio Node.js de OAR si sigue siendo lo bastante reciente, reescribe el lanzador oar y añade las líneas de PATH a tu perfil una sola vez.

Ejecutarlo sin terminal #

Cuando se canaliza desde curl, el script hace su pregunta en la terminal. Sin terminal, por ejemplo en un job de CI, se detiene con no terminal to ask on y no cambia nada. En ese caso, pasa --yes.

Dónde se detiene #

• No tiene una compilación de Node.js para sistemas musl como Alpine, ni para CPU que no sean x64 y arm64. Instala tú Node.js 22.13 o posterior y vuelve a ejecutar el instalador.
• Si no se puede llegar a nodejs.org, falla una descarga o una suma de comprobación, o el Node.js descargado no se ejecuta, se detiene y no instala nada.
• Las versiones anteriores a 0.9.8 se instalan igual, pero su oar setup no puede arrancar el relay. En ese caso, el instalador solo escribe la configuración y no arranca el relay.

Windows #

irm oar.sh/install.ps1 | iex

Esto necesita PowerShell 5 o posterior y Node.js 22.13 o posterior ya instalado. A diferencia del instalador de macOS y Linux, no descarga Node.js, no pide confirmación y no arranca el relay. Hace esto:

1. Comprueba que existen node y npm y que Node.js es lo bastante reciente.
2. Imprime el plan.
3. Ejecuta npm install -g --allow-scripts=@oar-sh/oar,better-sqlite3,koffi @oar-sh/oar.
4. Ejecuta oar setup. En una terminal pregunta si crear un token de autenticación nuevo, el acceso (solo esta máquina, o LAN), el puerto y, Nuevo en 0.9.15 cómo arranca el relay: al iniciar sesión, al encender antes de que nadie inicie sesión (con una petición de administrador) o nunca. Después escribe la configuración e imprime la URL del relay.

Ejecuta después oar start para arrancar el relay; el inicio automático que elegiste lo arranca en el siguiente inicio de sesión o encendido. oar autostart cambia el modo más adelante. Lo que viene a continuación está en Primer arranque.

Fija la variable en la misma ventana de PowerShell antes del comando. El instalador de Windows no tiene OAR_PORT; oar setup pregunta el puerto, o ejecutas oar setup --port <port>.

Set-ExecutionPolicy -Scope CurrentUser RemoteSigned

Si la instalación funciona pero no se encuentra oar, abre una terminal nueva y ejecuta oar.cmd setup.

npm #

npm install -g --allow-scripts=@oar-sh/oar,better-sqlite3,koffi @oar-sh/oar
oar setup

npm 12 no ejecuta ningún script de instalación que no se le haya indicado que permita. Dos de las dependencias de OAR (better-sqlite3, koffi) descargan su binario nativo en uno de ellos: sin ellos, la instalación tiene éxito en npm 12 y luego el relay no arranca. Nuevo en 0.9.14 El propio script de OAR (@oar-sh/oar) copia los datos que una versión anterior guardaba dentro del paquete antes de que npm lo elimine; consulta Notas de actualización de 0.9.14. npm 10 y 11 aceptan el flag y no lo necesitan. Los instaladores, oar update y el botón Update (Actualizar) lo pasan por sí mismos.

oar setup crea la configuración e imprime la URL del relay, pero no arranca el relay salvo que pases --start. Usa después oar start. La carpeta global de npm debe admitir escritura y su carpeta bin debe estar en tu PATH; npm prefix -g muestra dónde está. Si necesita root, no uses sudo: ejecuta en su lugar el instalador en macOS o Linux. Para actualizar más adelante, ejecuta oar update.

Desde un checkout de git #

git clone https://github.com/oar-sh/oar
cd oar
npm install
node bin/oar.js setup   # writes server/config.json with a fresh auth token
npm start               # the same as: node server/server.js

Un checkout se diferencia de una instalación global en tres cosas:

• El estado vive dentro del repositorio: server/config.json, server/data/, server/uploads/ y server/logs/. Una instalación global guarda su estado en ~/.oar (consulta Dónde guarda OAR sus archivos y Archivos y carpetas).
• Nunca se actualiza solo. Actualiza con git pull y npm install, y luego reinicia el relay con 🌄 Restart web relay (Reiniciar el relay web) en el menú ⋯ de una conversación. oar update es para instalaciones globales.
• oar start, oar stop y oar restart son solo para instalaciones globales. En un checkout, npm start ejecuta el relay en primer plano.

node server/server.js --port <port> --token <token> sobrescribe la configuración durante una ejecución sin guardarla.

Por plataforma #

Tras un reinicio, oar start arranca un relay que se ejecuta en segundo plano.

WSL #

Ejecuta el instalador de Linux dentro de la distribución, no en Windows. Con la red predeterminada de WSL, un puerto puede estar libre dentro de la distribución mientras un programa de Windows escucha en él, y localhost:<port> en un navegador de Windows llega entonces a ese programa. Por eso, una configuración nueva toma el primer puerto libre en ambos lados, y oar setup rechaza un puerto que ocupe Windows. oar status, oar start y oar doctor avisan cuando Windows ocupa el puerto del relay. Para solucionarlo, elige otro puerto:

oar setup --port 3400

Una dirección LAN dentro de WSL es interna de WSL. Para acceder desde el teléfono, usa un túnel o la red en modo espejo de WSL.

Quitar OAR #

Nuevo en 0.9.15 oar uninstall quita OAR de la máquina y conserva tus datos:

oar uninstall

Detiene el relay (esperando a los turns en curso), quita las entradas de inicio automático que generó OAR (la unidad de systemd, o la entrada de inicio de sesión y la tarea de arranque de Windows, con una petición de administrador para la tarea de arranque) y el wrapper de la extensión de Copilot que escribió OAR, y hace que npm elimine el paquete cuando el comando ha terminado. Las entradas que creaste o editaste a mano se quedan y se nombran. Tu configuración, tu base de datos, tus archivos subidos y tus registros se quedan en la carpeta de estado, y el comando imprime dónde; una instalación posterior los vuelve a usar. oar uninstall tiene los detalles y todos los mensajes.

Para eliminar también los datos:

oar uninstall --purge

Elimina la carpeta de estado después de que escribas delete, y pregunta aparte antes de eliminar una carpeta de datos fuera de ella, una dentro de un checkout de git o rescued-package-data. Rechaza la raíz de una unidad, tu carpeta personal, una carpeta del sistema y cualquier carpeta que no contenga la configuración o la base de datos de OAR. Esto elimina tus conversaciones.

oar uninstall no deshace lo que el instalador de macOS y Linux añadió fuera del paquete:

• el script oar de ~/.local/bin, cuando el instalador lo puso allí (sus casos segundo y tercero);
• las dos líneas que añadió al archivo de inicio de tu shell, si las hay (el comentario # added by the OAR installer y la línea export PATH que lo sigue);
• ~/.oar/runtime, el propio Node.js de OAR, si está ahí. Está dentro de la carpeta de estado, así que se queda sin --purge.

Antes de 0.9.15, o cuando oar ya no se ejecuta, quita las piezas a mano: detén el relay con oar stop y ejecuta oar service remove donde haya un servicio o un inicio automático de Windows configurado; elimina el paquete con npm uninstall -g @oar-sh/oar, o, tras los otros dos casos del instalador, borra ~/.oar/npm; después, las piezas de arriba, y ~/.oar o %APPDATA%\oar solo si quieres eliminar tus datos.

Dónde guarda OAR sus archivos #

Una instalación global guarda su estado en ~/.oar (%APPDATA%\oar en Windows; OAR_STATE_ROOT lo traslada):

• config.json
• data/, con la base de datos y los archivos subidos
• logs/, con server.log y server-err.log cuando oar arrancó el relay, y un worker-<session>.log por cada worker de sesión de Node

Actualizar el paquete con npm nunca toca estos archivos. El instalador de macOS y Linux puede añadir ahí dos carpetas que no son estado: npm/ (el paquete, cuando no se podía escribir en la carpeta global de npm) y runtime/node/ (el propio Node.js de OAR). oar doctor imprime las rutas en uso.

Lo que tienes después #

• El comando oar. En una terminal, oar solo abre un menú con el estado del relay y los demás comandos. oar setup cambia los ajustes (acceso desde otros dispositivos, puerto, token), y oar url vuelve a imprimir la URL del relay.
• Una configuración con un token de autenticación nuevo. Con el acceso predeterminado, el relay solo es accesible desde esta máquina, en http://localhost:3333/ o el siguiente puerto libre.
• En macOS y Linux: un relay en marcha. En Windows y tras una instalación manual con npm: un relay que arrancas con oar start.

Comprueba lo que está instalado:

oar --version
oar doctor

oar doctor imprime la versión, Node.js, el modo de instalación, la carpeta de estado, la ruta de la configuración, el puerto, si hay un token fijado, la ruta y el tamaño de la base de datos, y qué CLI de proveedores responden. No cambia nada.

Solución de problemas #

Para problemas posteriores a la instalación, consulta Solución de problemas.