Welcome to the mqtt-shell project. This tool helps you run commands on servers that are behind firewalls, without needing to open any ports. It uses strong encryption to ensure your commands remain secure.
- AES-256-GCM Encryption: Your commands are encrypted. This keeps them safe from prying eyes.
- Zero-Trust Architecture: No need to trust external networks. Your commands stay secure within the system.
- Easy Remote Access: Control servers from anywhere, even if they are behind firewalls.
- Operating System: Windows, macOS, or Linux
- Minimum RAM: 4 GB
- Processor: 1 GHz or faster
- Network: Internet connection for MQTT
- Go Version: 1.16 or later (if compiling from source)
Follow these steps to download and set up mqtt-shell:
-
Visit the Releases Page
Go to our Releases page to access the latest version. -
Download the Application
Choose the latest version and download the appropriate file for your operating system. -
Locate the Downloaded File
Check your Downloads folder or the location you chose to save the file. -
Run the Application
- For Windows: Double-click the .exe file.
- For macOS: Open the .dmg file and drag the app to your Applications folder.
- For Linux: Use the tarball or binary file as applicable and follow the standard run commands.
Once you run the application for the first time, you will need to configure it to connect to your MQTT broker.
-
Open mqtt-shell
Start the application after installation. -
Enter Broker Details
Provide the necessary information such as the broker address, port, and authentication credentials if required. -
Save Configuration
Click on "Save" or "Apply" to save your settings. -
Test Connection
Make sure to test your connection. Check the application for any error messages or connection issues.
To execute commands remotely:
-
Open the Command Interface
You will find a command input area in the application. -
Enter Your Command
Type the command you wish to run on the remote server. -
Send the Command
Click the "Send" button to transmit the command securely. -
View the Output
The result of your command will display in the output area of the application.
Using mqtt-shell enhances your system's security:
- End-to-End Encryption ensures that commands are secure from the moment you send them until they reach their destination.
- No Open Ports means your servers remain locked down, reducing the risk of unauthorized access.
If you experience issues:
- Connection Problems: Check your broker settings and networking conditions.
- Command Errors: Ensure the command is valid for the server you are targeting.
- Performance Issues: Assess your network stability and system resources.
If you need help, please create an issue on the GitHub repository, and we will assist you.
Join our community to share tips and ideas. You can also contribute to the project by submitting suggestions or improvements via issues or pull requests.
To start using mqtt-shell, visit the Releases page to download the latest version. Follow the installation and setup instructions provided above to get up and running quickly. Enjoy secure remote access to your servers!