Skip to content

Kristopher38/syncd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Syncd

Syncd is an OpenComputers daemon capable of synchronizing files between your local PC and your OpenComputers computer. It consists of two parts:

  1. Filesystem watcher written in Rust that notifies OC computer of any changes to the local filesystem
  2. rc.d script written in Lua that runs in the background on your OC computer and updates the OC filesystem based on notifications coming from filesystem watcher

Currently only one directory can be synchronized and only from your local PC to your OC computer. Filesystem watcher and rc.d script connect to each other through a STEM bridge.

Setup

Local machine

On your local machine run the filesystem watcher specifying the synchronized directory and channel (this should be a hard-to-guess string that you will input on the OC side to pair it with local PC side). A synchronized directory has to exist.

cargo run -- --channel your_unique_string --syncdir your_dir

Opencomputers machine

On your OC computer you need OpenOS and OPPM installed.

To install syncd package:

oppm register ShadowKatStudios/OC-Minitel
oppm register Kristopher38/syncd
oppm install syncd

Start the syncd daemon:

rc syncd start

This will create a config file under /etc/syncd.cfg. It contains the following options:

  • channel - unique name that you entered earlier when running cargo run, needs to be configured to the same string for both sides to sync files.
  • syncedDir - Path to directory where synced files will be stored in. Must be an absolute path. Default is "/home/default_dir".
  • address - address of a STEM server to connect to. Default is "stem.fomalhaut.me:5733".
  • backend - backend used for connection. Currently only support STEM. Default is "stem".
  • backendOps - extra parameters to pass to the backend. Default is {}.

You should adjust channel and syncedDir accordingly and restart the service:

rc syncd restart

At this point files and directories created locally should show up on your OC computer.

Acknowledgements

This project wouldn’t have been possible without the work of these awesome people and their projects. Special thanks to:

About

Synchronization daemon for syncing files between your local PC and OC computers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published