cubething_psync 0.1.0.dev3

Simple project synchronization tool.

psync is a simple tool to sync your project over SSH. It consists of a client and server.

Features

• Project syncing with rsync (requires ssh)
• Execute project binary on daemon host
• Real-time logging based on websockets
• Natural Ctrl-C / SIGINT handling on client and server
• SSL authentication
• Containerized for easy deployment

Example usecase

I am working on a game project. Compiling a game written in Rust requires a lot of CPU power, but I want to be able to build from my low-end laptop. I already have my machines hooked up to SSH into each other. So, I set up the client on my laptop, use my editor to SSH into my desktop server, and sync the build assets from the desktop to the laptop using psync. Note that while the desktop is the server for the editor, it is the client for psync. Similar for the laptop.

Usage

When you want to run the project, you must build it and then execute the psync client. The client will sync the files and send a start message to the server. This starts up the synced executable on the server machine. The server will send logs and listen for events, e.g. shutdown messages (sent with SIGINT).

Server

The server should be set up on the machine which is to recieve the files. This corresponds to the laptop in the example usecase.

Ideally you should run the server as a daemon, for example using the systemd config included in this repository.

Client

The client should be invoked on the machine which is to send the files. This corresponds to the desktop in the example usecase. After every build, the client should be run. The client will then sync the files. Once this is done, recieve logs from the server.

Security

Please generate an SSL certificate. You can use the following one-line if you'd like.

openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes \
    -subj "/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=localhost" \
    -addext "subjectAltName=DNS:localhost,DNS:psync-server,IP:127.0.0.1"

Note that this sets an alternate name as psync-server. This will be useful when deploying to docker.

I recommend that you do not expose this over the wire. I am only using it over my local network. If you intend on serving this over the WAN, you should use something like ZeroTier to secure your connection.