Moving around files and adding readme

2026-09-17 14:15:38 -06:00
parent bc6ad686e1
commit 09d1f0b88c
4 changed files with 62 additions and 2 deletions
@@ -0,0 +1,54 @@
+# better_ripper
+### Not actually better, literally a copy
+
+___
+
+This is mostly a showcase repository to show off automatic gitea actions
+
+### Setup
+
+#### Make a gitea runner (can run on your main machine)
+[Gitea's guide](https://docs.gitea.com/usage/actions/quickstart/)
+
+#### 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 an account at https://hub.docker.com, you're gonna need both the username and password
+
+#### Add gitea repository secrets
+Go to your gitea repository and go to:
+`Settings > Actions > Secrets`
+And make three new tokens:
+
+- API_KEY
+    - The api key you copied from gitea (if you didn't copy it before navigating away from the page you will need to make a new one)
+- DOCKERHUB_USERNAME
+    - Your docker hub username
+- DOCKERHUB_PASSWORD
+    - Your docker hub password
+(optional)
+- DOCKERHUB_TOKEN
+    - Your docker hub token (will be automatically made/updated with `./gitea/update_dockerhub_api`)
+
+#### Copy `.gitea` files
+The main files you need are:
+- `.gitea/scripts/update_dockerhub_api`
+- `.gitea/workflows/docker_build.yml`
+
+I recommend just putting them in your repository in the same file structure
+
+___
+
+And now your repository should automatically build itself according to it's `Dockerfile`
+
+#### 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 
+
+If none of those work, please [fill out an issue](https://gitea.happylizard.me/pizza2d1/better_ripper/issues/new) with your `.gitea` files (even though they shouldn't need to be modified)
+
+