diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bf4c942..1e654f6 100755 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to BudgE +# Contributing to budge ## Gotchas @@ -24,10 +24,10 @@ ## Readme If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit. -Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-BudgE/edit/main/readme-vars.yml). +Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-budge/edit/main/readme-vars.yml). These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play. -Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-BudgE) +Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-budge) ### Fixing typos or clarify the text in the readme @@ -97,12 +97,12 @@ If you are proposing additional packages to be added, ensure that you added the ### Testing your changes ```bash -git clone https://github.com/linuxserver/docker-BudgE.git -cd docker-BudgE +git clone https://github.com/linuxserver/docker-budge.git +cd docker-budge docker build \ --no-cache \ --pull \ - -t linuxserver/BudgE:latest . + -t linuxserver/budge:latest . ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` @@ -115,7 +115,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Update the changelog -If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-BudgE/tree/main/root), add an entry to the changelog +If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-budge/tree/main/root), add an entry to the changelog ```yml changelogs: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5b59428..55108dd 100755 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -9,5 +9,5 @@ contact_links: about: Post on our community forum. - name: Documentation - url: https://docs.linuxserver.io/images/docker-BudgE + url: https://docs.linuxserver.io/images/docker-budge about: Documentation - information about all of our containers. diff --git a/.github/ISSUE_TEMPLATE/issue.bug.md b/.github/ISSUE_TEMPLATE/issue.bug.md index 671423a..d89db94 100755 --- a/.github/ISSUE_TEMPLATE/issue.bug.md +++ b/.github/ISSUE_TEMPLATE/issue.bug.md @@ -37,4 +37,4 @@ about: Create a report to help us improve ## Docker logs - + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b921ac7..647292c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -21,7 +21,7 @@ ------------------------------ - - [ ] I have read the [contributing](https://github.com/linuxserver/docker-BudgE/blob/main/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications + - [ ] I have read the [contributing](https://github.com/linuxserver/docker-budge/blob/main/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications ------------------------------ diff --git a/.github/workflows/external_trigger.yml b/.github/workflows/external_trigger.yml index 209c845..ac59e83 100755 --- a/.github/workflows/external_trigger.yml +++ b/.github/workflows/external_trigger.yml @@ -21,8 +21,8 @@ jobs: EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/linuxserver/budge/releases/latest" | jq -r '. | .tag_name') if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then echo "**** Can't retrieve external version, exiting ****" - FAILURE_REASON="Can't retrieve external version for BudgE branch main" - GHA_TRIGGER_URL="https://github.com/linuxserver/docker-BudgE/actions/runs/${{ github.run_id }}" + FAILURE_REASON="Can't retrieve external version for budge branch main" + GHA_TRIGGER_URL="https://github.com/linuxserver/docker-budge/actions/runs/${{ github.run_id }}" curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n**Trigger URL:** '"${GHA_TRIGGER_URL}"' \n"}], "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} @@ -31,10 +31,10 @@ jobs: EXT_RELEASE=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') echo "**** External version: ${EXT_RELEASE} ****" echo "**** Retrieving last pushed version ****" - image="linuxserver/BudgE" + image="linuxserver/budge" tag="latest" token=$(curl -sX GET \ - "https://ghcr.io/token?scope=repository%3Alinuxserver%2FBudgE%3Apull" \ + "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fbudge%3Apull" \ | jq -r '.token') multidigest=$(curl -s \ --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ @@ -54,7 +54,7 @@ jobs: IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}') if [ -z "${IMAGE_VERSION}" ]; then echo "**** Can't retrieve last pushed version, exiting ****" - FAILURE_REASON="Can't retrieve last pushed version for BudgE tag latest" + FAILURE_REASON="Can't retrieve last pushed version for budge tag latest" curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} @@ -64,13 +64,13 @@ jobs: if [ "${EXT_RELEASE}" == "${IMAGE_VERSION}" ]; then echo "**** Version ${EXT_RELEASE} already pushed, exiting ****" exit 0 - elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-BudgE/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then + elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-budge/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then echo "**** New version ${EXT_RELEASE} found; but there already seems to be an active build on Jenkins; exiting ****" exit 0 else echo "**** New version ${EXT_RELEASE} found; old version was ${IMAGE_VERSION}. Triggering new build ****" response=$(curl -iX POST \ - https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-BudgE/job/main/buildWithParameters?PACKAGE_CHECK=false \ + https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-budge/job/main/buildWithParameters?PACKAGE_CHECK=false \ --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|") echo "**** Jenkins job queue url: ${response%$'\r'} ****" echo "**** Sleeping 10 seconds until job starts ****" @@ -85,7 +85,7 @@ jobs: --data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ --data-urlencode "Submit=Submit" echo "**** Notifying Discord ****" - TRIGGER_REASON="A version change was detected for BudgE tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}" + TRIGGER_REASON="A version change was detected for budge tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}" curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, "description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}], "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} diff --git a/.github/workflows/external_trigger_scheduler.yml b/.github/workflows/external_trigger_scheduler.yml index c342f09..2b7e68c 100755 --- a/.github/workflows/external_trigger_scheduler.yml +++ b/.github/workflows/external_trigger_scheduler.yml @@ -2,7 +2,7 @@ name: External Trigger Scheduler on: schedule: - - cron: '32 * * * *' + - cron: '55 * * * *' workflow_dispatch: jobs: @@ -23,17 +23,17 @@ jobs: do br=$(echo "$br" | sed 's|origin/||g') echo "**** Evaluating branch ${br} ****" - ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-BudgE/${br}/jenkins-vars.yml \ + ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-budge/${br}/jenkins-vars.yml \ | docker run --rm -i --entrypoint yq ghcr.io/linuxserver/yq -r .ls_branch) if [ "$br" == "$ls_branch" ]; then echo "**** Branch ${br} appears to be live; checking workflow. ****" - if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-BudgE/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then + if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-budge/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then echo "**** Workflow exists. Triggering external trigger workflow for branch ${br} ****." curl -iX POST \ -H "Authorization: token ${{ secrets.CR_PAT }}" \ -H "Accept: application/vnd.github.v3+json" \ -d "{\"ref\":\"refs/heads/${br}\"}" \ - https://api.github.com/repos/linuxserver/docker-BudgE/actions/workflows/external_trigger.yml/dispatches + https://api.github.com/repos/linuxserver/docker-budge/actions/workflows/external_trigger.yml/dispatches else echo "**** Workflow doesn't exist; skipping trigger. ****" fi diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index c6d4f53..f1ba0e5 100755 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -8,6 +8,6 @@ jobs: steps: - uses: actions/first-interaction@v1 with: - issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-BudgE/blob/main/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-BudgE/blob/main/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!' - pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-BudgE/blob/main/.github/PULL_REQUEST_TEMPLATE.md)!' + issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-budge/blob/main/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-budge/blob/main/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!' + pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-budge/blob/main/.github/PULL_REQUEST_TEMPLATE.md)!' repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/package_trigger.yml b/.github/workflows/package_trigger.yml index 14533bb..7dc41ba 100755 --- a/.github/workflows/package_trigger.yml +++ b/.github/workflows/package_trigger.yml @@ -16,13 +16,13 @@ jobs: echo "**** Github secret PAUSE_PACKAGE_TRIGGER_BUDGE_MAIN is set; skipping trigger. ****" exit 0 fi - if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-BudgE/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then + if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-budge/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then echo "**** There already seems to be an active build on Jenkins; skipping package trigger ****" exit 0 fi echo "**** Package trigger running off of main branch. To disable, set a Github secret named \"PAUSE_PACKAGE_TRIGGER_BUDGE_MAIN\". ****" response=$(curl -iX POST \ - https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-BudgE/job/main/buildWithParameters?PACKAGE_CHECK=true \ + https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-budge/job/main/buildWithParameters?PACKAGE_CHECK=true \ --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|") echo "**** Jenkins job queue url: ${response%$'\r'} ****" echo "**** Sleeping 10 seconds until job starts ****" diff --git a/.github/workflows/package_trigger_scheduler.yml b/.github/workflows/package_trigger_scheduler.yml index 72cd52e..0011d90 100755 --- a/.github/workflows/package_trigger_scheduler.yml +++ b/.github/workflows/package_trigger_scheduler.yml @@ -2,7 +2,7 @@ name: Package Trigger Scheduler on: schedule: - - cron: '45 8 * * 0' + - cron: '12 11 * * 2' workflow_dispatch: jobs: @@ -23,18 +23,18 @@ jobs: do br=$(echo "$br" | sed 's|origin/||g') echo "**** Evaluating branch ${br} ****" - ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-BudgE/${br}/jenkins-vars.yml \ + ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-budge/${br}/jenkins-vars.yml \ | docker run --rm -i --entrypoint yq ghcr.io/linuxserver/yq -r .ls_branch) if [ "${br}" == "${ls_branch}" ]; then echo "**** Branch ${br} appears to be live; checking workflow. ****" - if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-BudgE/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then + if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-budge/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then echo "**** Workflow exists. Triggering package trigger workflow for branch ${br}. ****" triggered_branches="${triggered_branches}${br} " curl -iX POST \ -H "Authorization: token ${{ secrets.CR_PAT }}" \ -H "Accept: application/vnd.github.v3+json" \ -d "{\"ref\":\"refs/heads/${br}\"}" \ - https://api.github.com/repos/linuxserver/docker-BudgE/actions/workflows/package_trigger.yml/dispatches + https://api.github.com/repos/linuxserver/docker-budge/actions/workflows/package_trigger.yml/dispatches sleep 30 else echo "**** Workflow doesn't exist; skipping trigger. ****" @@ -46,5 +46,5 @@ jobs: echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****" echo "**** Notifying Discord ****" curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, - "description": "**Package Check Build(s) Triggered for BudgE** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-BudgE/activity/"' \n"}], + "description": "**Package Check Build(s) Triggered for budge** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-budge/activity/"' \n"}], "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} diff --git a/Jenkinsfile b/Jenkinsfile index 1b3ecf8..cc7fa26 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -419,18 +419,18 @@ pipeline { steps{ sh '''#! /bin/bash set -e - PACKAGE_UUID=$(curl -X GET -H "Authorization: Bearer ${SCARF_TOKEN}" https://scarf.sh/api/v1/organizations/linuxserver-ci/packages | jq -r '.[] | select(.name=="linuxserver/BudgE") | .uuid') + PACKAGE_UUID=$(curl -X GET -H "Authorization: Bearer ${SCARF_TOKEN}" https://scarf.sh/api/v1/organizations/linuxserver-ci/packages | jq -r '.[] | select(.name=="linuxserver/budge") | .uuid') if [ -z "${PACKAGE_UUID}" ]; then echo "Adding package to Scarf.sh" curl -sX POST https://scarf.sh/api/v1/organizations/linuxserver-ci/packages \ -H "Authorization: Bearer ${SCARF_TOKEN}" \ -H "Content-Type: application/json" \ - -d '{"name":"linuxserver/BudgE",\ + -d '{"name":"linuxserver/budge",\ "shortDescription":"example description",\ "libraryType":"docker",\ - "website":"https://github.com/linuxserver/docker-BudgE",\ - "backendUrl":"https://ghcr.io/linuxserver/BudgE",\ - "publicUrl":"https://lscr.io/linuxserver/BudgE"}' || : + "website":"https://github.com/linuxserver/docker-budge",\ + "backendUrl":"https://ghcr.io/linuxserver/budge",\ + "publicUrl":"https://lscr.io/linuxserver/budge"}' || : else echo "Package already exists on Scarf.sh" fi @@ -453,16 +453,16 @@ pipeline { sh "docker build \ --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ --label \"org.opencontainers.image.authors=linuxserver.io\" \ - --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-BudgE/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-BudgE\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-BudgE\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-budge/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-budge\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-budge\" \ --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.vendor=linuxserver.io\" \ --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Budge\" \ - --label \"org.opencontainers.image.description=[BudgE](https://github.com/linuxserver/BudgE) is an open source 'budgeting with envelopes' personal finance app.\" \ + --label \"org.opencontainers.image.description=[budge](https://github.com/linuxserver/budge) is an open source 'budgeting with envelopes' personal finance app.\" \ --no-cache --pull -t ${IMAGE}:${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." } @@ -483,16 +483,16 @@ pipeline { sh "docker build \ --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ --label \"org.opencontainers.image.authors=linuxserver.io\" \ - --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-BudgE/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-BudgE\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-BudgE\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-budge/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-budge\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-budge\" \ --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.vendor=linuxserver.io\" \ --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Budge\" \ - --label \"org.opencontainers.image.description=[BudgE](https://github.com/linuxserver/BudgE) is an open source 'budgeting with envelopes' personal finance app.\" \ + --label \"org.opencontainers.image.description=[budge](https://github.com/linuxserver/budge) is an open source 'budgeting with envelopes' personal finance app.\" \ --no-cache --pull -t ${IMAGE}:amd64-${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." } @@ -510,16 +510,16 @@ pipeline { sh "docker build \ --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ --label \"org.opencontainers.image.authors=linuxserver.io\" \ - --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-BudgE/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-BudgE\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-BudgE\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-budge/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-budge\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-budge\" \ --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.vendor=linuxserver.io\" \ --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Budge\" \ - --label \"org.opencontainers.image.description=[BudgE](https://github.com/linuxserver/BudgE) is an open source 'budgeting with envelopes' personal finance app.\" \ + --label \"org.opencontainers.image.description=[budge](https://github.com/linuxserver/budge) is an open source 'budgeting with envelopes' personal finance app.\" \ --no-cache --pull -f Dockerfile.armhf -t ${IMAGE}:arm32v7-${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." sh "docker tag ${IMAGE}:arm32v7-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER}" @@ -544,16 +544,16 @@ pipeline { sh "docker build \ --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ --label \"org.opencontainers.image.authors=linuxserver.io\" \ - --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-BudgE/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-BudgE\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-BudgE\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-budge/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-budge\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-budge\" \ --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.vendor=linuxserver.io\" \ --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Budge\" \ - --label \"org.opencontainers.image.description=[BudgE](https://github.com/linuxserver/BudgE) is an open source 'budgeting with envelopes' personal finance app.\" \ + --label \"org.opencontainers.image.description=[budge](https://github.com/linuxserver/budge) is an open source 'budgeting with envelopes' personal finance app.\" \ --no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." sh "docker tag ${IMAGE}:arm64v8-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}" diff --git a/README.md b/README.md index 1415e14..a8acfff 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - + [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) @@ -27,28 +27,28 @@ Find us at: * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories. * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget -# [linuxserver/BudgE](https://github.com/linuxserver/docker-BudgE) +# [linuxserver/budge](https://github.com/linuxserver/docker-budge) -[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2FBudgE?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2FBudgE) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-BudgE.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-BudgE) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-BudgE.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-BudgE/releases) -[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-BudgE/packages) -[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-BudgE/container_registry) -[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/BudgE) -[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/BudgE.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/BudgE) -[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/BudgE.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/BudgE) -[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-BudgE%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-BudgE/job/main/) -[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2FBudgE%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/BudgE/latest/index.html) +[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fbudge?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fbudge) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-budge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-budge) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-budge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-budge/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-budge/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-budge/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/budge) +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/budge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/budge) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/budge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/budge) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-budge%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-budge/job/main/) +[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fbudge%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/budge/latest/index.html) -[BudgE](https://github.com/linuxserver/BudgE) is an open source 'budgeting with envelopes' personal finance app. +[budge](https://github.com/linuxserver/budge) is an open source 'budgeting with envelopes' personal finance app. -[![BudgE]()](https://github.com/linuxserver/BudgE) +[![budge]()](https://github.com/linuxserver/budge) ## Supported Architectures Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). -Simply pulling `lscr.io/linuxserver/BudgE` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. +Simply pulling `lscr.io/linuxserver/budge` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. The architectures supported by this image are: @@ -72,15 +72,15 @@ Here are some example snippets to help you get started creating a container. --- version: "2.1" services: - BudgE: - image: lscr.io/linuxserver/BudgE - container_name: BudgE + budge: + image: lscr.io/linuxserver/budge + container_name: budge environment: - PUID=1000 - PGID=1000 - TZ=America/New_York volumes: - - /path/to/BudgE/config:/config + - /path/to/budge/config:/config ports: - 80:80 - 443:443 @@ -91,15 +91,15 @@ services: ```bash docker run -d \ - --name=BudgE \ + --name=budge \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=America/New_York \ -p 80:80 \ -p 443:443 \ - -v /path/to/BudgE/config:/config \ + -v /path/to/budge/config:/config \ --restart unless-stopped \ - lscr.io/linuxserver/BudgE + lscr.io/linuxserver/budge ``` ## Parameters @@ -147,18 +147,18 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel ## Docker Mods -[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=BudgE&query=%24.mods%5B%27BudgE%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=BudgE "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=budge&query=%24.mods%5B%27budge%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=budge "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above. ## Support Info -* Shell access whilst the container is running: `docker exec -it BudgE /bin/bash` -* To monitor the logs of the container in realtime: `docker logs -f BudgE` +* Shell access whilst the container is running: `docker exec -it budge /bin/bash` +* To monitor the logs of the container in realtime: `docker logs -f budge` * container version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' BudgE` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' budge` * image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/BudgE` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/budge` ## Updating Info @@ -169,16 +169,16 @@ Below are the instructions for updating containers: ### Via Docker Compose * Update all images: `docker-compose pull` - * or update a single image: `docker-compose pull BudgE` + * or update a single image: `docker-compose pull budge` * Let compose update all containers as necessary: `docker-compose up -d` - * or update a single container: `docker-compose up -d BudgE` + * or update a single container: `docker-compose up -d budge` * You can also remove the old dangling images: `docker image prune` ### Via Docker Run -* Update the image: `docker pull lscr.io/linuxserver/BudgE` -* Stop the running container: `docker stop BudgE` -* Delete the container: `docker rm BudgE` +* Update the image: `docker pull lscr.io/linuxserver/budge` +* Stop the running container: `docker stop budge` +* Delete the container: `docker rm budge` * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) * You can also remove the old dangling images: `docker image prune` @@ -190,7 +190,7 @@ Below are the instructions for updating containers: docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ - --run-once BudgE + --run-once budge ``` * You can also remove the old dangling images: `docker image prune` @@ -206,12 +206,12 @@ Below are the instructions for updating containers: If you want to make local modifications to these images for development purposes or just to customize the logic: ```bash -git clone https://github.com/linuxserver/docker-BudgE.git -cd docker-BudgE +git clone https://github.com/linuxserver/docker-budge.git +cd docker-budge docker build \ --no-cache \ --pull \ - -t lscr.io/linuxserver/BudgE:latest . + -t lscr.io/linuxserver/budge:latest . ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` diff --git a/readme-vars.yml b/readme-vars.yml index a1a3efb..de6b750 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -1,8 +1,8 @@ --- # project information -project_name: BudgE -project_url: "https://github.com/linuxserver/BudgE" +project_name: budge +project_url: "https://github.com/linuxserver/budge" project_logo: "" project_blurb: "[{{ project_name }}]({{ project_url }}) is an open source 'budgeting with envelopes' personal finance app." project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"