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

coderaiser 39e52ee701 docs(help) View: add features, hot keys

2014-05-14 09:47:33 -04:00

15 KiB

Raw Blame History

Cloud Commander v0.8.4

###[Main][MainURL] [Blog][BlogURL] Live(![IO][IO_LIVE_IMG] [IO][IOURL], ![JitSu][JitSu_LIVE_IMG] [JitSu][JitSuURL], ![Heroku][Heroku_LIVE_IMG] [Heroku][HerokuURL]) [NPM_INFO_IMG]: https://nodei.co/npm/cloudcmd.png?downloads=true&&stars "npm install cloudcmd" [MainURL]: http://cloudcmd.io "Main" [BlogURL]: http://blog.cloudcmd.io "Blog" [IOURL]: http://io.cloudcmd.io "IO" [JitSuURL]: http://cloudcmd.jit.su "JitSu" [HerokuURL]: http://cloudcmd.herokuapp.com/ "Heroku" [IO_LIVE_IMG]: https://status-ok.cloudcmd.io/host/io.cloudcmd.io/img/txt.png "IO" [JitSu_LIVE_IMG]: https://status-ok.cloudcmd.io/host/cloudcmd.jit.su/img/txt.png "JitSu" [HEROKU_LIVE_IMG]: https://status-ok.cloudcmd.io/host/cloudcmd.herokuapp.com/img/txt.png "Heroku"

Cloud Commander web based orthodox file manager with console and editor. Will help you manage the server and work with files, folders and programs in browser from any computer, mobile or tablet device.

Benefits

Open Source (MIT License).
Has 2 classic panels.
Optional authorization.
Client works in web browser.
Server works on Windows, Linux and Mac OS.
Could be used local or remotely.
Adapting to screen size.
Editor with support of syntax highlighting for over 110 languages.
Console with support of default OS command line.
Written in JavaScript/Node.js.

Install

The installation of file manager is very simple.

install node.js if you still have not.
install cloudcmd via npm with one simple command.

![NPM_INFO][NPM_INFO_IMG]

Start

To start Cloud Commander only one command needed:

node cloudcmd

or if you install with -g flag just type:

cloudcmd

Cloud Commander reads port information from config file json/config.json and start server on default port (8000), if none of port variables (cloud9, cloudfoundry and nodester) isn't exist. To start work type in address bar of your browser:

http://127.0.0.1:8000

Hot keys

Key	Operation
`F1`	help
`F2`	rename
`F3`	view
`Shift` + `F3`	view as `markdown`
`F4`	edit
`F5`	copy
`F6`	rename/move
`F7`	new dir
`Shift + F7`	new file
`F8`, `Delete`	remove
`Shift + Delete`	remove without prompt
`F9`	menu
`F10`	config
`*`	select/unselect all
`+`	expand selection
`-`	shrink selection
`Ctrl + r`	refresh
`Ctrl + d`	clear local storage
`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
`Ctrl + \`	go to the root directory
`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
`Space`	select current file (and get size of directory)
`Insert`	select current file (and move to next)
`F9`	context menu
`~`	console
`Ctrl + Click`	open file on new tab

View

Features

View images.
View text files.
Playing audio.
Playing video.

###Hot keys

Key	Operation
`F3`	open
`Esc`	close

Edit

Demo

Features

Syntax highlighting based on extension of file for over 110 languages.
Build in emmet (for html files)
Drag n drop (drag file from desktop to editor).
Build in jshint (with options in .jshintrc file)
Configurable options (could be edited in json/edit.json)

###Hot keys

Key	Operation
`F4`	open
`Ctrl + s`	save
`Ctrl + f`	find
`Ctrl + h`	replace
`Ctrl + g`	go to line
`Esc`	close

For more details see Ace keyboard shortcuts.

Console

Demo

###Hot keys

Key	Operation
`~`	open
`Esc`	close

Config

Demo

###Hot keys

Key	Operation
`F10`	open
`Esc`	close

Demo Right mouse click button shows context menu with items:

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

###Hot keys

Key	Operation
`F9`	open
`Esc`	close

Configuration

All main configuration could be done via json/config.json.

