github.com/rohankumardubey/proxyfs@v0.0.0-20210108201508-653efa9ab00e/README.md (about) 1 [![Build Status](https://travis-ci.com/swiftstack/ProxyFS.svg?branch=development)](https://travis-ci.com/swiftstack/ProxyFS) 2 [![Coverage Status](https://coveralls.io/repos/github/swiftstack/ProxyFS/badge.svg?branch=development)](https://coveralls.io/github/swiftstack/ProxyFS?branch=development) 3 4 # ProxyFS 5 Integrated File and Object Access for Swift Object Storage 6 7 ## Synopsis 8 9 ProxyFS is a hierarchical file system that provides integrated file 10 and object API access for data stored with 11 [Swift object storage](http://swift.openstack.org) for the same 12 data. It supports SMB and NFS along with AWS S3 and Swift object 13 protocols. We call this "bi-modal access", and it means that filesystem 14 clients and mount and read/write data that is simultaneously accessible 15 to object API clients. 16 17 ## How to Contribute 18 19 All code contributions for ProxyFS go through GitHub. 20 21 https://github.com/swiftstack/ProxyFS 22 23 Please feel free to contribute by opening a pull request to the 24 `development` branch. If you see an open pull request, feel free to 25 review it and leave comments on it. ProxyFS follows a 26 [git flow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) 27 development model. 28 29 If you'd like to ask questions, discuss ideas, or otherwise communicate 30 with other ProxyFS contributors, please register for and participate 31 in the [ProxyFS dev mailing list](https://lists.proxyfs.org/mailman/listinfo) 32 or the [ProxyFS Slack group](https://proxyfs.slack.com), which you can join through 33 [this inivitation](https://join.slack.com/t/proxyfs/shared_invite/enQtMzA2NTQwMDU4NTkyLWM4ZjhkYmE0NWEzMTYzZGZkNThkNzcxMzg0NWIzMmQ4MTU5MGQyMDRlY2UzMDU0YjBlNGZkMzk4N2NkNTRjNjY). 34 35 ## Development Environment 36 37 The officially supported development environment for ProxyFS is 38 [Runway](https://github.com/swiftstack/runway). Please read Runway's 39 documentation and make sure to use the ProxyFS manifest instead of the default 40 one. 41 42 ## How to get the code (if not using Runway) 43 44 * Define your GOPATH as desired (where your bin/, /pkg, and /src/ 45 directory trees will appear) 46 * cd $GOPATH 47 * mkdir -p src/github.com/swiftstack 48 * cd src/github.com/swiftstack 49 * git clone git@github.com:swiftstack/ProxyFS.git 50 * cd ProxyFS 51 * git submodule update --init --recursive 52 53 ## How to run unit tests (in your Development Environment) 54 55 * Install/update to at least Go 1.8.3 (if not using Runway) 56 * Ensure $GOPATH/bin is in your $PATH 57 * cd $GOPATH/src/github.com/swiftstack/ProxyFS 58 * ./regression_test.py 59 60 ## Commercial Deployment 61 62 ProxyFS powers File Access for the SwiftStack product. 63 See: http://swiftstack.com 64 65 ## License 66 67 See LICENSE file