logseq-sync
logseq-sync copied to clipboard
bcspragu
Instructions for how to get it set up and running for testing
Excited about the progress you're making here!
I'd like to try testing it, and it looks like from what you said here that maybe it's done enough to start trying out...? But I'm not sure because of some of what you say in the readme about S3 buckets and all that.
So if this is to a state where I could use it and test it (after compiling a special version of logseq) I'd love to do so, but it'd be great to have a simple guide to show what needs to be done. If it makes any difference, I've compiled logseq from source before in order to get the whiteboard feature before it was released to everyone so I guess I'm not 100% in the dark. I'm also on MacOS on an M2 processor.
Thanks!
It is most definitely testable! I've only ever tested against a real S3 bucket (using the Terraform config), but someone successfully tested it against localstack as well.
Running it looks something like this:
go run ./cmd/server/ --s3_bucket=logseq-sync-<long date string> --s3_role_arn=arn:aws:iam::<account>:role/logseq_sync
That will start the self-hosted sync server against a local SQLite database (at logseq-sync.db).
An example of modifying the Logseq codebase is here.
And similar for the rsapi dependency, which hardcodes the bucket name, region, and API endpoint. See sync.rs in this branch, the other changes are unrelated (though if you hit this issue, you might want to include those changes too).
The next step is really just making those upstream changes unnecessary by allowing them to be configurable. I just need to actually reach out to the Logseq team and make sure they're okay with adding that functionality (tucked away in some advanced settings menu probably)
Hey there! First of all, thank you for this amazing project. Have you by chance already got in touch with the Logseq team on that regard?
The next step is really just making those upstream changes unnecessary by allowing them to be configurable. I just need to actually reach out to the Logseq team and make sure they're okay with adding that functionality (tucked away in some advanced settings menu probably)
Have you by chance already got in touch with the Logseq team on that regard?
I've reached out via a few different mediums, but unfortunately haven't heard anything yet. I recently updated the README with the current state of affairs: https://github.com/bcspragu/logseq-sync?tab=readme-ov-file#getting-official-buy-in-from-logseq