[All Platforms] 2.1.0 - Sync Optimizations
This commit is contained in:
@@ -40,6 +40,7 @@ export default defineConfig({
|
||||
items: [
|
||||
{ label: "Overview", slug: "sync/overview" },
|
||||
{ label: "Quick Start", slug: "sync/quick-start" },
|
||||
{ label: "API Reference", slug: "sync/api-reference" },
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@astrojs/node": "^9.5.0",
|
||||
"@astrojs/starlight": "^0.36.0",
|
||||
"@astrojs/starlight": "^0.36.1",
|
||||
"astro": "^5.14.5",
|
||||
"sharp": "^0.34.4"
|
||||
}
|
||||
|
||||
258
docs/pnpm-lock.yaml
generated
258
docs/pnpm-lock.yaml
generated
@@ -12,8 +12,8 @@ importers:
|
||||
specifier: ^9.5.0
|
||||
version: 9.5.0(astro@5.14.5(@types/node@24.7.2)(rollup@4.52.4)(typescript@5.9.3))
|
||||
'@astrojs/starlight':
|
||||
specifier: ^0.36.0
|
||||
version: 0.36.0(astro@5.14.5(@types/node@24.7.2)(rollup@4.52.4)(typescript@5.9.3))
|
||||
specifier: ^0.36.1
|
||||
version: 0.36.1(astro@5.14.5(@types/node@24.7.2)(rollup@4.52.4)(typescript@5.9.3))
|
||||
astro:
|
||||
specifier: ^5.14.5
|
||||
version: 5.14.5(@types/node@24.7.2)(rollup@4.52.4)(typescript@5.9.3)
|
||||
@@ -50,8 +50,8 @@ packages:
|
||||
'@astrojs/sitemap@3.6.0':
|
||||
resolution: {integrity: sha512-4aHkvcOZBWJigRmMIAJwRQXBS+ayoP5z40OklTXYXhUDhwusz+DyDl+nSshY6y9DvkVEavwNcFO8FD81iGhXjg==}
|
||||
|
||||
'@astrojs/starlight@0.36.0':
|
||||
resolution: {integrity: sha512-aVJVBfvFuE2avsMDhmRzn6I5GjDhUwIQFlu3qH9a1C0fNsPYDw2asxHQODAD7EfGiKGvvHCJgHb+9jbJ8lCfNQ==}
|
||||
'@astrojs/starlight@0.36.1':
|
||||
resolution: {integrity: sha512-Fmt8mIsAIZN18Y4YQDI6p521GsYGe4hYxh9jWmz0pHBXnS5J7Na3TSXNya4eyIymCcKkuiKFbs7b/knsdGVYPg==}
|
||||
peerDependencies:
|
||||
astro: ^5.5.0
|
||||
|
||||
@@ -91,158 +91,158 @@ packages:
|
||||
'@emnapi/runtime@1.5.0':
|
||||
resolution: {integrity: sha512-97/BJ3iXHww3djw6hYIfErCZFee7qCtrneuLa20UXFCOTCfBM2cvQHjWJ2EG0s0MtdNwInarqCTz35i4wWXHsQ==}
|
||||
|
||||
'@esbuild/aix-ppc64@0.25.10':
|
||||
resolution: {integrity: sha512-0NFWnA+7l41irNuaSVlLfgNT12caWJVLzp5eAVhZ0z1qpxbockccEt3s+149rE64VUI3Ml2zt8Nv5JVc4QXTsw==}
|
||||
'@esbuild/aix-ppc64@0.25.11':
|
||||
resolution: {integrity: sha512-Xt1dOL13m8u0WE8iplx9Ibbm+hFAO0GsU2P34UNoDGvZYkY8ifSiy6Zuc1lYxfG7svWE2fzqCUmFp5HCn51gJg==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [ppc64]
|
||||
os: [aix]
|
||||
|
||||
'@esbuild/android-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-LSQa7eDahypv/VO6WKohZGPSJDq5OVOo3UoFR1E4t4Gj1W7zEQMUhI+lo81H+DtB+kP+tDgBp+M4oNCwp6kffg==}
|
||||
'@esbuild/android-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-9slpyFBc4FPPz48+f6jyiXOx/Y4v34TUeDDXJpZqAWQn/08lKGeD8aDp9TMn9jDz2CiEuHwfhRmGBvpnd/PWIQ==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [android]
|
||||
|
||||
'@esbuild/android-arm@0.25.10':
|
||||
resolution: {integrity: sha512-dQAxF1dW1C3zpeCDc5KqIYuZ1tgAdRXNoZP7vkBIRtKZPYe2xVr/d3SkirklCHudW1B45tGiUlz2pUWDfbDD4w==}
|
||||
'@esbuild/android-arm@0.25.11':
|
||||
resolution: {integrity: sha512-uoa7dU+Dt3HYsethkJ1k6Z9YdcHjTrSb5NUy66ZfZaSV8hEYGD5ZHbEMXnqLFlbBflLsl89Zke7CAdDJ4JI+Gg==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm]
|
||||
os: [android]
|
||||
|
||||
'@esbuild/android-x64@0.25.10':
|
||||
resolution: {integrity: sha512-MiC9CWdPrfhibcXwr39p9ha1x0lZJ9KaVfvzA0Wxwz9ETX4v5CHfF09bx935nHlhi+MxhA63dKRRQLiVgSUtEg==}
|
||||
'@esbuild/android-x64@0.25.11':
|
||||
resolution: {integrity: sha512-Sgiab4xBjPU1QoPEIqS3Xx+R2lezu0LKIEcYe6pftr56PqPygbB7+szVnzoShbx64MUupqoE0KyRlN7gezbl8g==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [android]
|
||||
|
||||
'@esbuild/darwin-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-JC74bdXcQEpW9KkV326WpZZjLguSZ3DfS8wrrvPMHgQOIEIG/sPXEN/V8IssoJhbefLRcRqw6RQH2NnpdprtMA==}
|
||||
'@esbuild/darwin-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-VekY0PBCukppoQrycFxUqkCojnTQhdec0vevUL/EDOCnXd9LKWqD/bHwMPzigIJXPhC59Vd1WFIL57SKs2mg4w==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [darwin]
|
||||
|
||||
'@esbuild/darwin-x64@0.25.10':
|
||||
resolution: {integrity: sha512-tguWg1olF6DGqzws97pKZ8G2L7Ig1vjDmGTwcTuYHbuU6TTjJe5FXbgs5C1BBzHbJ2bo1m3WkQDbWO2PvamRcg==}
|
||||
'@esbuild/darwin-x64@0.25.11':
|
||||
resolution: {integrity: sha512-+hfp3yfBalNEpTGp9loYgbknjR695HkqtY3d3/JjSRUyPg/xd6q+mQqIb5qdywnDxRZykIHs3axEqU6l1+oWEQ==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [darwin]
|
||||
|
||||
'@esbuild/freebsd-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-3ZioSQSg1HT2N05YxeJWYR+Libe3bREVSdWhEEgExWaDtyFbbXWb49QgPvFH8u03vUPX10JhJPcz7s9t9+boWg==}
|
||||
'@esbuild/freebsd-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-CmKjrnayyTJF2eVuO//uSjl/K3KsMIeYeyN7FyDBjsR3lnSJHaXlVoAK8DZa7lXWChbuOk7NjAc7ygAwrnPBhA==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [freebsd]
|
||||
|
||||
'@esbuild/freebsd-x64@0.25.10':
|
||||
resolution: {integrity: sha512-LLgJfHJk014Aa4anGDbh8bmI5Lk+QidDmGzuC2D+vP7mv/GeSN+H39zOf7pN5N8p059FcOfs2bVlrRr4SK9WxA==}
|
||||
'@esbuild/freebsd-x64@0.25.11':
|
||||
resolution: {integrity: sha512-Dyq+5oscTJvMaYPvW3x3FLpi2+gSZTCE/1ffdwuM6G1ARang/mb3jvjxs0mw6n3Lsw84ocfo9CrNMqc5lTfGOw==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [freebsd]
|
||||
|
||||
'@esbuild/linux-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-5luJWN6YKBsawd5f9i4+c+geYiVEw20FVW5x0v1kEMWNq8UctFjDiMATBxLvmmHA4bf7F6hTRaJgtghFr9iziQ==}
|
||||
'@esbuild/linux-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-Qr8AzcplUhGvdyUF08A1kHU3Vr2O88xxP0Tm8GcdVOUm25XYcMPp2YqSVHbLuXzYQMf9Bh/iKx7YPqECs6ffLA==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-arm@0.25.10':
|
||||
resolution: {integrity: sha512-oR31GtBTFYCqEBALI9r6WxoU/ZofZl962pouZRTEYECvNF/dtXKku8YXcJkhgK/beU+zedXfIzHijSRapJY3vg==}
|
||||
'@esbuild/linux-arm@0.25.11':
|
||||
resolution: {integrity: sha512-TBMv6B4kCfrGJ8cUPo7vd6NECZH/8hPpBHHlYI3qzoYFvWu2AdTvZNuU/7hsbKWqu/COU7NIK12dHAAqBLLXgw==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-ia32@0.25.10':
|
||||
resolution: {integrity: sha512-NrSCx2Kim3EnnWgS4Txn0QGt0Xipoumb6z6sUtl5bOEZIVKhzfyp/Lyw4C1DIYvzeW/5mWYPBFJU3a/8Yr75DQ==}
|
||||
'@esbuild/linux-ia32@0.25.11':
|
||||
resolution: {integrity: sha512-TmnJg8BMGPehs5JKrCLqyWTVAvielc615jbkOirATQvWWB1NMXY77oLMzsUjRLa0+ngecEmDGqt5jiDC6bfvOw==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [ia32]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-loong64@0.25.10':
|
||||
resolution: {integrity: sha512-xoSphrd4AZda8+rUDDfD9J6FUMjrkTz8itpTITM4/xgerAZZcFW7Dv+sun7333IfKxGG8gAq+3NbfEMJfiY+Eg==}
|
||||
'@esbuild/linux-loong64@0.25.11':
|
||||
resolution: {integrity: sha512-DIGXL2+gvDaXlaq8xruNXUJdT5tF+SBbJQKbWy/0J7OhU8gOHOzKmGIlfTTl6nHaCOoipxQbuJi7O++ldrxgMw==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [loong64]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-mips64el@0.25.10':
|
||||
resolution: {integrity: sha512-ab6eiuCwoMmYDyTnyptoKkVS3k8fy/1Uvq7Dj5czXI6DF2GqD2ToInBI0SHOp5/X1BdZ26RKc5+qjQNGRBelRA==}
|
||||
'@esbuild/linux-mips64el@0.25.11':
|
||||
resolution: {integrity: sha512-Osx1nALUJu4pU43o9OyjSCXokFkFbyzjXb6VhGIJZQ5JZi8ylCQ9/LFagolPsHtgw6himDSyb5ETSfmp4rpiKQ==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [mips64el]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-ppc64@0.25.10':
|
||||
resolution: {integrity: sha512-NLinzzOgZQsGpsTkEbdJTCanwA5/wozN9dSgEl12haXJBzMTpssebuXR42bthOF3z7zXFWH1AmvWunUCkBE4EA==}
|
||||
'@esbuild/linux-ppc64@0.25.11':
|
||||
resolution: {integrity: sha512-nbLFgsQQEsBa8XSgSTSlrnBSrpoWh7ioFDUmwo158gIm5NNP+17IYmNWzaIzWmgCxq56vfr34xGkOcZ7jX6CPw==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [ppc64]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-riscv64@0.25.10':
|
||||
resolution: {integrity: sha512-FE557XdZDrtX8NMIeA8LBJX3dC2M8VGXwfrQWU7LB5SLOajfJIxmSdyL/gU1m64Zs9CBKvm4UAuBp5aJ8OgnrA==}
|
||||
'@esbuild/linux-riscv64@0.25.11':
|
||||
resolution: {integrity: sha512-HfyAmqZi9uBAbgKYP1yGuI7tSREXwIb438q0nqvlpxAOs3XnZ8RsisRfmVsgV486NdjD7Mw2UrFSw51lzUk1ww==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [riscv64]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-s390x@0.25.10':
|
||||
resolution: {integrity: sha512-3BBSbgzuB9ajLoVZk0mGu+EHlBwkusRmeNYdqmznmMc9zGASFjSsxgkNsqmXugpPk00gJ0JNKh/97nxmjctdew==}
|
||||
'@esbuild/linux-s390x@0.25.11':
|
||||
resolution: {integrity: sha512-HjLqVgSSYnVXRisyfmzsH6mXqyvj0SA7pG5g+9W7ESgwA70AXYNpfKBqh1KbTxmQVaYxpzA/SvlB9oclGPbApw==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [s390x]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/linux-x64@0.25.10':
|
||||
resolution: {integrity: sha512-QSX81KhFoZGwenVyPoberggdW1nrQZSvfVDAIUXr3WqLRZGZqWk/P4T8p2SP+de2Sr5HPcvjhcJzEiulKgnxtA==}
|
||||
'@esbuild/linux-x64@0.25.11':
|
||||
resolution: {integrity: sha512-HSFAT4+WYjIhrHxKBwGmOOSpphjYkcswF449j6EjsjbinTZbp8PJtjsVK1XFJStdzXdy/jaddAep2FGY+wyFAQ==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [linux]
|
||||
|
||||
'@esbuild/netbsd-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-AKQM3gfYfSW8XRk8DdMCzaLUFB15dTrZfnX8WXQoOUpUBQ+NaAFCP1kPS/ykbbGYz7rxn0WS48/81l9hFl3u4A==}
|
||||
'@esbuild/netbsd-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-hr9Oxj1Fa4r04dNpWr3P8QKVVsjQhqrMSUzZzf+LZcYjZNqhA3IAfPQdEh1FLVUJSiu6sgAwp3OmwBfbFgG2Xg==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [netbsd]
|
||||
|
||||
'@esbuild/netbsd-x64@0.25.10':
|
||||
resolution: {integrity: sha512-7RTytDPGU6fek/hWuN9qQpeGPBZFfB4zZgcz2VK2Z5VpdUxEI8JKYsg3JfO0n/Z1E/6l05n0unDCNc4HnhQGig==}
|
||||
'@esbuild/netbsd-x64@0.25.11':
|
||||
resolution: {integrity: sha512-u7tKA+qbzBydyj0vgpu+5h5AeudxOAGncb8N6C9Kh1N4n7wU1Xw1JDApsRjpShRpXRQlJLb9wY28ELpwdPcZ7A==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [netbsd]
|
||||
|
||||
'@esbuild/openbsd-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-5Se0VM9Wtq797YFn+dLimf2Zx6McttsH2olUBsDml+lm0GOCRVebRWUvDtkY4BWYv/3NgzS8b/UM3jQNh5hYyw==}
|
||||
'@esbuild/openbsd-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-Qq6YHhayieor3DxFOoYM1q0q1uMFYb7cSpLD2qzDSvK1NAvqFi8Xgivv0cFC6J+hWVw2teCYltyy9/m/14ryHg==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [openbsd]
|
||||
|
||||
'@esbuild/openbsd-x64@0.25.10':
|
||||
resolution: {integrity: sha512-XkA4frq1TLj4bEMB+2HnI0+4RnjbuGZfet2gs/LNs5Hc7D89ZQBHQ0gL2ND6Lzu1+QVkjp3x1gIcPKzRNP8bXw==}
|
||||
'@esbuild/openbsd-x64@0.25.11':
|
||||
resolution: {integrity: sha512-CN+7c++kkbrckTOz5hrehxWN7uIhFFlmS/hqziSFVWpAzpWrQoAG4chH+nN3Be+Kzv/uuo7zhX716x3Sn2Jduw==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [openbsd]
|
||||
|
||||
'@esbuild/openharmony-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-AVTSBhTX8Y/Fz6OmIVBip9tJzZEUcY8WLh7I59+upa5/GPhh2/aM6bvOMQySspnCCHvFi79kMtdJS1w0DXAeag==}
|
||||
'@esbuild/openharmony-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-rOREuNIQgaiR+9QuNkbkxubbp8MSO9rONmwP5nKncnWJ9v5jQ4JxFnLu4zDSRPf3x4u+2VN4pM4RdyIzDty/wQ==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [openharmony]
|
||||
|
||||
'@esbuild/sunos-x64@0.25.10':
|
||||
resolution: {integrity: sha512-fswk3XT0Uf2pGJmOpDB7yknqhVkJQkAQOcW/ccVOtfx05LkbWOaRAtn5SaqXypeKQra1QaEa841PgrSL9ubSPQ==}
|
||||
'@esbuild/sunos-x64@0.25.11':
|
||||
resolution: {integrity: sha512-nq2xdYaWxyg9DcIyXkZhcYulC6pQ2FuCgem3LI92IwMgIZ69KHeY8T4Y88pcwoLIjbed8n36CyKoYRDygNSGhA==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [sunos]
|
||||
|
||||
'@esbuild/win32-arm64@0.25.10':
|
||||
resolution: {integrity: sha512-ah+9b59KDTSfpaCg6VdJoOQvKjI33nTaQr4UluQwW7aEwZQsbMCfTmfEO4VyewOxx4RaDT/xCy9ra2GPWmO7Kw==}
|
||||
'@esbuild/win32-arm64@0.25.11':
|
||||
resolution: {integrity: sha512-3XxECOWJq1qMZ3MN8srCJ/QfoLpL+VaxD/WfNRm1O3B4+AZ/BnLVgFbUV3eiRYDMXetciH16dwPbbHqwe1uU0Q==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [arm64]
|
||||
os: [win32]
|
||||
|
||||
'@esbuild/win32-ia32@0.25.10':
|
||||
resolution: {integrity: sha512-QHPDbKkrGO8/cz9LKVnJU22HOi4pxZnZhhA2HYHez5Pz4JeffhDjf85E57Oyco163GnzNCVkZK0b/n4Y0UHcSw==}
|
||||
'@esbuild/win32-ia32@0.25.11':
|
||||
resolution: {integrity: sha512-3ukss6gb9XZ8TlRyJlgLn17ecsK4NSQTmdIXRASVsiS2sQ6zPPZklNJT5GR5tE/MUarymmy8kCEf5xPCNCqVOA==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [ia32]
|
||||
os: [win32]
|
||||
|
||||
'@esbuild/win32-x64@0.25.10':
|
||||
resolution: {integrity: sha512-9KpxSVFCu0iK1owoez6aC/s/EdUQLDN3adTxGCqxMVhrPDj6bt5dbrHDXUuq+Bs2vATFBBrQS5vdQ/Ed2P+nbw==}
|
||||
'@esbuild/win32-x64@0.25.11':
|
||||
resolution: {integrity: sha512-D7Hpz6A2L4hzsRpPaCYkQnGOotdUpDzSGRIv9I+1ITdHROSFUWW95ZPZWQmGka1Fg7W3zFJowyn9WGwMJ0+KPA==}
|
||||
engines: {node: '>=18'}
|
||||
cpu: [x64]
|
||||
os: [win32]
|
||||
@@ -811,8 +811,8 @@ packages:
|
||||
resolution: {integrity: sha512-KxektNH63SrbfUyDiwXqRb1rLwKt33AmMv+5Nhsw1kqZ13SJBRTgZHtGbE+hH3a1mVW1cz+4pqSWVPAtLVXTzQ==}
|
||||
engines: {node: '>=18'}
|
||||
|
||||
devalue@5.3.2:
|
||||
resolution: {integrity: sha512-UDsjUbpQn9kvm68slnrs+mfxwFkIflOhkanmyabZ8zOYk8SMEIbJ3TK+88g70hSIeytu4y18f0z/hYHMTrXIWw==}
|
||||
devalue@5.4.1:
|
||||
resolution: {integrity: sha512-YtoaOfsqjbZQKGIMRYDWKjUmSB4VJ/RElB+bXZawQAQYAo4xu08GKTMVlsZDTF6R2MbAgjcAQRPI5eIyRAT2OQ==}
|
||||
|
||||
devlop@1.1.0:
|
||||
resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==}
|
||||
@@ -861,8 +861,8 @@ packages:
|
||||
esast-util-from-js@2.0.1:
|
||||
resolution: {integrity: sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==}
|
||||
|
||||
esbuild@0.25.10:
|
||||
resolution: {integrity: sha512-9RiGKvCwaqxO2owP61uQ4BgNborAQskMR6QusfWzQqv7AZOg5oGehdY2pRJMTKuwxd1IDBP4rSbI5lHzU7SMsQ==}
|
||||
esbuild@0.25.11:
|
||||
resolution: {integrity: sha512-KohQwyzrKTQmhXDW1PjCv3Tyspn9n5GcY2RTDqeORIdIJY8yKIF7sTSopFmn/wpMPW4rdPXI0UE5LJLuq3bx0Q==}
|
||||
engines: {node: '>=18'}
|
||||
hasBin: true
|
||||
|
||||
@@ -1344,8 +1344,8 @@ packages:
|
||||
resolution: {integrity: sha512-MyIV3ZA/PmyBN/ud8vV9XzwTrNtR4jFrObymZYnZqMmW0zA8Z17vnT0rBgFE/TlohB+YCHqXMgZzb3Csp49vqg==}
|
||||
engines: {node: '>=14.16'}
|
||||
|
||||
package-manager-detector@1.4.0:
|
||||
resolution: {integrity: sha512-rRZ+pR1Usc+ND9M2NkmCvE/LYJS+8ORVV9X0KuNSY/gFsp7RBHJM/ADh9LYq4Vvfq6QkKrW6/weuh8SMEtN5gw==}
|
||||
package-manager-detector@1.4.1:
|
||||
resolution: {integrity: sha512-dSMiVLBEA4XaNJ0PRb4N5cV/SEP4BWrWZKBmfF+OUm2pQTiZ6DDkKeWaltwu3JRhLoy59ayIkJ00cx9K9CaYTg==}
|
||||
|
||||
pagefind@1.4.0:
|
||||
resolution: {integrity: sha512-z2kY1mQlL4J8q5EIsQkLzQjilovKzfNVhX8De6oyE6uHpfFtyBaqUpcl/XzJC/4fjD8vBDyh1zolimIcVrCn9g==}
|
||||
@@ -1753,8 +1753,8 @@ packages:
|
||||
vfile@6.0.3:
|
||||
resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==}
|
||||
|
||||
vite@6.3.7:
|
||||
resolution: {integrity: sha512-mQYaKepA0NGMBsz8Xktt3tJUG5ELE2iT7IJ+ssXI6nxVdE2sFc/d/6w/JByqMLvWg8hNKHpPgzjgOkrhpKFnrA==}
|
||||
vite@6.4.0:
|
||||
resolution: {integrity: sha512-oLnWs9Hak/LOlKjeSpOwD6JMks8BeICEdYMJBf6P4Lac/pO9tKiv/XhXnAM7nNfSkZahjlCZu9sS50zL8fSnsw==}
|
||||
engines: {node: ^18.0.0 || ^20.0.0 || >=22.0.0}
|
||||
hasBin: true
|
||||
peerDependencies:
|
||||
@@ -1922,7 +1922,7 @@ snapshots:
|
||||
stream-replace-string: 2.0.0
|
||||
zod: 3.25.76
|
||||
|
||||
'@astrojs/starlight@0.36.0(astro@5.14.5(@types/node@24.7.2)(rollup@4.52.4)(typescript@5.9.3))':
|
||||
'@astrojs/starlight@0.36.1(astro@5.14.5(@types/node@24.7.2)(rollup@4.52.4)(typescript@5.9.3))':
|
||||
dependencies:
|
||||
'@astrojs/markdown-remark': 6.3.8
|
||||
'@astrojs/mdx': 4.3.7(astro@5.14.5(@types/node@24.7.2)(rollup@4.52.4)(typescript@5.9.3))
|
||||
@@ -1993,82 +1993,82 @@ snapshots:
|
||||
tslib: 2.8.1
|
||||
optional: true
|
||||
|
||||
'@esbuild/aix-ppc64@0.25.10':
|
||||
'@esbuild/aix-ppc64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/android-arm64@0.25.10':
|
||||
'@esbuild/android-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/android-arm@0.25.10':
|
||||
'@esbuild/android-arm@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/android-x64@0.25.10':
|
||||
'@esbuild/android-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/darwin-arm64@0.25.10':
|
||||
'@esbuild/darwin-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/darwin-x64@0.25.10':
|
||||
'@esbuild/darwin-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/freebsd-arm64@0.25.10':
|
||||
'@esbuild/freebsd-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/freebsd-x64@0.25.10':
|
||||
'@esbuild/freebsd-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-arm64@0.25.10':
|
||||
'@esbuild/linux-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-arm@0.25.10':
|
||||
'@esbuild/linux-arm@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-ia32@0.25.10':
|
||||
'@esbuild/linux-ia32@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-loong64@0.25.10':
|
||||
'@esbuild/linux-loong64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-mips64el@0.25.10':
|
||||
'@esbuild/linux-mips64el@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-ppc64@0.25.10':
|
||||
'@esbuild/linux-ppc64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-riscv64@0.25.10':
|
||||
'@esbuild/linux-riscv64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-s390x@0.25.10':
|
||||
'@esbuild/linux-s390x@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/linux-x64@0.25.10':
|
||||
'@esbuild/linux-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/netbsd-arm64@0.25.10':
|
||||
'@esbuild/netbsd-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/netbsd-x64@0.25.10':
|
||||
'@esbuild/netbsd-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/openbsd-arm64@0.25.10':
|
||||
'@esbuild/openbsd-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/openbsd-x64@0.25.10':
|
||||
'@esbuild/openbsd-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/openharmony-arm64@0.25.10':
|
||||
'@esbuild/openharmony-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/sunos-x64@0.25.10':
|
||||
'@esbuild/sunos-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/win32-arm64@0.25.10':
|
||||
'@esbuild/win32-arm64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/win32-ia32@0.25.10':
|
||||
'@esbuild/win32-ia32@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@esbuild/win32-x64@0.25.10':
|
||||
'@esbuild/win32-x64@0.25.11':
|
||||
optional: true
|
||||
|
||||
'@expressive-code/core@0.41.3':
|
||||
@@ -2453,12 +2453,12 @@ snapshots:
|
||||
cssesc: 3.0.0
|
||||
debug: 4.4.3
|
||||
deterministic-object-hash: 2.0.2
|
||||
devalue: 5.3.2
|
||||
devalue: 5.4.1
|
||||
diff: 5.2.0
|
||||
dlv: 1.1.3
|
||||
dset: 3.1.4
|
||||
es-module-lexer: 1.7.0
|
||||
esbuild: 0.25.10
|
||||
esbuild: 0.25.11
|
||||
estree-walker: 3.0.3
|
||||
flattie: 1.1.1
|
||||
fontace: 0.3.1
|
||||
@@ -2474,7 +2474,7 @@ snapshots:
|
||||
neotraverse: 0.6.18
|
||||
p-limit: 6.2.0
|
||||
p-queue: 8.1.1
|
||||
package-manager-detector: 1.4.0
|
||||
package-manager-detector: 1.4.1
|
||||
picomatch: 4.0.3
|
||||
prompts: 2.4.2
|
||||
rehype: 13.0.2
|
||||
@@ -2489,8 +2489,8 @@ snapshots:
|
||||
unist-util-visit: 5.0.0
|
||||
unstorage: 1.17.1
|
||||
vfile: 6.0.3
|
||||
vite: 6.3.7(@types/node@24.7.2)
|
||||
vitefu: 1.1.1(vite@6.3.7(@types/node@24.7.2))
|
||||
vite: 6.4.0(@types/node@24.7.2)
|
||||
vitefu: 1.1.1(vite@6.4.0(@types/node@24.7.2))
|
||||
xxhash-wasm: 1.1.0
|
||||
yargs-parser: 21.1.1
|
||||
yocto-spinner: 0.2.3
|
||||
@@ -2638,7 +2638,7 @@ snapshots:
|
||||
dependencies:
|
||||
base-64: 1.0.0
|
||||
|
||||
devalue@5.3.2: {}
|
||||
devalue@5.4.1: {}
|
||||
|
||||
devlop@1.1.0:
|
||||
dependencies:
|
||||
@@ -2680,34 +2680,34 @@ snapshots:
|
||||
esast-util-from-estree: 2.0.0
|
||||
vfile-message: 4.0.3
|
||||
|
||||
esbuild@0.25.10:
|
||||
esbuild@0.25.11:
|
||||
optionalDependencies:
|
||||
'@esbuild/aix-ppc64': 0.25.10
|
||||
'@esbuild/android-arm': 0.25.10
|
||||
'@esbuild/android-arm64': 0.25.10
|
||||
'@esbuild/android-x64': 0.25.10
|
||||
'@esbuild/darwin-arm64': 0.25.10
|
||||
'@esbuild/darwin-x64': 0.25.10
|
||||
'@esbuild/freebsd-arm64': 0.25.10
|
||||
'@esbuild/freebsd-x64': 0.25.10
|
||||
'@esbuild/linux-arm': 0.25.10
|
||||
'@esbuild/linux-arm64': 0.25.10
|
||||
'@esbuild/linux-ia32': 0.25.10
|
||||
'@esbuild/linux-loong64': 0.25.10
|
||||
'@esbuild/linux-mips64el': 0.25.10
|
||||
'@esbuild/linux-ppc64': 0.25.10
|
||||
'@esbuild/linux-riscv64': 0.25.10
|
||||
'@esbuild/linux-s390x': 0.25.10
|
||||
'@esbuild/linux-x64': 0.25.10
|
||||
'@esbuild/netbsd-arm64': 0.25.10
|
||||
'@esbuild/netbsd-x64': 0.25.10
|
||||
'@esbuild/openbsd-arm64': 0.25.10
|
||||
'@esbuild/openbsd-x64': 0.25.10
|
||||
'@esbuild/openharmony-arm64': 0.25.10
|
||||
'@esbuild/sunos-x64': 0.25.10
|
||||
'@esbuild/win32-arm64': 0.25.10
|
||||
'@esbuild/win32-ia32': 0.25.10
|
||||
'@esbuild/win32-x64': 0.25.10
|
||||
'@esbuild/aix-ppc64': 0.25.11
|
||||
'@esbuild/android-arm': 0.25.11
|
||||
'@esbuild/android-arm64': 0.25.11
|
||||
'@esbuild/android-x64': 0.25.11
|
||||
'@esbuild/darwin-arm64': 0.25.11
|
||||
'@esbuild/darwin-x64': 0.25.11
|
||||
'@esbuild/freebsd-arm64': 0.25.11
|
||||
'@esbuild/freebsd-x64': 0.25.11
|
||||
'@esbuild/linux-arm': 0.25.11
|
||||
'@esbuild/linux-arm64': 0.25.11
|
||||
'@esbuild/linux-ia32': 0.25.11
|
||||
'@esbuild/linux-loong64': 0.25.11
|
||||
'@esbuild/linux-mips64el': 0.25.11
|
||||
'@esbuild/linux-ppc64': 0.25.11
|
||||
'@esbuild/linux-riscv64': 0.25.11
|
||||
'@esbuild/linux-s390x': 0.25.11
|
||||
'@esbuild/linux-x64': 0.25.11
|
||||
'@esbuild/netbsd-arm64': 0.25.11
|
||||
'@esbuild/netbsd-x64': 0.25.11
|
||||
'@esbuild/openbsd-arm64': 0.25.11
|
||||
'@esbuild/openbsd-x64': 0.25.11
|
||||
'@esbuild/openharmony-arm64': 0.25.11
|
||||
'@esbuild/sunos-x64': 0.25.11
|
||||
'@esbuild/win32-arm64': 0.25.11
|
||||
'@esbuild/win32-ia32': 0.25.11
|
||||
'@esbuild/win32-x64': 0.25.11
|
||||
|
||||
escape-html@1.0.3: {}
|
||||
|
||||
@@ -3595,7 +3595,7 @@ snapshots:
|
||||
|
||||
p-timeout@6.1.4: {}
|
||||
|
||||
package-manager-detector@1.4.0: {}
|
||||
package-manager-detector@1.4.1: {}
|
||||
|
||||
pagefind@1.4.0:
|
||||
optionalDependencies:
|
||||
@@ -4116,9 +4116,9 @@ snapshots:
|
||||
'@types/unist': 3.0.3
|
||||
vfile-message: 4.0.3
|
||||
|
||||
vite@6.3.7(@types/node@24.7.2):
|
||||
vite@6.4.0(@types/node@24.7.2):
|
||||
dependencies:
|
||||
esbuild: 0.25.10
|
||||
esbuild: 0.25.11
|
||||
fdir: 6.5.0(picomatch@4.0.3)
|
||||
picomatch: 4.0.3
|
||||
postcss: 8.5.6
|
||||
@@ -4128,9 +4128,9 @@ snapshots:
|
||||
'@types/node': 24.7.2
|
||||
fsevents: 2.3.3
|
||||
|
||||
vitefu@1.1.1(vite@6.3.7(@types/node@24.7.2)):
|
||||
vitefu@1.1.1(vite@6.4.0(@types/node@24.7.2)):
|
||||
optionalDependencies:
|
||||
vite: 6.3.7(@types/node@24.7.2)
|
||||
vite: 6.4.0(@types/node@24.7.2)
|
||||
|
||||
web-namespaces@2.0.1: {}
|
||||
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
onlyBuiltDependencies:
|
||||
- esbuild
|
||||
- sharp
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
title: Sync Server API
|
||||
description: API endpoints for the Ascently sync server
|
||||
---
|
||||
|
||||
The sync server provides a minimal REST API for data synchronization.
|
||||
|
||||
## Authentication
|
||||
|
||||
All endpoints require an `Authorization: Bearer <your-auth-token>` header.
|
||||
|
||||
## Endpoints
|
||||
|
||||
### Data Sync
|
||||
|
||||
**GET /sync**
|
||||
- Download `ascently.json` file
|
||||
- Returns: JSON data file or 404 if no data exists
|
||||
|
||||
**POST /sync**
|
||||
- Upload `ascently.json` file
|
||||
- Body: JSON data
|
||||
- Returns: Success confirmation
|
||||
|
||||
### Images
|
||||
|
||||
**GET /images/{imageName}**
|
||||
- Download an image file
|
||||
- Returns: Image file or 404 if not found
|
||||
|
||||
**POST /images/{imageName}**
|
||||
- Upload an image file
|
||||
- Body: Image data
|
||||
- Returns: Success confirmation
|
||||
|
||||
## Example Usage
|
||||
|
||||
```bash
|
||||
# Download data
|
||||
curl -H "Authorization: Bearer your-token" \
|
||||
http://localhost:8080/sync
|
||||
|
||||
# Upload data
|
||||
curl -X POST \
|
||||
-H "Authorization: Bearer your-token" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d @ascently.json \
|
||||
http://localhost:8080/sync
|
||||
```
|
||||
|
||||
See `main.go` in the sync directory for implementation details.
|
||||
152
docs/src/content/docs/sync/api-reference.md
Normal file
152
docs/src/content/docs/sync/api-reference.md
Normal file
@@ -0,0 +1,152 @@
|
||||
---
|
||||
title: API Reference
|
||||
description: Complete API documentation for the Ascently sync server
|
||||
---
|
||||
|
||||
Complete reference for all sync server endpoints.
|
||||
|
||||
## Authentication
|
||||
|
||||
All endpoints require a bearer token in the `Authorization` header:
|
||||
|
||||
```
|
||||
Authorization: Bearer your-auth-token
|
||||
```
|
||||
|
||||
Unauthorized requests return `401 Unauthorized`.
|
||||
|
||||
## Endpoints
|
||||
|
||||
### Health Check
|
||||
|
||||
**`GET /health`**
|
||||
|
||||
Check if the server is running.
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"version": "2.0.0"
|
||||
}
|
||||
```
|
||||
|
||||
### Full Sync - Download
|
||||
|
||||
**`GET /sync`**
|
||||
|
||||
Download the entire dataset from the server.
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
{
|
||||
"exportedAt": "2024-01-15T10:30:00.000Z",
|
||||
"version": "2.0",
|
||||
"formatVersion": "2.0",
|
||||
"gyms": [...],
|
||||
"problems": [...],
|
||||
"sessions": [...],
|
||||
"attempts": [...],
|
||||
"deletedItems": [...]
|
||||
}
|
||||
```
|
||||
|
||||
Returns `200 OK` with the backup data, or `404 Not Found` if no data exists.
|
||||
|
||||
### Full Sync - Upload
|
||||
|
||||
**`POST /sync`**
|
||||
|
||||
Upload your entire dataset to the server. This overwrites all server data.
|
||||
|
||||
**Request Body:**
|
||||
```json
|
||||
{
|
||||
"exportedAt": "2024-01-15T10:30:00.000Z",
|
||||
"version": "2.0",
|
||||
"formatVersion": "2.0",
|
||||
"gyms": [...],
|
||||
"problems": [...],
|
||||
"sessions": [...],
|
||||
"attempts": [...],
|
||||
"deletedItems": [...]
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
200 OK
|
||||
```
|
||||
|
||||
### Delta Sync
|
||||
|
||||
**`POST /sync/delta`**
|
||||
|
||||
Sync only changed data since your last sync. Much faster than full sync.
|
||||
|
||||
**Request Body:**
|
||||
```json
|
||||
{
|
||||
"lastSyncTime": "2024-01-15T10:00:00.000Z",
|
||||
"gyms": [...],
|
||||
"problems": [...],
|
||||
"sessions": [...],
|
||||
"attempts": [...],
|
||||
"deletedItems": [...]
|
||||
}
|
||||
```
|
||||
|
||||
Include only items modified after `lastSyncTime`. The server merges your changes with its data using last-write-wins based on `updatedAt` timestamps.
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
{
|
||||
"serverTime": "2024-01-15T10:30:00.000Z",
|
||||
"gyms": [...],
|
||||
"problems": [...],
|
||||
"sessions": [...],
|
||||
"attempts": [...],
|
||||
"deletedItems": [...]
|
||||
}
|
||||
```
|
||||
|
||||
Returns only server items modified after your `lastSyncTime`. Save `serverTime` as your new `lastSyncTime` for the next delta sync.
|
||||
|
||||
### Image Upload
|
||||
|
||||
**`POST /images/upload?filename={name}`**
|
||||
|
||||
Upload an image file.
|
||||
|
||||
**Query Parameters:**
|
||||
- `filename`: Image filename (e.g., `problem_abc123_0.jpg`)
|
||||
|
||||
**Request Body:**
|
||||
Binary image data (JPEG, PNG, GIF, or WebP)
|
||||
|
||||
**Response:**
|
||||
```
|
||||
200 OK
|
||||
```
|
||||
|
||||
### Image Download
|
||||
|
||||
**`GET /images/download?filename={name}`**
|
||||
|
||||
Download an image file.
|
||||
|
||||
**Query Parameters:**
|
||||
- `filename`: Image filename
|
||||
|
||||
**Response:**
|
||||
Binary image data with appropriate `Content-Type` header.
|
||||
|
||||
Returns `404 Not Found` if the image doesn't exist.
|
||||
|
||||
## Notes
|
||||
|
||||
- All timestamps are ISO 8601 format with milliseconds
|
||||
- Active sessions (status `active`) are excluded from sync
|
||||
- Images are stored separately and referenced by filename
|
||||
- The server stores everything in a single `ascently.json` file
|
||||
- No versioning or history - last write wins
|
||||
@@ -3,28 +3,49 @@ title: Self-Hosted Sync Overview
|
||||
description: Learn about Ascently's optional sync server for cross-device data synchronization
|
||||
---
|
||||
|
||||
You can run your own sync server to keep your data in sync across devices. The server is lightweight and easy to set up using Docker.
|
||||
Run your own sync server to keep your data in sync across devices. The server is lightweight and easy to set up with Docker.
|
||||
|
||||
## How It Works
|
||||
|
||||
This server uses a single `ascently.json` file for your data and a directory for images. The last client to upload wins, overwriting the old data. Authentication is just a static bearer token.
|
||||
The server stores your data in a single `ascently.json` file and images in a directory. It's simple: last write wins. Authentication is a static bearer token you set.
|
||||
|
||||
## API
|
||||
## Features
|
||||
|
||||
All endpoints require an `Authorization: Bearer <your-auth-token>` header.
|
||||
- **Delta sync**: Only syncs changed data
|
||||
- **Image sync**: Automatically syncs problem images
|
||||
- **Conflict resolution**: Last-write-wins based on timestamps
|
||||
- **Cross-platform**: Works with iOS and Android clients
|
||||
- **Privacy**: Your data, your server, no analytics
|
||||
|
||||
- `GET /sync`: Download `ascently.json`
|
||||
- `POST /sync`: Upload `ascently.json`
|
||||
- `GET /images/{imageName}`: Download an image
|
||||
- `POST /images/{imageName}`: Upload an image
|
||||
## API Endpoints
|
||||
|
||||
- `GET /health` - Health check
|
||||
- `GET /sync` - Download full dataset
|
||||
- `POST /sync` - Upload full dataset
|
||||
- `POST /sync/delta` - Sync only changes (recommended)
|
||||
- `POST /images/upload?filename={name}` - Upload image
|
||||
- `GET /images/download?filename={name}` - Download image
|
||||
|
||||
All endpoints require `Authorization: Bearer <your-token>` header.
|
||||
|
||||
See the [API Reference](/sync/api-reference/) for complete documentation.
|
||||
|
||||
## Getting Started
|
||||
|
||||
The easiest way to get started is with the [Quick Start guide](/sync/quick-start/) using Docker Compose.
|
||||
Check out the [Quick Start guide](/sync/quick-start/) to get your server running with Docker Compose.
|
||||
|
||||
You'll need:
|
||||
- Docker and Docker Compose
|
||||
- A secure authentication token
|
||||
- A place to store your data
|
||||
|
||||
The server will be available at `http://localhost:8080` by default. Configure your clients with your server URL and auth token to start syncing.
|
||||
The server will be available at `http://localhost:8080` by default. Configure your Ascently apps with your server URL and auth token to start syncing.
|
||||
|
||||
## How Sync Works
|
||||
|
||||
1. **First sync**: Client uploads or downloads full dataset
|
||||
2. **Subsequent syncs**: Client uses delta sync to only transfer changed data
|
||||
3. **Conflicts**: Resolved automatically using timestamps (newer wins)
|
||||
4. **Images**: Synced automatically with problem data
|
||||
|
||||
Active sessions are excluded from sync until completed.
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Quick Start
|
||||
description: Get your Ascently sync server running with Docker Compose
|
||||
---
|
||||
|
||||
Get your Ascently sync server up and running using Docker Compose.
|
||||
Get your sync server running in minutes with Docker Compose.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -12,50 +12,158 @@ Get your Ascently sync server up and running using Docker Compose.
|
||||
|
||||
## Setup
|
||||
|
||||
1. Create a `.env` file with your configuration:
|
||||
1. Create a `docker-compose.yml` file:
|
||||
|
||||
```env
|
||||
IMAGE=git.atri.dad/atridad/ascently-sync:latest
|
||||
APP_PORT=8080
|
||||
AUTH_TOKEN=your-super-secret-token
|
||||
DATA_FILE=/data/ascently.json
|
||||
IMAGES_DIR=/data/images
|
||||
ROOT_DIR=./ascently-data
|
||||
```yaml
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
ascently-sync:
|
||||
image: git.atri.dad/atridad/ascently-sync:latest
|
||||
ports:
|
||||
- "8080:8080"
|
||||
environment:
|
||||
- AUTH_TOKEN=${AUTH_TOKEN}
|
||||
- DATA_FILE=/data/ascently.json
|
||||
- IMAGES_DIR=/data/images
|
||||
volumes:
|
||||
- ./ascently-data:/data
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
Set `AUTH_TOKEN` to a long, random string. `ROOT_DIR` is where the server will store its data on your machine.
|
||||
2. Create a `.env` file in the same directory:
|
||||
|
||||
2. Use the provided `docker-compose.yml` in the `sync/` directory:
|
||||
```env
|
||||
AUTH_TOKEN=your-super-secret-token-here
|
||||
```
|
||||
|
||||
Replace `your-super-secret-token-here` with a secure random token (see below).
|
||||
|
||||
3. Start the server:
|
||||
|
||||
```bash
|
||||
cd sync/
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
The server will be available at `http://localhost:8080`.
|
||||
|
||||
## Configure Your Clients
|
||||
## Generate a Secure Token
|
||||
|
||||
Configure your Ascently apps with:
|
||||
- **Server URL**: `http://your-server-ip:8080` (or your domain)
|
||||
- **Auth Token**: The token from your `.env` file
|
||||
|
||||
Enable sync and perform your first sync to start synchronizing data across devices.
|
||||
|
||||
## Generating a Secure Token
|
||||
|
||||
Generate a secure authentication token:
|
||||
Use this command to generate a secure authentication token:
|
||||
|
||||
```bash
|
||||
# On Linux/macOS
|
||||
openssl rand -base64 32
|
||||
```
|
||||
|
||||
Keep this token secure and don't share it publicly.
|
||||
Copy the output and paste it into your `.env` file as the `AUTH_TOKEN`.
|
||||
|
||||
## Accessing Remotely
|
||||
Keep this token secret and don't commit it to version control.
|
||||
|
||||
For remote access, you'll need to:
|
||||
- Set up port forwarding on your router (port 8080)
|
||||
- Use your public IP address or set up a domain name
|
||||
- Consider using HTTPS with a reverse proxy for security
|
||||
## Configure Your Apps
|
||||
|
||||
Open Ascently on your iOS or Android device:
|
||||
|
||||
1. Go to **Settings**
|
||||
2. Scroll to **Sync Configuration**
|
||||
3. Enter your **Server URL**: `http://your-server-ip:8080`
|
||||
4. Enter your **Auth Token**: (the token from your `.env` file)
|
||||
5. Tap **Test Connection** to verify it works
|
||||
6. Enable **Auto Sync**
|
||||
7. Tap **Sync Now** to perform your first sync
|
||||
|
||||
Repeat this on all your devices to keep them in sync.
|
||||
|
||||
## Verify It's Working
|
||||
|
||||
Check the server logs:
|
||||
|
||||
```bash
|
||||
docker-compose logs -f ascently-sync
|
||||
```
|
||||
|
||||
You should see logs like:
|
||||
|
||||
```
|
||||
Delta sync from 192.168.1.100: lastSyncTime=2024-01-15T10:00:00.000Z, gyms=1, problems=5, sessions=2, attempts=10, deletedItems=0
|
||||
```
|
||||
|
||||
## Remote Access
|
||||
|
||||
To access your server remotely:
|
||||
|
||||
### Option 1: Port Forwarding
|
||||
|
||||
1. Forward port 8080 on your router to your server
|
||||
2. Find your public IP address
|
||||
3. Use `http://your-public-ip:8080` as the server URL
|
||||
|
||||
### Option 2: Domain Name (Recommended)
|
||||
|
||||
1. Get a domain name and point it to your server
|
||||
2. Set up a reverse proxy (nginx, Caddy, Traefik)
|
||||
3. Enable HTTPS with Let's Encrypt
|
||||
4. Use `https://sync.yourdomain.com` as the server URL
|
||||
|
||||
Example nginx config with HTTPS:
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 443 ssl http2;
|
||||
server_name sync.yourdomain.com;
|
||||
|
||||
ssl_certificate /etc/letsencrypt/live/sync.yourdomain.com/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/sync.yourdomain.com/privkey.pem;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:8080;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Updating
|
||||
|
||||
Pull the latest image and restart:
|
||||
|
||||
```bash
|
||||
docker-compose pull
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Your data is stored in `./ascently-data` and persists across updates.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Connection Failed
|
||||
|
||||
- Check the server is running: `docker-compose ps`
|
||||
- Verify the auth token matches on server and client
|
||||
- Check firewall settings and port forwarding
|
||||
- Test locally first with `http://localhost:8080`
|
||||
|
||||
### Sync Errors
|
||||
|
||||
- Check server logs: `docker-compose logs ascently-sync`
|
||||
- Verify your device has internet connection
|
||||
- Try disabling and re-enabling sync
|
||||
- Perform a manual sync from Settings
|
||||
|
||||
### Data Location
|
||||
|
||||
All data is stored in `./ascently-data/`:
|
||||
|
||||
```
|
||||
ascently-data/
|
||||
├── ascently.json # Your climb data
|
||||
└── images/ # Problem images
|
||||
```
|
||||
|
||||
You can back this up or move it to another server.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Read the [API Reference](/sync/api-reference/) for advanced usage
|
||||
- Set up automated backups of your `ascently-data` directory
|
||||
- Configure HTTPS for secure remote access
|
||||
- Monitor server logs for sync activity
|
||||
Reference in New Issue
Block a user