Nexterm

<br /> <p align="center"> <a href="https://github.com/gnmyt/Nexterm"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/WhNYRgX.png"> <img alt="Nexterm Banner" src="https://i.imgur.com/TBMT7dt.png"> </picture> </a> </p>

🤔 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 and OIDC SSO
• Separate users and servers into Organizations

📷 Screenshots

<table> <tr> <td><img src="docs/public/assets/showoff/servers.png" alt="Servers" /></td> <td><img src="docs/public/assets/showoff/connections.png" alt="Connections" /></td> <td><img src="docs/public/assets/showoff/sftp.png" alt="SFTP" /></td> </tr> <tr> <td><img src="docs/public/assets/showoff/snippets.png" alt="Snippets" /></td> <td><img src="docs/public/assets/showoff/monitoring.png" alt="Monitoring" /></td> <td><img src="docs/public/assets/showoff/recordings.png" alt="Recordings" /></td> </tr> </table>

🚀 Install

You can install Nexterm by clicking here.

💻 Development

Prerequisites

• Node.js 18+
• Yarn
• Docker (optional)

Local Setup

Clone the repository

git clone https://github.com/gnmyt/Nexterm.git
cd Nexterm

Install dependencies

yarn install
cd client && yarn install
cd ..

Start development mode

yarn dev

🔧 Configuration

Docker Images

| Image | Description | |------------------|----------------------------------------------------------| | nexterm/aio | All-In-One — server, client, and engine bundled together | | nexterm/server | Server + web client only (requires external engine) | | nexterm/engine | Engine only |

The server listens on port 6989 by default. You can modify this behavior using environment variables:

• SERVER_PORT: Server listening port (default: 6989)
• CONTROL_PLANE_PORT: TCP port for engine communication (default: 7800)
• NODE_ENV: Runtime environment (development/production)
• ENCRYPTION_KEY: Encryption key for passwords, SSH keys and passphrases. Supports Docker secrets via /run/secrets/encryption_key`
• AI_SYSTEM_PROMPT: System prompt for AI features (example: You are a Linux command generator assistant.)
• LOG_LEVEL: Logging level for application and engine (system/info/verbose/debug/warn/error, default: system)

🛡️ Security

• Two-factor authentication
• Session management
• Password encryption
• Docker container isolation
• Oauth 2.0 OpenID Connect SSO

🤝 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
• Discord
• Report a bug
• Request a feature

💜 Powered by

📄 License

Distributed under the MIT license. See LICENSE for more information.