https://github.com/gnmyt/Nexterm
The open source server management software for SSH, VNC & RDP
https://github.com/gnmyt/Nexterm
Last synced: 10 months ago
JSON representation
The open source server management software for SSH, VNC & RDP
- Host: GitHub
- URL: https://github.com/gnmyt/Nexterm
- Owner: gnmyt
- License: mit
- Created: 2024-08-13T17:14:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-03T08:00:44.000Z (10 months ago)
- Last Synced: 2025-09-03T10:07:13.237Z (10 months ago)
- Language: JavaScript
- Homepage: http://docs.nexterm.dev/
- Size: 5.41 MB
- Stars: 3,288
- Watchers: 28
- Forks: 148
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
- awesome-ops - gnmyt/Nexterm - 08-13|2025-11-07 | 一个简易的堡垒机，支持 SSH、VNC 和 RDP 协议管理远程主机。同时支持 SFTP 管理功能，并且支持服务应用的简单管理。 | (终端工具)
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Release][release-shield]][release-url]
## 🤔 What is Nexterm?
Nexterm is an open-source server management software that allows you to:
- Connect remotely via SSH, VNC and RDP
- Manage files through SFTP
- Deploy applications via Docker
- Manage Proxmox LXC and QEMU containers
- Secure access with two-factor authentication
## 🚀 Run preview
You can run a preview of Nexterm by clicking [here](https://docs.nexterm.dev/preview).
## 💻 Development
### Prerequisites
- Node.js 18+
- Yarn
- Docker (optional)
### Local Setup
#### Clone the repository
```sh
git clone https://github.com/gnmyt/Nexterm.git
cd Nexterm
```
#### Install dependencies
```sh
yarn install
cd client && yarn install
cd ..
```
#### Start development mode
```sh
yarn dev
```
## 🔧 Configuration
The server listens on port 6989 by default. You can modify this behavior using environment variables:
- `SERVER_PORT`: Server listening port (default: 6989)
- `NODE_ENV`: Runtime environment (development/production)
- `ENCRYPTION_KEY`: Encryption key for passwords, SSH keys and passphrases (default: Randomly generated key)
- `AI_SYSTEM_PROMPT`: System prompt for AI features (example: You are a Linux command generator assistant.)
## 🛡️ Security
- Two-factor authentication
- Session management
- Password encryption
- Docker container isolation
## 🤝 Contributing
Contributions are welcome! Please feel free to:
1. Fork the project
2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 🔗 Useful Links
- [Documentation](https://docs.nexterm.dev)
- [Discord](https://dc.gnmyt.dev)
- [Report a bug](https://github.com/gnmyt/Nexterm/issues)
- [Request a feature](https://github.com/gnmyt/Nexterm/issues)
## License
Distributed under the MIT license. See `LICENSE` for more information.
[contributors-shield]: https://img.shields.io/github/contributors/gnmyt/Nexterm.svg?style=for-the-badge
[contributors-url]: https://github.com/gnmyt/Nexterm/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gnmyt/Nexterm.svg?style=for-the-badge
[forks-url]: https://github.com/gnmyt/Nexterm/network/members
[stars-shield]: https://img.shields.io/github/stars/gnmyt/Nexterm.svg?style=for-the-badge
[stars-url]: https://github.com/gnmyt/Nexterm/stargazers
[issues-shield]: https://img.shields.io/github/issues/gnmyt/Nexterm.svg?style=for-the-badge
[issues-url]: https://github.com/gnmyt/Nexterm/issues
[license-shield]: https://img.shields.io/github/license/gnmyt/Nexterm.svg?style=for-the-badge
[license-url]: https://github.com/gnmyt/Nexterm/blob/master/LICENSE
[release-shield]: https://img.shields.io/github/v/release/gnmyt/Nexterm.svg?style=for-the-badge
[release-url]: https://github.com/gnmyt/Nexterm/releases/latest