{
    "auth"              : false,    /* enable http authentication               */
    "username"          : "root",   /* username for authentication              */
    "password"          : "toor",   /* password hash in sha-1 for authentication*/
    "appCache"          : false,    /* cache files for offline use              */
    "analytics"         : true,     /* google analytics support                 */
    "diff"              : true,     /* when save - send patch, not whole file   */
    "zip"               : true,     /* zip text before send / unzip before save */
    "notifications"     : false,    /* show notifications when tab is not active*/
    "localStorage"      : true,     /* cache directory data                     */
    "minify"            : true      /* minification of js,css,html and img      */
    "online"            : true,     /* load js files from cdn or local path     */
    "cache"             : true,     /* add cache-control                        */
    "logs"              : false,    /* logs or console ouput                    */
    "showKeysPanel"     : true,     /* show classic panel with buttons of keys  */
    "server"            : true,     /* server mode or testing mode              */
    "socket"            : true      /* enable web sockets                       */
    "port"              : 8000,     /* http port                                */
    "sslPort"           : 443,      /* https port                               */
    "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.

iptables -t nat -L # look rules before
iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-ports 8000
iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-ports 4430
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).

iptables -t nat -D PREROUTING 2
iptables -t nat -D PREROUTING 1

###nginx Get nginx. On linux it could be done this way:

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;
    client_max_body_size 100m;
    server_name io.cloudcmd.io;
    access_log /var/log/nginx/io.cloudcmd.io.access.log;
    location / {
        proxy_pass          http://127.0.0.1:8000/;
    }
}

If you want add ssl, add a couple lines to server block:

server {
    listen 443;
    client_max_body_size 100m;
    ssl                  on;
    ssl_certificate      /home/coderaiser/cloudcmd/ssl/ssl.crt;
    ssl_certificate_key  /home/coderaiser/cloudcmd/ssl/ssl.key;
    server_name io.cloudcmd.io;
    access_log /var/log/nginx/io.cloudcmd.io.access.log;
    location / {
        proxy_pass    http://127.0.0.1:8000/;
    }
}

For websocket support (nginx >= v1.3.13) modify server block:

    location / {
        proxy_http_version  1.1;
        proxy_set_header    Upgrade $http_upgrade;
        proxy_set_header    Connection "upgrade";

        proxy_pass          http://127.0.0.1:8000/;
    }

If you need redirection from http to https, it's simple:

server {
    listen 80;
    server_name admin.cloudcmd.io;
    rewrite ^ https://io.cloudcmd.io$request_uri? permanent; #301 redirect
    access_log /var/log/nginx/io.cloudcmd.io.access.log;
}

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

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

nohup node cloudcmd

Update

Cloud Commander is very often updated. 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 list

To extend capabilities of file manager next modules used:

[Ace] AceURL
[Diff-Match-Patch] Diff-Match-PatchURL
[Minify] MinifyURL
[FancyBox] FancyBoxURL
[jq-console] jq-consoleURL
[github] githubURL
[dropbox-js] dropbox-jsURL
[jquery] jqueryURL
[socket.io] socketIOURL
[http-auth] httpAuthURL
[rimraf] rimrafURL
[mkdirp] mkdirpURL

Contributing

If you would like to contribute - read guide and send pull requests to dev branch. Getting dev version of Cloud Commander:

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

Version history

2014.04.28, v0.8.4
2014.03.19, v0.8.3
2014.03.03, v0.8.2
2014.02.13, v0.8.1
2014.02.13, v0.8.0
2013.12.09, v0.7.0
2013.11.08, v0.6.0
2013.10.17, v0.5.0
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.07.09, v0.1.0

Special Thanks

Polietilena for logo and favicon.
TarZak
- Russian and Ukrainian translations;
- config template and style;
- change order of directories and files;
- add ability do not hide path and header when files are scrolling;

15 KiB Raw Blame History

Cloud Commander v0.8.4

Benefits

Install

Start

Hot keys

View

Features

Edit

Features

Console

Config

Menu

Configuration

Server

Update

Additional modules list

Contributing

Version history

Special Thanks

15 KiB

Raw Blame History