{"id":18344542,"url":"https://github.com/jisan09/ssh4me","last_synced_at":"2025-10-31T11:30:41.293Z","repository":{"id":165408209,"uuid":"637359595","full_name":"Jisan09/SSH4Me","owner":"Jisan09","description":"SSH4Me is a Docker container for secure root access to development environments via an Ngrok tunnel. ","archived":false,"fork":false,"pushed_at":"2024-08-15T05:18:40.000Z","size":15,"stargazers_count":21,"open_issues_count":0,"forks_count":141,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-09T17:09:44.052Z","etag":null,"topics":["docker","dockerfile","github-actions","ngrok","openssl","railway","railway-app","ssh","ssh-tunnel","tunnel-server","vps","vps-server","workflow","workflows"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jisan09.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-07T10:13:41.000Z","updated_at":"2024-12-16T18:38:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"7cc64072-fd5d-458f-9386-a87bf3dc665f","html_url":"https://github.com/Jisan09/SSH4Me","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jisan09%2FSSH4Me","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jisan09%2FSSH4Me/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jisan09%2FSSH4Me/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jisan09%2FSSH4Me/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jisan09","download_url":"https://codeload.github.com/Jisan09/SSH4Me/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239188667,"owners_count":19597033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","dockerfile","github-actions","ngrok","openssl","railway","railway-app","ssh","ssh-tunnel","tunnel-server","vps","vps-server","workflow","workflows"],"created_at":"2024-11-05T21:06:17.781Z","updated_at":"2025-10-31T11:30:41.215Z","avatar_url":"https://github.com/Jisan09.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SSH4Me\n\nSSH4Me is a Docker container that provides secure root access to development environments via an Ngrok tunnel. With configuration for root login and common development ports, SSH4Me makes it easy to access your environment securely from anywhere, including platforms like Railway.\n\n## Requirements\n\nTo use SSH4Me, you will need:\n\n- A GitHub account to fork the SSH4Me repository\n- An ngrok account to get an authentication token\n- Docker installed on your local machine if you want to run SSH4Me locally\n\n## Installation and Setup\n\n- ### Fork the SSH4Me Repository on GitHub\n\n   The first step is to fork the SSH4Me repository on GitHub. To do this  click the \"Fork\" button in the top-right corner of the page.\n\n- ### Sign up for an ngrok Account and Get Your Authentication Token\n   - Sign up for an ngrok account at [https://dashboard.ngrok.com/signup](https://dashboard.ngrok.com/signup).\n   - Get your ngrok authentication token from [https://dashboard.ngrok.com/get-started/your-authtoken](https://dashboard.ngrok.com/get-started/your-authtoken).\n\n      \u003cfigure\u003e\u003cimg src=\"https://graph.org/file/a540090cbde42cb121f81.jpg\" alt=\"ngrok dashboard\" width=\"720\"\u003e\u003c/figure\u003e\n    \u003e **You will need this token when you build the Docker container on Railway or locally.**\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003e〣 Run with Railway\u003c/h3\u003e\u003c/summary\u003e\n   \n- Go to [https://railway.app/new](https://railway.app/new) and build the Docker container with the following environment variables:\n    - `AUTH_TOKEN`: Your ngrok authentication token.\n    - `PASSWORD`: Password for SSH access (optional, default is `rootuser`).\n\n   \u003cfigure\u003e\u003cimg src=\"https://graph.org/file/e68689ddfbdb12cdc37d8.jpg\" alt=\"Railway app buildL\" width=\"720\"\u003e\u003c/figure\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003e〣 Run Locally\u003c/h3\u003e\u003c/summary\u003e\n\n#### Install Docker\n\nFirst, you need to install Docker on your local machine. You can download the appropriate version of Docker for your operating system from the [Docker website](https://www.docker.com/products/docker-desktop).\n\n#### Clone the SSH4Me Repository\n\n- Open a terminal window on your local machine.\n\n- Clone the SSH4Me repository by running the following command:\n\n   ```\n   git clone https://github.com/Jisan09/ssh4me\n   ```\n\n#### Build and Run the Docker Container\n\n- Navigate to the `ssh4me` directory by running the following command:\n\n   ```\n   cd ssh4me\n   ```\n\n- Build the Docker container by running the following command:\n\n   ```\n   docker build -t ssh4me --build-arg AUTH_TOKEN=AUTH_TOKEN --build-arg PASSWORD=PASSWORD .\n   ```\n\n- Run the Docker container by running the following command:\n\n   ```\n   docker run ssh4me\n   ```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003e〣 Run with Github Workflow\u003c/h3\u003e\u003c/summary\u003e\n\u003cb\u003e\u003ci\u003eNOTE :- This method isn't for making bot, it just for light work. This will work only for 6hr then will terminate.\u003c/i\u003e\u003c/b\u003e\n\n- Create a new workflow file (`builder.yml`) inside `.github/workflows/` folder of your repository and copy paste the below conent. **Or you can just fork the SSH4Me Repository.**\n\n\n\n  ```yml\n   name: 'Run SSH4Me'\n   on:\n   workflow_dispatch:\n\n   jobs:\n   build-and-run:\n      runs-on: ubuntu-latest\n      steps:\n         - name: Checkout repository\n         uses: actions/checkout@v2\n\n         - name: Run SSH4Me Action\n         uses: Jisan09/SSH4Me@main\n         env:\n            AUTH_TOKEN: ${{ secrets.AUTH_TOKEN }}\n            PASSWORD: ${{ secrets.PASSWORD }}\n  ```\n\n- Now go to the repository **`settings \u003e secrets and variables \u003e action \u003e new repository secret`** and add the following environment variables:\n    - `AUTH_TOKEN`: Your ngrok authentication token.\n    - `PASSWORD`: Password for SSH access.\n\n   \u003cfigure\u003e\u003cimg src=\"https://graph.org/file/6cdd1dbc67096a35df91e.jpg\" width=\"720\"\u003e\u003c/figure\u003e\n- Now go to **action** tab and run the workflow\n   \u003cfigure\u003e\u003cimg src=\"https://graph.org/file/2a2b09614d4ab60b911b4.jpg\" width=\"720\"\u003e\u003c/figure\u003e\n\n\u003c/details\u003e\n   \n \u003e ***Wait for the build to complete. Once it's done, you should see your ssh \u0026 password in log.***\n\n## Contributing\n\nWe welcome and encourage contributions to SSH4Me. If you find a bug or have an idea for a new feature, please open an issue or a pull request.\n\nIf you found SSH4Me useful, please consider giving it a star on GitHub by clicking the ⭐️ button. This helps to increase the visibility of the project and lets us know that you find it valuable.\n\nThank you for your support!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjisan09%2Fssh4me","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjisan09%2Fssh4me","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjisan09%2Fssh4me/lists"}