chjj/tty.js - GitHub


tty.js - A terminal for your browser, using node/express/socket.io



 
 

Related Links:

Content

Cached Text (at the time of saving)


A terminal in your browser using node.js and socket.io. Based on Fabrice Bellard's vt100 for jslinux.
Screenshots
irssi
vim & alsamixer
bash
Features
Tabs, Stacking Windows, Maximizable Terminals
Screen/Tmux-like keys (optional)
Ability to efficiently render programs: vim, mc, irssi, vifm, etc.
Support for xterm mouse events
256 color support
Install
Configuration
Configuration is stored in ~/.tty.js/config.json or ~/.tty.js as a single JSON file. An example configuration file looks like:
{"users":{"hello":"world"},"https":{"key":"./server.key","cert":"./server.crt"},"port":8080,"hostname":"127.0.0.1","shell":"sh","shellArgs":["arg1","arg2"],"static":"./static","limitGlobal":10000,"limitPerUser":1000,"hooks":"./hooks.js","cwd":".","term":{"termName":"xterm","geometry":[80,30],"scrollback":1000,"visualBell":false,"popOnBell":false,"cursorBlink":false,"screenKeys":false,"colors":["#2e3436","#cc0000","#4e9a06","#c4a000","#3465a4","#75507b","#06989a","#d3d7cf""#555753","#ef2929","#8ae234","#fce94f","#729fcf","#ad7fa8","#34e2e2","#eeeeec",]}}
Usernames and passwords can be plaintext or sha1 hashes.
256 colors
If tty.js fails to check your terminfo properly, you can force your TERM to xterm-256color by setting "termName": "xterm-256color" in your config.
Example Hooks File
vardb=require('./db');module.exports={auth:function(user,pass,next){// Do database authnext(null,pass===password);}};
Security
tty.js currently has https as an option. It also has express' default basic auth middleware as an option, until it possibly gets something more robust. It's ultimately up to you to make sure no one has access to your terminals but you.

port 3000 - start and bind to port 3000.
daemonize - daemonize process.
config ~/my-config.json - specify config file.

The main goal of tty.js is to eventually write a full xterm emulator. This goal has almost been reached, but there are a few control sequences not implemented fully. TERM should render everything fine when set to xterm.
Portability
tty.js should ultimately be able to work on any unix that implements unix98 tty's and forkpty(3). tty.js builds on linux and osx, and it should build on NetBSD, FreeBSD, and OpenBSD as well. If you have trouble building, please post an issue.
Todo
The distance to go before full xterm compatibility.
VT52 codes for compatibility
All vt400 rectangle sequences
Remaining DEC private modes
Miscellaneous sequences: cursor shape, window title
Origin Mode, Insert Mode
Proper Tab Setting
License
Copyright (c) 2012, Christopher Jeffrey (MIT License)