diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 710006b..f7a8374 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to mastodon +# Contributing to hometown ## 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-mastodon/edit/main/readme-vars.yml). +Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-hometown/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-mastodon) +Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-hometown) ### 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-mastodon.git -cd docker-mastodon +git clone https://github.com/linuxserver/docker-hometown.git +cd docker-hometown docker build \ --no-cache \ --pull \ - -t linuxserver/mastodon:latest . + -t linuxserver/hometown: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-mastodon/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-hometown/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 1868697..47d4d32 100644 --- 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-mastodon + url: https://docs.linuxserver.io/images/docker-hometown about: Documentation - information about all of our containers. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8b2203c..b0c3d72 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-mastodon/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-hometown/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 819d5cc..eead1f3 100644 --- a/.github/workflows/external_trigger.yml +++ b/.github/workflows/external_trigger.yml @@ -12,17 +12,17 @@ jobs: - name: External Trigger if: github.ref == 'refs/heads/main' run: | - if [ -n "${{ secrets.PAUSE_EXTERNAL_TRIGGER_MASTODON_MAIN }}" ]; then - echo "**** Github secret PAUSE_EXTERNAL_TRIGGER_MASTODON_MAIN is set; skipping trigger. ****" + if [ -n "${{ secrets.PAUSE_EXTERNAL_TRIGGER_HOMETOWN_MAIN }}" ]; then + echo "**** Github secret PAUSE_EXTERNAL_TRIGGER_HOMETOWN_MAIN is set; skipping trigger. ****" exit 0 fi - echo "**** External trigger running off of main branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_MASTODON_MAIN\". ****" + echo "**** External trigger running off of main branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_HOMETOWN_MAIN\". ****" echo "**** Retrieving external version ****" EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/mastodon/mastodon/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 mastodon branch main" - GHA_TRIGGER_URL="https://github.com/linuxserver/docker-mastodon/actions/runs/${{ github.run_id }}" + FAILURE_REASON="Can't retrieve external version for hometown branch main" + GHA_TRIGGER_URL="https://github.com/linuxserver/docker-hometown/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/mastodon" + image="linuxserver/hometown" tag="latest" token=$(curl -sX GET \ - "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fmastodon%3Apull" \ + "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fhometown%3Apull" \ | jq -r '.token') multidigest=$(curl -s \ --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ @@ -58,7 +58,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 mastodon tag latest" + FAILURE_REASON="Can't retrieve last pushed version for hometown 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 }} @@ -68,13 +68,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-mastodon/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then + elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hometown/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-mastodon/job/main/buildWithParameters?PACKAGE_CHECK=false \ + https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hometown/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 ****" @@ -89,7 +89,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 mastodon tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}" + TRIGGER_REASON="A version change was detected for hometown 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 9742e9a..35d1a6e 100644 --- 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: '01 * * * *' + - cron: '03 * * * *' 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-mastodon/${br}/jenkins-vars.yml \ + ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-hometown/${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-mastodon/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then + if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-hometown/${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-mastodon/actions/workflows/external_trigger.yml/dispatches + https://api.github.com/repos/linuxserver/docker-hometown/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 7003e75..2887631 100644 --- 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-mastodon/blob/main/.github/ISSUE_TEMPLATE/issue.bug.yml) or [feature](https://github.com/linuxserver/docker-mastodon/blob/main/.github/ISSUE_TEMPLATE/issue.feature.yml) issue templates!' - pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-mastodon/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-hometown/blob/main/.github/ISSUE_TEMPLATE/issue.bug.yml) or [feature](https://github.com/linuxserver/docker-hometown/blob/main/.github/ISSUE_TEMPLATE/issue.feature.yml) issue templates!' + pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-hometown/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 a5269e9..94598e5 100644 --- a/.github/workflows/package_trigger.yml +++ b/.github/workflows/package_trigger.yml @@ -12,17 +12,17 @@ jobs: - name: Package Trigger if: github.ref == 'refs/heads/main' run: | - if [ -n "${{ secrets.PAUSE_PACKAGE_TRIGGER_MASTODON_MAIN }}" ]; then - echo "**** Github secret PAUSE_PACKAGE_TRIGGER_MASTODON_MAIN is set; skipping trigger. ****" + if [ -n "${{ secrets.PAUSE_PACKAGE_TRIGGER_HOMETOWN_MAIN }}" ]; then + echo "**** Github secret PAUSE_PACKAGE_TRIGGER_HOMETOWN_MAIN is set; skipping trigger. ****" exit 0 fi - if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mastodon/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then + if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hometown/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_MASTODON_MAIN\". ****" + echo "**** Package trigger running off of main branch. To disable, set a Github secret named \"PAUSE_PACKAGE_TRIGGER_HOMETOWN_MAIN\". ****" response=$(curl -iX POST \ - https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mastodon/job/main/buildWithParameters?PACKAGE_CHECK=true \ + https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hometown/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 0180bd7..7a4439e 100644 --- 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: '31 4 * * 3' + - cron: '35 11 * * 0' 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-mastodon/${br}/jenkins-vars.yml \ + ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-hometown/${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-mastodon/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then + if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-hometown/${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-mastodon/actions/workflows/package_trigger.yml/dispatches + https://api.github.com/repos/linuxserver/docker-hometown/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 mastodon** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-mastodon/activity/"' \n"}], + "description": "**Package Check Build(s) Triggered for hometown** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-hometown/activity/"' \n"}], "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} diff --git a/Jenkinsfile b/Jenkinsfile index 6c47714..b355ec3 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -421,18 +421,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/mastodon") | .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/hometown") | .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/mastodon",\ + -d '{"name":"linuxserver/hometown",\ "shortDescription":"example description",\ "libraryType":"docker",\ - "website":"https://github.com/linuxserver/docker-mastodon",\ - "backendUrl":"https://ghcr.io/linuxserver/mastodon",\ - "publicUrl":"https://lscr.io/linuxserver/mastodon"}' || : + "website":"https://github.com/linuxserver/docker-hometown",\ + "backendUrl":"https://ghcr.io/linuxserver/hometown",\ + "publicUrl":"https://lscr.io/linuxserver/hometown"}' || : else echo "Package already exists on Scarf.sh" fi @@ -455,16 +455,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-mastodon/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-mastodon\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-mastodon\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-hometown/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-hometown\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-hometown\" \ --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=Mastodon\" \ - --label \"org.opencontainers.image.description=[Mastodon](https://github.com/mastodon/mastodon/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones.. \" \ + --label \"org.opencontainers.image.title=Hometown\" \ + --label \"org.opencontainers.image.description=[Hometown](https://github.com/hometown-fork/hometown/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones with some extra features.. \" \ --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} ." } @@ -485,16 +485,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-mastodon/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-mastodon\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-mastodon\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-hometown/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-hometown\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-hometown\" \ --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=Mastodon\" \ - --label \"org.opencontainers.image.description=[Mastodon](https://github.com/mastodon/mastodon/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones.. \" \ + --label \"org.opencontainers.image.title=Hometown\" \ + --label \"org.opencontainers.image.description=[Hometown](https://github.com/hometown-fork/hometown/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones with some extra features.. \" \ --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} ." } @@ -512,16 +512,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-mastodon/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-mastodon\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-mastodon\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-hometown/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-hometown\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-hometown\" \ --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=Mastodon\" \ - --label \"org.opencontainers.image.description=[Mastodon](https://github.com/mastodon/mastodon/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones.. \" \ + --label \"org.opencontainers.image.title=Hometown\" \ + --label \"org.opencontainers.image.description=[Hometown](https://github.com/hometown-fork/hometown/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones with some extra features.. \" \ --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}" @@ -546,16 +546,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-mastodon/packages\" \ - --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-mastodon\" \ - --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-mastodon\" \ + --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-hometown/packages\" \ + --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-hometown\" \ + --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-hometown\" \ --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=Mastodon\" \ - --label \"org.opencontainers.image.description=[Mastodon](https://github.com/mastodon/mastodon/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones.. \" \ + --label \"org.opencontainers.image.title=Hometown\" \ + --label \"org.opencontainers.image.description=[Hometown](https://github.com/hometown-fork/hometown/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones with some extra features.. \" \ --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 c9b2ab8..dcc6c0a 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,27 +27,27 @@ 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/mastodon](https://github.com/linuxserver/docker-mastodon) +# [linuxserver/hometown](https://github.com/linuxserver/docker-hometown) -[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fmastodon?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fmastodon) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-mastodon.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-mastodon) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-mastodon.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-mastodon/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-mastodon/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-mastodon/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/mastodon) -[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mastodon.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/mastodon) -[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mastodon.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/mastodon) -[![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-mastodon%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mastodon/job/main/) +[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fhometown?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fhometown) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-hometown.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-hometown) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-hometown.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-hometown/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-hometown/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-hometown/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/hometown) +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hometown.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/hometown) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hometown.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/hometown) +[![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-hometown%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hometown/job/main/) -[Mastodon](https://github.com/mastodon/mastodon/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones.. +[Hometown](https://github.com/hometown-fork/hometown/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones with some extra features.. -[![mastodon](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/mastodon-banner.png)](https://github.com/mastodon/mastodon/) +[![hometown](https://camo.githubusercontent.com/1affcf58842d9b19a69f38caf783156b0003fa80e3e532cd418df4e1215c70af/68747470733a2f2f6c6976652e737461746963666c69636b722e636f6d2f373030352f32363737373333393034325f623332636566346531665f622e6a7067)](https://github.com/hometown-fork/hometown/) ## Supported Architectures 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/mastodon:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. +Simply pulling `lscr.io/linuxserver/hometown:latest` 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: @@ -94,9 +94,9 @@ Here are some example snippets to help you get started creating a container. --- version: "2.1" services: - mastodon: - image: lscr.io/linuxserver/mastodon:latest - container_name: mastodon + hometown: + image: lscr.io/linuxserver/hometown:latest + container_name: hometown environment: - PUID=1000 - PGID=1000 @@ -129,6 +129,8 @@ services: - AWS_ACCESS_KEY_ID= #optional - AWS_SECRET_ACCESS_KEY= #optional - S3_ALIAS_HOST= #optional + - WEB_CONCURRENCY=2 #optional + - MAX_THREADS=5 #optional volumes: - /path/to/appdata/config:/config ports: @@ -141,7 +143,7 @@ services: ```bash docker run -d \ - --name=mastodon \ + --name=hometown \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=America/New_York \ @@ -173,11 +175,13 @@ docker run -d \ -e AWS_ACCESS_KEY_ID= `#optional` \ -e AWS_SECRET_ACCESS_KEY= `#optional` \ -e S3_ALIAS_HOST= `#optional` \ + -e WEB_CONCURRENCY=2 `#optional` \ + -e MAX_THREADS=5 `#optional` \ -p 80:80 \ -p 443:443 \ -v /path/to/appdata/config:/config \ --restart unless-stopped \ - lscr.io/linuxserver/mastodon:latest + lscr.io/linuxserver/hometown:latest ``` ## Parameters @@ -219,6 +223,8 @@ Container images are configured using parameters passed at runtime (such as thos | `-e AWS_ACCESS_KEY_ID=` | S3 bucket access key ID | | `-e AWS_SECRET_ACCESS_KEY=` | S3 bucket secret access key | | `-e S3_ALIAS_HOST=` | Alternate hostname for object fetching if you are front the S3 connections. | +| `-e WEB_CONCURRENCY=2` | Specific to Puma, this variable determines how many different processes Puma forks into. Defaults to `2`. | +| `-e MAX_THREADS=5` | Specific to Puma, this variable determines how many threads each Puma process maintains. Defaults to `5`. | | `-v /config` | Contains all relevant configuration files. | ## Environment variables from files (Docker secrets) @@ -253,18 +259,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=mastodon&query=%24.mods%5B%27mastodon%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=mastodon "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=hometown&query=%24.mods%5B%27hometown%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=hometown "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 mastodon /bin/bash` -* To monitor the logs of the container in realtime: `docker logs -f mastodon` +* Shell access whilst the container is running: `docker exec -it hometown /bin/bash` +* To monitor the logs of the container in realtime: `docker logs -f hometown` * container version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' mastodon` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' hometown` * image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mastodon:latest` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hometown:latest` ## Updating Info @@ -275,16 +281,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 mastodon` + * or update a single image: `docker-compose pull hometown` * Let compose update all containers as necessary: `docker-compose up -d` - * or update a single container: `docker-compose up -d mastodon` + * or update a single container: `docker-compose up -d hometown` * You can also remove the old dangling images: `docker image prune` ### Via Docker Run -* Update the image: `docker pull lscr.io/linuxserver/mastodon:latest` -* Stop the running container: `docker stop mastodon` -* Delete the container: `docker rm mastodon` +* Update the image: `docker pull lscr.io/linuxserver/hometown:latest` +* Stop the running container: `docker stop hometown` +* Delete the container: `docker rm hometown` * 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` @@ -296,7 +302,7 @@ Below are the instructions for updating containers: docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ - --run-once mastodon + --run-once hometown ``` * You can also remove the old dangling images: `docker image prune` @@ -312,12 +318,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-mastodon.git -cd docker-mastodon +git clone https://github.com/linuxserver/docker-hometown.git +cd docker-hometown docker build \ --no-cache \ --pull \ - -t lscr.io/linuxserver/mastodon:latest . + -t lscr.io/linuxserver/hometown: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 8e506ca..f6825ef 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -60,7 +60,7 @@ opt_param_env_vars: - { env_var: "AWS_SECRET_ACCESS_KEY", env_value: "", desc: "S3 bucket secret access key"} - { env_var: "S3_ALIAS_HOST", env_value: "", desc: "Alternate hostname for object fetching if you are front the S3 connections."} - { env_var: "WEB_CONCURRENCY", env_value: "2", desc: "Specific to Puma, this variable determines how many different processes Puma forks into. Defaults to `2`."} - - { env_var: "MAX_THREADS", env_value: "5", desc: "Specific to Puma, this variable determines how many threads each Puma process maintains. Defaults to `5`." + - { env_var: "MAX_THREADS", env_value: "5", desc: "Specific to Puma, this variable determines how many threads each Puma process maintains. Defaults to `5`."} param_usage_include_ports: true param_ports: - { external_port: "80", internal_port: "80", port_desc: "Port for web frontend" }