A sync server implemented in go to communicate with Brave sync clients using components/sync/protocol/sync.proto. Current Chromium version for sync protocol buffer files used in this repo is Chromium 116.0.5845.183.
This server supports endpoints as bellow.
- The
POST /v2/command/
endpoint handles Commit and GetUpdates requests from sync clients and return corresponding responses both in protobuf format. Detailed of requests and their corresponding responses are defined inschema/protobuf/sync_pb/sync.proto
. Sync clients are responsible for generating valid access tokens and present them to the server in the Authorization header of requests.
Currently we use dynamoDB as the datastore, the schema could be found in schema/dynamodb/table.json
.
- Run
make docker
to build two images,brave-sync
andbrave-dynamo
- Run
make PUSH=docker.io/... push
to push the images to some docker registries
The example docker-compose.yml
could be:
services:
brave-sync:
image: brave-sync:latest
user: 1000:1000
ports:
- 127.0.0.1:8295:8295
depends_on:
- brave-dynamo
- redis
environment:
# After devices setup, you can remove the `ALLOW_NEW_REG` to keep some badass out:
- ALLOW_NEW_REG=1
- ENV=local
- AWS_ACCESS_KEY_ID=GOSYNC
- AWS_SECRET_ACCESS_KEY=GOSYNC
- AWS_REGION=us-west-2
- AWS_ENDPOINT=http://brave-dynamo:8000
- TABLE_NAME=client-entity-dev
- REDIS_URL=redis:6379
restart: unless-stopped
brave-dynamo:
image: brave-dynamo:latest
user: 1000:1000
volumes:
- /where/to/store/the/data:/db
restart: unless-stopped
redis:
image: redis:6.2
user: 1000:1000
environment:
- ALLOW_EMPTY_PASSWORD=yes
volumes:
- /where/to/store/the/redis:/data
restart: unless-stopped
For most up-to-date compose file, please visit the docker-compose.yml
:)
- A environment
ALLOW_NEW_REG
is added, a new client (which have no devices connected) is only allowed if it's set to1
- You can push the images, due to some network restrictions, I'm not going to publish them via docker.io
- Install Go 1.22
- Install GolangCI-Lint
- Install gowrap
- Clone this repo
- Install protobuf protocol compiler if you need to compile protobuf files, which could be built using
make protobuf
. - Build via
make
- Clone this repo
- Run
make docker
- Run
make docker-up
- To connect to your local server from a Brave browser client use
--sync-url="http://localhost:8295/v2"
- For running unit tests, run
make docker-test
- Copy the
.proto
files fromcomponents/sync/protocol
inchromium
toschema/protobuf/sync_pb
ingo-sync
. - Copy the
.proto
files fromcomponents/sync/protocol
inbrave-core
toschema/protobuf/sync_pb
ingo-sync
. - Run
make repath-proto
to set correct import paths in.proto
files. - Run
make proto-go-module
to add thego_module
option to.proto
files. - Run
make protobuf
to generate the Go code from.proto
definitions.
The instrumented datastore and redis interfaces are generated, providing integration with Prometheus. The following will re-generate the instrumented code, required when updating protocl definitions:
make instrumented
Changes to datastore/datastore.go
or cache/cache.go
should be followed with the above command.