krotik/rufs repository overview

⁠Rufs

Rufs is a remote union filesystem which aims to provide a lightweight and secure solution for distributed file storage. Rufs uses a client-server system where servers expose branches and clients mount one or several branches into a tree structure. The client can overlay branches providing a union view.

Read further on the project page⁠.

⁠Features

• Client-Server model using RPC call over SSL.
• Single executable for client and server.
• Communication is secured via a secret token which is never transferred over the network and certificate pinning once a client has connected successfully.
• Clients can provide a unified view with files from different locations.
• Default client provides CLI, REST API and a web interface.
• Branches can be read-only.
• A read-only version of the file system can be exported via FUSE and mounted.

⁠Getting Started

You can also pull the latest docker image of Rufs from Dockerhub⁠:

docker pull krotik/rufs

Create an empty directory, change into it and run the following to start the server:

docker run --rm --user $(id -u):$(id -g) -v $PWD:/data -p 9020:9020 krotik/rufs server

This exposes port 9020 from the container on the local machine. All runtime related files are written to the current directory as the current user/group.

Run the client by running:

docker run --rm --network="host" -it -v $PWD:/data --user $(id -u):$(id -g) -v $PWD:/data krotik/rufs client

The client will also use the runtime related files from the current directory.