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.
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 download a precompiled package for Windows (win64) or Linux (amd64) [here](https://devt.de/build_status.html). The archive contains a single executable which contains the server and client code for Rufs. ### Tutorial: To get an idea of what EliasDB is about have a look at the [tutorial](/examples/local_fileshare/doc/tutorial.md). ### REST API: The terminal uses a REST API to communicate with the backend. The REST API can be browsed using a dynamically generated swagger.json definition (https://localhost:9090/fs/swagger.json). You can browse the API of Rufs's latest version [here](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/krotik/rufs/master/doc/swagger.json#/default). ### Command line options The main Rufs executable has two main tools: ``` Rufs 1.0.0 Usage of ./rufs [tool] The tools are: server Run as a server client Run as a client Use ./rufs [tool] --help for more information about a tool. ``` The most important one is server which starts the file server. The server has several options: ``` Rufs 1.0.0 Usage of ./rufs server [options] -config string Server configuration file (default "rufs.server.json") -help Show this help message -secret string Secret file containing the secret token (default "rufs.secret") -ssl-dir string Directory containing the ssl key.pem and cert.pem files (default "ssl") The server will automatically create a default config file and default directories if nothing is specified. ``` Once the server is started the client tool can be used to interact with the server. The options of the client tool are: ``` Rufs 1.0.0 Usage of ./rufs client [mapping file] -fuse-mount string Mount tree as FUSE filesystem at specified path (read-only) -help Show this help message -secret string Secret file containing the secret token (default "rufs.secret") -ssl-dir string Directory containing the ssl key.pem and cert.pem files (default "ssl") -web string Export the tree through a https interface on the specified host:port The mapping file assignes remote branches to the local tree. The client tries to load rufs.mapping.json if no mapping file is defined. It starts empty if no mapping file exists. The mapping file should have the following json format: { "branches" : [ { "branch" :