mirror of https://github.com/coderaiser/cloudcmd.git synced 2026-01-23 18:55:26 +00:00

coderaiser 5e96e2f168 docs(readme) add "\n"

2013-10-03 17:50:56 +03:00

13 KiB

Raw Blame History

Cloud Commander v0.4.0 [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]

###[Main][MainURL] [Blog][BlogURL] [Demo][DemoURL] [NPMIMGURL]: https://badge.fury.io/js/cloudcmd.png [BuildStatusIMGURL]: https://secure.travis-ci.org/coderaiser/cloudcmd.png?branch=master [DependencyStatusIMGURL]: https://gemnasium.com/coderaiser/cloudcmd.png [FlattrIMGURL]: http://api.flattr.com/button/flattr-badge-large.png [NPM_INFO_IMG]: https://nodei.co/npm/cloudcmd.png?downloads=true&&stars [NPMURL]: https://npmjs.org/package/cloudcmd [BuildStatusURL]: http://travis-ci.org/coderaiser/cloudcmd "Build Status" [DependencyStatusURL]: https://gemnasium.com/coderaiser/cloudcmd "Dependency Status" [FlattrURL]: https://flattr.com/submit/auto?user_id=coderaiser&url=github.com/coderaiser/cloudcmd&title=cloudcmd&language=&tags=github&category=software "flattr" [NPM_INFO_URL]: https://npmjs.org/package/cloudcmd "npm" [MainURL]: http://cloudcmd.io "Main" [BlogURL]: http://blog.cloudcmd.io "Blog" [DemoURL]: http://io.cloudcmd.io "Demo"

Cloud Commander - cloud file manager with console and editor.

[![Flattr][FlattrIMGURL]][FlattrURL]

Benefits

full browser compatibility (ie6+,chrome,safari,opera,firefox);
responsible design
one full page loading, and then just one-time json-dir-listings loading (with refresh opportunity).
caching read directories to localStorage (for now) (so if network will disconnected or something happens with a signal, we definitely will can work with cached copy of directory listings);
key binding
disabled js support (working in limited mode).

Cloud Commander uses all benefits of js, so if js is disabled, we go to limited mode.

Limited-mode features

no keybinding
no local caching
full loading of all web page(with styles, js-scripts, html-page etc).

Hot keys

In all modern web browsers (but not in IE, becouse he special) hot keys works. There is a short list:

F1 - help
F2 - rename current file
F3 - view
F4 - edit
F5 - copy
F6 - rename/move
F7 - new dir
F8, Delete - remove current file
F9 - menu
Ctrl + r - reload dir content
Ctrl + d - clear local cache (wich contains dir contents)
Alt + q - disable key bindings
Alt + s - get all key bindings back
Ctrl + a - select all files in a panel
up, down, enter - filesystem navigation
Tab - move via panels
Page Up - up on one page
Page Down - down on one page
Home - to begin of list
End - to end of list
Shift + Delete - remove without prompt
Insert - select current file
Shift + F10 - context menu
~ - console

Edit

Demo

###Hot keys

F4 - open
Ctrl + s - save
Esc - close

Console

Demo

###Hot keys

~ - open
Esc - close

Demo Right mouse click button shows context menu with items:

View
Edit
Rename
Delete
Zip file
(Un)Select All
Upload to (Dropbox, Github, GDrive)
Download
New (File, Dir, from cloud)

###Hot keys

F9 - open
Esc - close

Right mouse click button shows context menu with items:

View
Edit
Rename
Delete
Upload to (Dropbox, Github, GDrive)
Download
New (File, Dir, from cloud)

Install

[![NPM_INFO][NPM_INFO_IMG]][NPM_INFO_URL]

Installing Cloud Commander is very simple. All you need is

install node.js
download and unpack or just clone repository from github:

    git clone git://github.com/coderaiser/cloudcmd.git
    cd cloudcmd
    node cloudcmd

or install in npm:

    npm i cloudcmd -g
    cloudcmd

Configuration

All main configuration could be done via config.json.

{
    "api_url"           :"/api/v1",
    "appcache"          : false,    /* cache files for offline use              */
    "analytics"         : true,     /* google analytics suport                  */
    "localStorage"      : true,     /* cache directory data                     */
    "minification" : {              /* minification of js,css,html and img      */
        "js"    : false,            /* minify module needed                     */
        "css"   : false,            /* npm i minify                             */
        "html"  : true,
        "img"   : false
    },
    "online"            : true,      /* load js files from cdn or local path     */
    "cache"             : true,
    "logs"              : false,     /* logs or console ouput                    */
    "show_keys_panel"   : true,      /* show classic panel with buttons of keys  */
    "server"            : true,      /* server mode or testing mode              */
    "socket"            : true       /* enable web sockets                       */
    "port"              : 8000,      /* http port or null(default)               */
    "sslPort"           : 443,       /* https port or null(default)              */
    "ip"                : null,      /* ip or null(default)                      */
    "ssl"               : false      /* should use https?                        */
    "rest"              : true       /* enable rest interface                    */
}

If you had changed config and want to keep updating via git, you should execute next command in root directory of Cloud Commander:

git update-index --assume-unchanged json/config.json

To get back to tracking:

git update-index --no-assume-unchanged json/config.json

Server

Standard practices say no non-root process gets to talk to the Internet on a port less than 1024. Anyway I suggest you to start Cloud Commander as non-root. How it could be solved? There is a couple easy and fast ways. One of them is port forwarding. ###Iptables Just run shell/addtables.sh for default options.

@:/tmp/cloudcmd (dev) $ sudo iptables -t nat -L # look rules before
@:/tmp/cloudcmd (dev) $ sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-ports 8000
@:/tmp/cloudcmd (dev) $ sudo iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-ports 4430
@:/tmp/cloudcmd (dev) $ sudo iptables -t nat -L # look rules after

You should see something like this ( 8000 and 4430 should be in config as port and sslPort )

target     prot opt source               destination
REDIRECT   tcp  --  anywhere             anywhere             tcp dpt:http redir ports 8000
REDIRECT   tcp  --  anywhere             anywhere             tcp dpt:https redir ports 4430

If you would want to get things back just clear rules ( 1 and 2 it's rule numbers, in your list they could differ).

@:/tmp/cloudcmd (dev) $ sudo iptables -t nat -D PREROUTING 2
@:/tmp/cloudcmd (dev) $ sudo iptables -t nat -D PREROUTING 1

###nginx Get nginx. On linux it could be done like that

sudo apt-get install nginx #for ubuntu and debian

Than make host file /etc/nginx/sites-enabled/io.cloudcmd.io ( io.cloudcmd.io is your domain name) with content:

server {
    listen 80;
    server_name io.cloudcmd.io;
    access_log /var/log/nginx/io.cloudcmd.io.access.log;
    location / {
        proxy_pass    http://127.0.0.1:8000/;
    }
}

# create symlink of this file
ln -s ./sites-enabled/io.cloudcmd.io ./sites-available
# restart nginx
/etc/init.d/nginx restart

If you will want to upload files, you should add next line in http section of /etc/nginx/nginx.conf:

#limit of uploading data
client_max_body_size 100m;

To run Cloud Commander as daemon in linux you could set log to true in config and do something like this:

nohup node cloudcmd

Authorization

Cloud Commander could authorize clients on GitHub via openID. All things that should be done is must be added id and secret of application from github settings page and added to modules.json (id just) and env variable (secret) with names: github_id, github_secret, dropbox_key, dropbox_secret etc in secret.bat (on win32) or secret.sh (on nix).

Start

To start Cloud Commander only one command needed:

node cloudcmd

or on win platform just

cloudcmd

After that Cloud Commander reads port information from config file config.json and start server on this port ( 8000 by default ), if none of port variables ( cloud9, cloudfoundry and nodester ) isn't exist. Then type in browser

http://127.0.0.1:8000

http://localhost:8000

Update

Cloud Commander is very often updates. Update is doing automagically but it could be done also manualy by typing a few commands in cloudcmd directory:

git pull

or check new version on npm

npm info cloudcmd

and then, if there is new version

npm r cloudcmd
npm i cloudcmd

Additional modules

Cloud Commander's Server Side not using additional modules for main functionality. But for minification and optimization tricks optional can be assingned (and installed) modules: [Minify] (https://github.com/coderaiser/minify "Minify") and [socket.io] (https://github.com/LearnBoost/socket.io "Socket.IO").

Install addtitional modules (type in Cloud Commander directory):

npm i

Extensions

Cloud Commander desinged to easily porting extensions. For extend main functionality Cloud Commander use next modules:

[Ace] AceURL
[FancyBox] FancyBoxURL
[jQuery-contextMenu] jQuery-contextMenuURL
[jq-console] jq-consoleURL
[github] githubURL
[dropbox-js] dropbox-jsURL
[jquery] jqueryURL

Contributing

If you would like to contribute - send pull request to dev branch. Getting dev version of Cloud Commander:

git clone git://github.com/coderaiser/cloudcmd.git
git checkout dev

It is possible that dev version of Cloud Commander will needed dev version of Minify, so to get it you should type a couple more commands:

cd node_modules
rm -rf minify
git clone git://github.com/coderaiser/minify
git checkout dev

Version history

2013.09.27, v0.4.0
2013.08.01, v0.3.0
2013.04.22, v0.2.0
2013.03.01, v0.1.9
2012.12.12, v0.1.8
2012.10.01, v0.1.7
2012.08.24, v0.1.6
2012.08.06, v0.1.5
2012.07.27, v0.1.4
2012.07.19, v0.1.3
2012.07.14, v0.1.2
2012.07.11, v0.1.1
2012.00.00, v0.1.0

License

MIT license.

Special Thanks

Polietilena for logo and favicon.
Elec-ua for ru and ua translations.

13 KiB Raw Blame History

Cloud Commander v0.4.0 [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]

Benefits

Limited-mode features

Hot keys

Edit

Console

Menu

Menu

Install

Configuration

Server

Authorization

Start

Update

Additional modules

Extensions

Contributing

Version history

License

Special Thanks

13 KiB

Raw Blame History