syncstorage-rs icon indicating copy to clipboard operation
syncstorage-rs copied to clipboard

Clarifications to readme

Open svdasein opened this issue 4 months ago • 3 comments

I have been trying to get this thing going for a couple nights in a row, and I think I'm beginning to realize that part of the problem is that I'm having to read between the lines wrt the README.md instructions.

Am I right in thinking that what you're describing there is something akin to using the old python syncserver to forward connections to the rust daemon? If that's true - could you maybe clarify what's supposed to happen a bit more. It looks like the rust logic will use ports 5000 and 8000. If I've started the rust daemon before the syncserver one the syncserver blows up on addr used. If I do it the other way around it seems that while the rust daemon does start, it's no longer doing anything on port 5000.

Basically just a description of the concept would be really helpful. What is supposed to be listening on what and what is supposed to be forwarding to what, etc.

Honestly it's not clear from the instructions that I should actually run the old syncserver - it just talks about making config changes. Assuming I'm supposed to run it - is there some start order that's important?

One other thing - I grabbed the 0.20.0 tarball and attempted to build it. It blows up for lack of a requirements.txt in the root of the project. I fudged something up over several hours that seems to make everything happy, but out of the box it did not want to fully build for me.

┆Issue is synchronized with this Jira Task

svdasein avatar Aug 26 '25 22:08 svdasein

Has anyone looked at this? I'm pretty sure this is a <10min tweak to the docs.

svdasein avatar Oct 03 '25 00:10 svdasein

The Rust syncserver, by default, runs a web server on port 8000. It only requires the Rust toolchain, there is no Python needed at all to run it.

I can't make Mozilla fix their readme, but I can point you to the guide I wrote, which covers the build process and also web server proxy configuration: https://www.kyzer.me.uk/syncserver/

kyz avatar Oct 16 '25 12:10 kyz

I can't make Mozilla fix their readme, but I can point you to the guide I wrote, which covers the build process and also web server proxy configuration: https://www.kyzer.me.uk/syncserver/

This is fantastic - thanks for doing the work & sharing it! I'll be going through it soon.

svdasein avatar Oct 16 '25 13:10 svdasein