https://github.com/fmstrat/sxncd
An Open Source Synchronization Server for use with any apps that that support a standard file import/export.
https://github.com/fmstrat/sxncd
Last synced: 12 months ago
JSON representation
An Open Source Synchronization Server for use with any apps that that support a standard file import/export.
- Host: GitHub
- URL: https://github.com/fmstrat/sxncd
- Owner: Fmstrat
- License: gpl-3.0
- Created: 2025-02-25T22:32:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-26T22:50:52.000Z (over 1 year ago)
- Last Synced: 2025-02-26T23:28:43.419Z (over 1 year ago)
- Language: JavaScript
- Size: 234 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SxncD
An Open Source Synchronization Server for use with any apps that that support a standard file import/export.
## Supported apps
Obtainium
(In development)
Thunder for Lemmy
(In development)
## Supported authentication providers
OpenID Connect
GitHub
Google
## Running SxncD
SxncD was built to run in Docker using the `nowsci/sxncd` docker image. A sample [Docker Compose](./docker-compose.yml) file is provided.
## Integrating SxncD with your app
SxncD is built in a modular way to support easy integration into existing mobile and desktop applications.
### Adding apps to the SxncD server
Adding your app to SxncD is easy, simply copy an existing configuration from the [app modules](./src/modules/app) folder and edit for your application before submitting a PR.
### Syncing app data with SxncD
If your application is developed in Flutter, we offer a library to make things easy:
- [Flutter library](https://github.com/Fmstrat/SxncD-flutter)
If your application is built in another language, or for desktop, the API endpoint can be used in any standard HTTP client. The data object for a `POST` exists as:
```
{
"deviceName": "My Device", // String | The name of the device
"savedTs": "1900-01-01T00:00:00.000Z", // String | The timestamp of when the settings were last saved on the device
"settings": "..." // String | The actual settings
}
```
For example:
```bash
curl -X POST http:///api/v1/sync/update \
-H "Authorization: " \
-H "Content-Type: application/json" \
-d '{
"deviceName": "My Device",
"savedTs": "1900-01-01T00:00:00.000Z",
"settings": { "settings": true }
}'
```
Keep in mind the `settings` field can be any format of string or JSON, meaning you can E2E encrypt settings and store them as Base64 as long as you also decrypt when receiving updates:
```bash
curl -X POST http:///api/v1/sync/update \
-H "Authorization: " \
-H "Content-Type: application/json" \
-d '{
"deviceName": "My Device",
"savedTs": "1900-01-01T00:00:00.000Z",
"settings": "eyAic2V0dGluZ..."
}'
```
#### API responses
The JSON return object from the API is structured as follows:
```
{
"success": true, // boolean | true/false
"data": "...", // String|Object | The settings data being returned
"action": "created", // String | created | A new settings entry was created.
// | none | The server-side data and device data are already up to date.
// | existingNewer | The server-side data is newer than what was sent by the device.
// | incomingNewer | The devices data is newer than the server-side data, so the
// server has stored this new data.
"error": "..." // String | If success is false, the reason why
}
```