Giter Club home page Giter Club logo

restful-zfs's Introduction

restful-zfs

A JSON REST API for the ZFS cli

Provides a RESTful API for ZFS

Goal

Our goal is to have a working JSON API for the whole ZFS cli (currently tested under FreeBSD). Please have a look at the Features section for more information about what is currently supported.

This API will be help us to build some beautiful web UIs for the ZFS tools on FreeBSD.

Features (currently)

  • List ZFS pools
  • Create ZFS pools
  • Destroy ZFS pools
  • and many more soon...

Dependencies

The following perl modules are required:

Getting Started

Get cpanminus

curl -L https://cpanmin.us | perl - App::cpanminus

Install dependencies

git clone https://github.com/omani/restful-zfs.git
cd restful-zfs
cpanm -L extlib Mojolicious YAML Mojolicious::Plugin::Swagger2 Backticks

Start API on localhost (port 3000)

./start.sh

To work with the Swagger2 UI editor (web UI listening on port 4000)

./start_swaggerUI.sh

Documentations

Contributions

Feel free to contribute

  • Fork repository
  • Change files
  • Commit
  • Start pull request
  • Get your name into the list of contributors

Maintainer

Hasan Pekdemir [email protected]

License

Released under the FreeBSD License (See the LICENSE file)

restful-zfs's People

Contributors

omani avatar kylebruene avatar

Stargazers

Jeffery Padgett avatar

Watchers

James Cloos avatar  avatar

Forkers

kylebruene

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.