From 8987d22c2861dbf7487b81d0db9fc2930cbf92c4 Mon Sep 17 00:00:00 2001 From: Youngkyun Date: Sun, 22 Oct 2017 11:47:10 +0900 Subject: [PATCH] Update README.md --- .ruby-version | 2 +- README.md | 39 +++++++++++++++------------------------ 2 files changed, 16 insertions(+), 25 deletions(-) diff --git a/.ruby-version b/.ruby-version index 5859406..276cbf9 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1 +1 @@ -2.2.3 +2.3.0 diff --git a/README.md b/README.md index 9cb8ddf..456b402 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,27 @@ -**Gluster Web Interface** ---------------------------- +# Gluster Web Interface + [Gluster](https://gluster.org) client web interface for managing and using glusterfs more efficiently. +## Requirement -*Requirement:* - 1. glusterfs server and client(to be installed) - - 2. ruby (2.2.3 or more) - - 3. rails - - 4. sudo privileges **"without password"** [(see here)](http://askubuntu.com/questions/147241/execute-sudo-without-password) +* glusterfs cluster +* ruby (version: 2.3.0) +* sudo privileges **"without password"** [(see here)](http://askubuntu.com/questions/147241/execute-sudo-without-password) -*Setup:* - 1. Clone this repo : git clone - https://github.com/oss2016summer/gluster-web-interface.git +## Setup - 2. cd gluster-web-interface - - 3. script/setup.sh - - 4. rails s - -That's it! - -Navigate to http://localhost:3000 +``` +git clone https://github.com/oss2016summer/gluster-web-interface.git +cd gluster-web-interface +script/setup.sh +rails s +``` +That's it! Navigate to http://localhost:3000 If you want access via public network, use additional module like [localtunnel](https://github.com/localtunnel/localtunnel) - -**Contributing** +## Contributing In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), everyone is encouraged to help improve this project. Here are a few ways you can pitch in: