Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/udxs/neil-ux
Remote Desktop Initiation Utility for 2MC
https://github.com/udxs/neil-ux
Last synced: about 1 month ago
JSON representation
Remote Desktop Initiation Utility for 2MC
- Host: GitHub
- URL: https://github.com/udxs/neil-ux
- Owner: UDXS
- License: apache-2.0
- Created: 2022-10-28T04:55:26.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T05:55:12.000Z (about 2 years ago)
- Last Synced: 2023-03-06T09:33:10.146Z (almost 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 974 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `neil-ux` and Chooser
## Remote Desktop Initiation Utility
This tool makes it possible to configure remote desktop over SSH, VNC, and HTTP without port conflicts.\
It will:
- allocate VNC/HTTP ports to users
- provide them with simplified SSH forwarding instructions
- prepare a web-based VNC client
Running `neil-ux` will add the user to the database and re-running it will always provide them with their\
SSH configuration instructions.
When configuration is applied to the user's client system, they can run `ssh neil-desktop` to start forwarding.\
This will display the web and VNC ports they can access, as well as instructions for correctly termination the session.
## Neil Chooser
Chooser provides a simple UI that is displayed at desktop startup, enabling selection of different Desktop Environments. This UI is hardcoded with different DEs currently and can be modified as needed.
Chooser will reopen to present options again when a DE is closed but note that closing all applications before closing the DE is required for this to work. This feature is incompatible with XFCE4.
---
## Notes
Developed for use by Team 2MuchCache at San Diego Supercomputer Center for SCC '22.
Do not attempt to install this without adaptation to your environment.\
The file `install.neil` should only be used as a guideline for installation requirements.\
Values are hardcoded so change `uxutility.js` as needed.
TigerVNC recommended. When using Chooser, change `/etc/X11/Xvnc-session` to remove line `vncconfig -iconic &`.Sessions are not persistent.
**NOTE:** There is no intra-server VNC security. Users can access other running sessions if they
know the correct port number.\
Do **NOT** use in untrusted environments.
---
## Acknowledgements & Licensing
`neil-ux` and Neil Chooser is licensed for use under the Apache 2.0 license. See [LICENSE.md](LICENSE.md).\
Copyright © 2022 Davit Margarian.
Neil Chooser is based on [`neutralinojs-minimal`](https://github.com/neutralinojs/neutralinojs-minimal)
and the [Neutralinojs](https://neutralino.js.org/) runtime.\
Licensed under the MIT License. Copyright © Neutralinojs and contributors.
`neil-ux` is built on Node.js and its dependencies are tabulated below:
###
| Module Identifier | License | Repository |
| --------------------- | ------- | -------------------------------------------------- |
| [email protected] | MIT | https://github.com/jprichardson/node-death |
| [email protected] | MIT | https://github.com/tiaanduplessis/get-them-args |
| [email protected] | ISC | https://github.com/isaacs/node-graceful-fs |
| [email protected] | MIT | https://github.com/tiaanduplessis/kill-port |
| [email protected] | MIT | https://github.com/moxystudio/node-proper-lockfile |
| [email protected] | MIT | https://github.com/tim-kos/node-retry |
| [email protected] | MIT | https://github.com/tiaanduplessis/shell-exec |
| [email protected] | ISC | https://github.com/tapjs/signal-exit |
[NoVNC](https://github.com/novnc/noVNC) is licensed under the Mozilla Public License 2.0.