Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mguludag authored May 20, 2024
1 parent 04b78be commit 6c0a27c
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Run compiler-explorer instance into github actions worker (windows vc2022)
You need set secrets on settings → (NGROK)

* `NGROK_AUTH_TOKEN` Needed only for NGROK mode
* `PASSWORD` windows user password
* `TG_CHAT_ID` (optional) Telegram user id for get login url
* `TG_TOKEN` (optional) Telegram bot token for get message from bot

Expand All @@ -16,10 +15,10 @@ You need set secrets on settings → (NGROK)

These steps should be useful for debugging broken builds directly on the build worker. Use this project as reference and toss the steps into your project after some failing part of the build for introspection.

### Option 1 (Easy way 🚘)
### Option 1 (NGROK)

1) Get the tunnel auth token at: https://dashboard.ngrok.com/auth .
2) Under the repository's settings, make a secrets called `NGROK_AUTH_TOKEN`, `PASSWORD`
2) Under the repository's settings, make a secret called `NGROK_AUTH_TOKEN`
3) If you want to send link via telegram bot make the secrets `TG_TOKEN` and `TG_CHAT_ID`
4) Trigger a `ngrok-windows-compiler-explorer` in actions page.
5) Wait until the last step which will hang forever as it connects to ngrok and sets up the reverse tunnel.
Expand All @@ -28,6 +27,22 @@ These steps should be useful for debugging broken builds directly on the build w
9) Enjoy! ☕
10) When you're done introspecting, cancel the job.

### Option 2 (localtunnel)

1) Trigger a `compiler-explorer-win-msvc-lt` in actions page.
2) Wait until the last step which will hang forever as it connects to ngrok and sets up the reverse tunnel.
3) Wait for the message (`your url is: https://...`) from last step in job page (~10 min)
4) Open URL and Enjoy! ☕
5) When you're done introspecting, cancel the job.

### Option 3 (cloudflared)

1) Trigger a `compiler-explorer-win-msvc-cf` in actions page.
2) Wait until the last step which will hang forever as it connects to ngrok and sets up the reverse tunnel.
3) Wait for the message (`Your quick Tunnel has been created! Visit it at (it may take some time to be reachable):`) from last step in job page (~10 min)
4) Open URL below this line and Enjoy! ☕
5) When you're done introspecting, cancel the job.


## Useful Info

Expand Down

0 comments on commit 6c0a27c

Please sign in to comment.