MCPcopy
hub / github.com/vrtmrz/obsidian-livesync

github.com/vrtmrz/obsidian-livesync @0.25.79 sqlite

repository ↗ · DeepWiki ↗ · release 0.25.79 ↗
2,985 symbols 7,994 edges 606 files 202 documented · 7%
README

Self-hosted LiveSync

Documentación en inglés - Documentación en japonés - Documentación en chino.

Self-hosted LiveSync es un plugin de sincronización implementado por la comunidad, disponible en todas las plataformas compatibles con Obsidian y utiliza CouchDB o Almacenamiento de Objetos (por ejemplo, MinIO, S3, R2, etc.) como servidor.

Demostración de Obsidian Live Sync

Nota: Este plugin no puede sincronizarse con el "Obsidian Sync" oficial.

Características

Este plugin puede ser útil para investigadores, ingenieros y desarrolladores que necesitan mantener sus notas totalmente autoalojadas por razones de seguridad, o para aquellos que deseen tener la tranquilidad de saber que sus notas son totalmente privadas.

[!IMPORTANTE] - Antes de instalar o actualizar este plugin, realice un respaldo de su bóveda. - No active este plugin junto con otra solución de sincronización al mismo tiempo (incluyendo iCloud y Obsidian Sync). - Este es un plugin de sincronización, no una solución de respaldo. No confíe en él para realizar respaldos.

Cómo usar

Configuración en 3 minutos - CouchDB en fly.io

Recomendado para principiantes

Configuración de LiveSync en Fly.io 2024 usando Google Colab

  1. Configurar CouchDB en fly.io
  2. Configurar el plugin en Configuración rápida

Configuración manual

  1. Configurar el servidor
  2. Configurar CouchDB en fly.io
  3. Configurar su CouchDB
  4. Configura el plugin en Configuración rápida

[!CONSEJO] Actualmente, fly.io ya no es gratuito. Afortunadamente, aunque hay algunos problemas, aún podemos usar IBM Cloudant. Aquí está como Configurar IBM Cloudant. ¡Se actualizará pronto!

Información en la barra de estado

El estado de sincronización se muestra en la barra de estado con los siguientes iconos.

  • Indicador de actividad
    • 📲 Solicitud de red
  • Estado
    • ⏹️ Detenido
    • 💤 LiveSync activado. Esperando cambios
    • ⚡️ Sincronización en progreso
    • ⚠ Ocurrió un error
  • Indicador estadístico
    • ↑ Chunks y metadatos subidos
    • ↓ Chunks y metadatos descargados
  • Indicador de progreso
    • 📥 Elementos transferidos sin procesar
    • 📄 Operación de base de datos en curso
    • 💾 Procesos de escritura en almacenamiento en curso
    • ⏳ Procesos de lectura en almacenamiento en curso
    • 🛫 Procesos de lectura en almacenamiento pendientes
    • 📬 Procesos de lectura en almacenamiento por lotes
    • ⚙️ Procesos de almacenamiento de archivos ocultos en curso o pendientes
    • 🧩 Chunks en espera
    • 🔌 Elementos de personalización en curso (Configuración, fragmentos y plugins)

Para prevenir la corrupción de archivos y bases de datos, antes de detener Obsidian espere hasta que todos los indicadores de progreso hayan desaparecido (el plugin también intentará reanudar, sin embargo). Especialmente en caso de que haya eliminado o renombrado archivos.

Consejos y Solución de Problemas

Si tienes problemas para hacer funcionar el plugin, consulta: Consejos y solución de problemas.

Agradecimientos

El proyecto ha progresado y mantenido en armonía gracias a: - Muchos Colaboradores - Muchos Patrocinadores de GitHub - Programas comunitarios de JetBrains / Soporte para Proyectos de Código Abierto JetBrains logo.

Que aquellos que han contribuido sean honrados y recordados por su amabilidad y generosidad.

Licencia

Licenciado bajo la Licencia MIT.

Extension points exported contracts — how you extend this code

IStorageEventPersistenceAdapter (Interface)
(no doc) [7 implementers]
_types/src/lib/src/managers/adapters/IStorageEventPersistenceAdapter.d.ts
IMinimumLiveSyncCommands (Interface)
(no doc) [5 implementers]
src/LiveSyncBaseCore.ts
Vault (Interface)
(no doc) [4 implementers]
src/serviceModules/FileSystemAdapters/ObsidianFileSystemAdapter.ts
DataAdapter (Interface)
(no doc) [3 implementers]
src/modules/services/ObsidianVaultService.ts
FlagFileHandler (Interface)
* Flag file handler interface, similar to target filter pattern.
src/serviceFeatures/redFlag.ts
StyleGroup (Interface)
(no doc)
utilsdeno/refactor-styles.ts
BrowserCommands (Interface)
(no doc)
test/lib/commands.ts
ServiceModules (Interface)
(no doc)
src/types.ts

Core symbols most depended-on inside this repo

log
called by 350
src/modules/core/ReplicateResultProcessor.ts
_log
called by 295
_types/src/lib/src/replication/trystero/P2PReplicatorBase.d.ts
join
called by 244
src/apps/cli/testdeno/helpers/temp.ts
resolve
called by 227
_types/src/lib/src/services/base/IService.d.ts
get
called by 223
_types/src/lib/src/interfaces/KeyValueDatabase.d.ts
n
called by 133
pouchdb-browser.js
set
called by 117
_types/src/lib/src/interfaces/KeyValueDatabase.d.ts
keys
called by 92
_types/src/lib/src/interfaces/KeyValueDatabase.d.ts

Shape

Method 1,300
Function 740
Class 725
Interface 211
Enum 9

Languages

TypeScript100%

Modules by API surface

test/harness/obsidian-mock.ts195 symbols
_types/src/lib/src/services/base/IService.d.ts176 symbols
pouchdb-browser.js173 symbols
src/features/HiddenFileSync/CmdHiddenFileSync.ts88 symbols
src/features/ConfigSync/CmdConfigSync.ts72 symbols
src/modules/features/SettingDialogue/ObsidianLiveSyncSettingTab.ts44 symbols
_types/src/lib/src/common/models/setting.type.d.ts43 symbols
_types/src/lib/src/interfaces/StorageAccess.d.ts38 symbols
_types/src/lib/src/services/lib/HandlerUtils.d.ts37 symbols
src/common/utils.ts34 symbols
src/apps/cli/testdeno/helpers/docker.ts33 symbols
src/apps/cli/services/NodeKeyValueDBService.ts31 symbols

Dependencies from manifests, versioned

@aws-sdk/client-s33.808.0 · 1×
@dword-design/eslint-plugin-import-alias8.1.8 · 1×
@emnapi/core1.11.1 · 1×
@emnapi/runtime1.11.1 · 1×
@eslint/js9.39.3 · 1×
@playwright/test1.58.2 · 1×
@smithy/fetch-http-handler5.3.10 · 1×
@smithy/md5-js4.2.9 · 1×
@smithy/middleware-apply-body-checksum4.3.9 · 1×
@smithy/protocol-http5.3.9 · 1×
@smithy/querystring-builder4.2.9 · 1×
@smithy/types4.14.3 · 1×

For agents

$ claude mcp add obsidian-livesync \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact