https://github.com/yuqingc/rmdashrf
Serving mounted directory securely
https://github.com/yuqingc/rmdashrf
file-services remote-filesystem
Last synced: about 1 year ago
JSON representation
Serving mounted directory securely
- Host: GitHub
- URL: https://github.com/yuqingc/rmdashrf
- Owner: yuqingc
- License: mit
- Created: 2018-09-21T04:07:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-17T05:58:12.000Z (over 7 years ago)
- Last Synced: 2024-06-20T12:05:12.896Z (almost 2 years ago)
- Topics: file-services, remote-filesystem
- Language: Go
- Homepage:
- Size: 6.52 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rmdashrf (WIP)
**RMDASHRF** serves mounted directory with highly security and efficiently
Table of Contents
=================
* [rmdashrf (WIP)](#rmdashrf-wip)
* [Table of Contents](#table-of-contents)
* [Get Started](#get-started)
* [Install binaries](#install-binaries)
* [Install from source](#install-from-source)
* [Start](#start)
* [Run a Docker image](#run-a-docker-image)
* [API Documentation](#api-documentation)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [Tools](#tools)
* [Dependencies](#dependencies)
* [Debug](#debug)
## Get Started
### Install binaries
Download binaries in the [release page](https://github.com/yuqingc/rmdashrf/releases)
### Install from source
```sh
$ go get github.com/yuqingc/rmdashrf
```
### Start
```
$ rmdashrf -port=8080 -volume=/data
```
The `-port` flag is optional, `8080` by default. Use `./rmdashrf -h` or `./rmdashrf -help` for more information
### Run a Docker image
TODO
## API Documentation
- [apis](https://github.com/yuqingc/rmdashrf/blob/master/docs/apis.md)
## Roadmap
- [roadmap](https://github.com/yuqingc/rmdashrf/blob/master/docs/roadmap.md)
## Contributing
### Tools
|Name|Version|
|-|-|
|go|1.11|
|dep|0.5|
|docker-ce|18.03|
### Dependencies
```
$ dep ensure
```
### Debug
- The entry main package is in `cmd/rmdashrf`