Saltar al contenido

Está viendo el sitio de documentación de versión preliminarEl contenido aquí es para pruebas y puede diferir de la documentación de producción.

Ir a la documentación de producción

Descripción general del autoalojamiento

Ejecute su propia instancia y cada secreto, cuenta y línea de registro permanecerá en infraestructura que usted controla. Usted decide cómo se autentican las cuentas, si la instancia es accesible desde la Internet pública o no, y qué marca muestra la interfaz.

El modo determina qué más tiene que estar en ejecución, así que decídalo antes de instalar.

simple es el modo predeterminado de fábrica y solo necesita el almacén de datos Valkey/Redis. full añade una base de datos SQL para las cuentas, que por defecto es SQLite en sqlite://data/auth.db; PostgreSQL es una opción compatible, no un requisito. En un contenedor, ese archivo necesita un volumen montado para sobrevivir a un reinicio.

Simple o Full explica qué desbloquea cada modo, dónde tiene que residir esa base de datos y lo difícil que es cambiar de modo más adelante.

¿Tiene prisa y ya ejecuta un Valkey o Redis? La forma de un solo docker run en Instalar con Docker levanta una instancia en el puerto 3000 con un valor SECRET generado. Todo lo demás de esta página sigue siendo aplicable una vez que esté en marcha.

  • Imágenes y variantes: cuál de las imágenes publicadas ejecutar y cómo funcionan las etiquetas de versión.
  • Instalar con Docker: las dos pilas de Compose que el proyecto distribuye.
  • Instalar en Linux: una instalación en servidor físico en Debian o Ubuntu. Las pruebas de instalación del proyecto no cubren ninguna otra familia de distribuciones.
  • Ejecutar como servicio: las unidades de systemd que incluye el repositorio y el ejecutor de Procfile para hosts sin systemd.
  • Proxy inverso y TLS: la aplicación nunca termina TLS, así que se da por supuesto un proxy delante de ella. Léalo antes de exponer la instancia.
  • Verificar la instalación: compruebe que la instancia realmente está sirviendo antes de entregársela a nadie, y cree la primera cuenta: el rol de operador del sitio solo se concede desde la CLI.

¿Va a actualizar una instalación existente? Las guías de actualización enumeran las guías disponibles, de la más reciente a la más antigua. Empiece por la primera guía posterior a la versión que ejecuta ahora y avance hacia las más recientes, y lea las notas de la versión de cada versión intermedia.

Recomendado para una instancia que ejecute el modo de autenticación simple:

  • 2 o más núcleos de CPU
  • 2 GB o más de RAM
  • 10 GB o más de espacio en disco

Una implementación en modo full que además ejecute PostgreSQL, el worker en segundo plano y el planificador necesita aproximadamente el doble.

Parte del trabajo administrativo no tiene pantalla en la aplicación y se realiza desde la línea de comandos de la instancia.

Transferir una organización a un nuevo propietario es la principal. Los propietarios de organizaciones no tienen pantalla ni punto de conexión para ello, así que la transferencia le corresponde a usted. Use el comando siguiente. Para la automatización, la API de Colonel expone la misma operación en POST /api/colonel/organizations/:org_id/transfer-ownership; requiere el rol colonel, toma el nombre de la organización como confirmación y se aplica de inmediato sin vista previa.

Ventana de terminal
bin/ots org transfer-ownership ORG NEW_OWNER

ORG es el ID público de la organización (extid, el ID que imprime la CLI) o su ID interno (objid). NEW_OWNER es una dirección de correo electrónico, el extid de un cliente o un ID de cuenta de Rodauth, y debe ser ya un miembro activo: el comando nunca crea un cliente, así que ejecute antes bin/ots memberships add ORG CUSTOMER si no lo es.

Si lo ejecuta sin --yes, planifica la transferencia antes de tocar nada, imprime quién pierde la propiedad, cuántas membresías de propietario se degradarían y a qué rol, y después le pide confirmación. Responder n es la forma de previsualizar una transferencia. Las opciones son --demote-to ROLE (cualquier rol de membresía excepto owner; por defecto admin), --yes (también -y y -f) y --json.

El propietario saliente es degradado, no eliminado. La operación promueve al nuevo propietario antes de degradar al anterior (la protección de propietario único rechaza cualquier otro orden), de modo que durante esas dos escrituras la organización tiene dos membresías de propietario y bin/ots org doctor informa de la comprobación 4 (membership_role_sync) como una advertencia. Si una transferencia se interrumpe dentro de esa ventana, vuelva a ejecutar el comando de transferencia, no org doctor. La transferencia es idempotente y degrada a todos los demás propietarios; org doctor marca esa comprobación como repairable: false y no la corrige.

La parte orientada al usuario final es Propiedad y transferencia, que es lo que sus usuarios habrán leído antes de preguntarle.