Skip to content

Commit 0361727

Browse files
committed
docs: added config for docker hub
1 parent 3c1bd3d commit 0361727

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# RunPod Worker HelloWorld
1+
# runpod-worker-helloworld
22

3-
> Hello World on [RunPod](https://www.runpod.io/) serverless
3+
> "Hello World" on [RunPod](https://www.runpod.io/) serverless
4+
5+
---
46

57
<!-- toc -->
68

79
- [Setup](#setup)
810
- [Local testing](#local-testing)
911
- [Deploy to Dockerhub](#deploy-to-dockerhub)
12+
* [Automatically deploy with Github Actions](#automatically-deploy-with-github-actions)
1013
- [Use your Docker image on RunPod serverless](#use-your-docker-image-on-runpod-serverless)
1114
- [Interact with your RunPod API](#interact-with-your-runpod-api)
1215
* [Health status](#health-status)
@@ -52,6 +55,17 @@ INFO | Local testing complete, exiting.
5255
* Push your Docker image to Dockerhub like this `docker push <dockerhub_username>/<repository_name>:<tag>`, in this case: `docker push timpietruskyblibla/runpod-worker-helloworld:1.0.1`
5356
* Once this is done, you can check your Dockerhub account to find the image
5457

58+
### Automatically deploy with Github Actions
59+
60+
The repo also contains a workflow that publishes the image to Docker hub using Github Actions. If you want to use this, you should add these secrets to your repo:
61+
62+
| Configuration Variable | Description | Example Value |
63+
| ---------------------- | ------------------------------------------------------------ | -------------------------- |
64+
| `DOCKERHUB_USERNAME` | Your Docker Hub username. | `your-username` |
65+
| `DOCKERHUB_TOKEN` | Your Docker Hub token for authentication. | `your-token` |
66+
| `DOCKERHUB_REPO` | The repository on Docker Hub where the image will be pushed. | `timpietruskyblibla` |
67+
| `DOCKERHUB_IMG` | The name of the image to be pushed to Docker Hub. | `runpod-worker-helloworld` |
68+
5569
## Use your Docker image on RunPod serverless
5670

5771
* Create a [new template](https://runpod.io/console/serverless/user/templates) by clicking on `New Template`

0 commit comments

Comments
 (0)