From a0e0878390981a961e32d40a55dbd15fd5b9eb15 Mon Sep 17 00:00:00 2001 From: pizza2d1 Date: Thu, 17 Sep 2026 14:28:16 -0600 Subject: [PATCH] Update readme --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d8e575b..7b6fbbc 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,31 @@ # better_ripper -### Not actually better, literally a copy +#### Not actually better, literally a copy ___ -This is mostly a showcase repository to show off automatic gitea actions +#### This is mostly a showcase repository to show off automatic gitea actions -### Setup +# Setup -#### Make a gitea runner (can run on your main machine) + +## Make a gitea runner (can run on your main machine) [Gitea's guide](https://docs.gitea.com/usage/actions/quickstart/) -#### Get gitea api key +## Get gitea api key If you wanna test this out for yourself, you first need to get a gitea API key by going to: + `Settings > Applications > Generate New Token` + Make sure to copy the token before you navigate off the page -#### Make a docker hub account +## Make a docker hub account Make an account at https://hub.docker.com, you're gonna need both the username and password -#### Add gitea repository secrets +## Add gitea repository secrets Go to your gitea repository and go to: + `Settings > Actions > Secrets` + And make three new tokens: - API_KEY @@ -29,22 +34,22 @@ And make three new tokens: - Your docker hub username - DOCKERHUB_PASSWORD - Your docker hub password -(optional) -- DOCKERHUB_TOKEN +- DOCKERHUB_TOKEN (optional) - Your docker hub token (will be automatically made/updated with `update_dockerhub_api`) -#### Copy `.gitea` files +## Copy `.gitea` files The main files you need are: + - `update_dockerhub_api` - `.gitea/workflows/docker_build.yml` -I recommend just putting them in your repository in the same file structure +`.gitea/workflows/docker_build.yml` is required to be there, but if you wanna move `update_dockerhub_api` you just need to make sure to update `.gitea/workflows/docker_build.yml` to the new location ___ And now your repository should automatically build itself according to it's `Dockerfile` -#### Troubleshooting +## Troubleshooting If your don't see any new actions starting, make sure that your runner daemon is active. And make sure that in the `.gitea/workflows/docker_build.yml` file that you are triggering actions for the correct branch name, as right now it only triggers for branch pushes to ones named "master" If your actions break midway through, make sure that your gitea repository secrets are set properly and you are not being upload-limited by https://hub.docker.com