https://github.com/os-js/osjs-xterm-application

OS.js Xterm Application
https://github.com/os-js/osjs-xterm-application

osjs osjs-application

Last synced: 11 months ago
JSON representation

OS.js Xterm Application

• Host: GitHub
• URL: https://github.com/os-js/osjs-xterm-application
• Owner: os-js
• License: other
• Created: 2018-03-03T13:13:58.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-08-09T22:52:55.000Z (almost 4 years ago)
• Last Synced: 2025-06-06T11:08:46.539Z (12 months ago)
• Topics: osjs, osjs-application
• Language: JavaScript
• Homepage: https://manual.os-js.org/v3/
• Size: 91.8 KB
• Stars: 20
• Watchers: 6
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


  



[OS.js](https://www.os-js.org/) is an [open-source](https://raw.githubusercontent.com/os-js/OS.js/master/LICENSE) web desktop platform with a window manager, application APIs, GUI toolkit, filesystem abstractions and much more.

[![Support](https://img.shields.io/badge/patreon-support-orange.svg)](https://www.patreon.com/user?u=2978551&ty=h&u=2978551)

[![Support](https://img.shields.io/badge/opencollective-donate-red.svg)](https://opencollective.com/osjs)

[![Donate](https://img.shields.io/badge/liberapay-donate-yellowgreen.svg)](https://liberapay.com/os-js/)

[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/andersevenrud)

[![Community](https://img.shields.io/badge/join-community-green.svg)](https://community.os-js.org/)

# OS.js v3 Xterm Application

This is the Xterm Application for OS.js v3

![Screenshot](https://raw.githubusercontent.com/os-js/osjs-xterm-application/master/screenshot.png)

## Requirements

* `bash`

* `ssh`

## Installation

```bash

npm install --save --production @osjs/xterm-application

npm run package:discover

```

# Usage

Start from application menu.

**Note that it will log into a shell with the username you are logged in as.**

If you want to change this behavior, you can add this to your `src/server/config.js` file in the OS.js distribution:

```javascript

module.exports = {

  // ... append this to your export ...

  xterm: {

    // You can also set this as a string to force a username

    login: false

  }

}

```

You can also change the connection arguments:

```javascript

module.exports = {

  // ... append this to your export ...

  xterm: {

    ssh: {

      // Custom hostname

      hostname: 'localhost',

      // Custom port

      args: '-p 1022'

    }

  }

}

```

## Contribution

* **Sponsor on [Github](https://github.com/sponsors/andersevenrud)**

* **Become a [Patreon](https://www.patreon.com/user?u=2978551&ty=h&u=2978551)**

* **Support on [Open Collective](https://opencollective.com/osjs)**

* [Contribution Guide](https://github.com/os-js/OS.js/blob/master/CONTRIBUTING.md)

## Documentation

See the [Official Manuals](https://manual.os-js.org/) for articles, tutorials and guides.

## Links

* [Official Chat](https://gitter.im/os-js/OS.js)

* [Community Forums and Announcements](https://community.os-js.org/)

* [Homepage](https://os-js.org/)

* [Twitter](https://twitter.com/osjsorg) ([author](https://twitter.com/andersevenrud))

* [Google+](https://plus.google.com/b/113399210633478618934/113399210633478618934)

* [Facebook](https://www.facebook.com/os.js.org)

* [Docker Hub](https://hub.docker.com/u/osjs/)