GitHub Machines

GitHub_Machiens is an automation solution that allows users to access Windows, Ubuntu, and macOS machines through GitHub Actions by forking this repository and configuring access using ngrok.

Table of Contents

Table of Contents

1. Features
2. Built With
3. Installation
4. Usage
   • Triggering the Workflows
   • Accessing Machines
     • Window
     • Ubuntu
     • Macos
5. Customizing
6. Contributing
7. License
8. Contact
9. Acknowledgments

Features

• Cross-Platform Support: Gain access to Windows, Ubuntu, and macOS virtual machines using GitHub Actions.
• Easy Setup: Fork the repository and configure access using GitHub Actions workflows.
• Secure Access: Use ngrok for secure tunneling into the machines.
• Customizable Workflows: Modify GitHub Actions workflows to suit your project requirements.
• Automated Testing: Utilize GitHub Actions to test software across multiple platforms.

Built With

Installation

To use this project, follow these steps:

1. Fork the Repository: Click the Fork button at the top right of this repository.

2. Set up GitHub Secrets: You need to configure the necessary GitHub Secrets to establish a secure connection to the machines using ngrok.

3. Go to your forked repository.

4. Navigate to Settings > Secrets and variables > Actions.

5. Add the following secrets:

• NGROK_TOKEN: Your ngrok authentication token. Get ngrok token here.
• NGROK_DOMAIN: A custom domain (optional) or ngrok subdomain to use for secure access.

Example:

Secret Name	Description
NGROK_TOKEN	Your ngrok authentication token
NGROK_DOMAIN	Your ngrok subdomain

Note: if your Ngrok account dosen't linked to a payment method, windows WILL NOT work.

Usage

Once you've forked the repository and set up the GitHub Secrets, you can use the provided workflows to access Windows, Ubuntu, and macOS machines.

Triggering the Workflows

1. Go to the Actions tab in your forked repository.
2. Select the desired workflow (Windows, Ubuntu, or macOS).
3. Click Run workflow to trigger access to the machine.

Accessing Machines

windows

• use any RDP client and Navigate to Ngrok Endpoints
• copy the endpoint of your machine and past it into the rdp client with the user "runner" & password "P@ssw0rd!"
• Done.

Ubuntu

• Navigate to your Ngrok Domain and that's all

Macos

• SOON..

Customizing

Clone the Repository:

If you want to modify the workflows locally, clone the forked repository to your local machine using:

git clone https://github.com/yourusername/GitHub_Machiens.git
cd GitHub_Machiens

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your 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

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Ammar Mohamed - [email protected]

Project Link: https://github.com/ammar0xff/GitHub_Machines

Acknowledgments

• Gotty
• Ngrok