[ { "path": ".all-contributorsrc", "content": "{\n \"projectName\": \"homepage\",\n \"projectOwner\": \"benphelps\",\n \"files\": [\n \"README.md\"\n ],\n \"imageSize\": 100,\n \"contributors\": []\n}\n" }, { "path": ".codecov.yml", "content": "codecov:\n require_ci_to_pass: true\n\ncoverage:\n precision: 2\n round: down\n range: \"0...100\"\n status:\n project:\n default:\n target: 100%\n threshold: 15%\n patch:\n default:\n target: 100%\n threshold: 10%\n\ncomment:\n layout: \"reach,diff,flags,files\"\n behavior: default\n require_changes: false\n" }, { "path": ".devcontainer/Dockerfile", "content": "ARG VARIANT=\"16-buster\"\nFROM mcr.microsoft.com/vscode/devcontainers/javascript-node:${VARIANT}\n\nRUN npm install -g pnpm\n\nRUN apt-get update \\\n && apt-get -y install --no-install-recommends \\\n python3-pip \\\n && apt-get clean -y \\\n && rm -rf /var/lib/apt/lists/*\n\nENV PATH=\"${PATH}:./node_modules/.bin\"\n" }, { "path": ".devcontainer/devcontainer.json", "content": "{\n \"name\": \"homepage\",\n \"build\": {\n \"dockerfile\": \"Dockerfile\",\n \"args\": {\n \"VARIANT\": \"18-bullseye\",\n },\n },\n \"customizations\": {\n \"vscode\": {\n \"extensions\": [\n \"dbaeumer.vscode-eslint\",\n \"mhutchie.git-graph\",\n \"streetsidesoftware.code-spell-checker\",\n \"esbenp.prettier-vscode\",\n ],\n \"settings\": {\n \"eslint.format.enable\": true,\n \"eslint.lintTask.enable\": true,\n \"eslint.packageManager\": \"pnpm\",\n },\n },\n },\n \"postCreateCommand\": \".devcontainer/setup.sh\",\n \"forwardPorts\": [3000],\n}\n" }, { "path": ".devcontainer/setup.sh", "content": "#!/usr/bin/env bash\n\n# Install Node packages\npnpm install\n\npython3 -m pip install -r requirements.txt\n\n# Copy in skeleton configuration if there is no existing configuration\nif [ ! -d \"config/\" ]; then\n echo \"Adding skeleton config\"\n mkdir config/\n cp -r src/skeleton/* config\nfi\n" }, { "path": ".dockerignore", "content": "**/.classpath\n**/.dockerignore\n**/.env\n**/.git\n**/.gitignore\n**/.project\n**/.settings\n**/.toolstarget\n**/.vs\n**/.vscode\n**/*.*proj.user\n**/*.dbmdl\n**/*.jfm\n**/charts\n**/docker-compose*\n**/compose*\n**/Dockerfile*\n**/node_modules\n!.next/standalone/node_modules\n**/npm-debug.log\n**/obj\n**/secrets.dev.yaml\n**/values.dev.yaml\nREADME.md\nconfig/\nk3d/\n" }, { "path": ".editorconfig", "content": "# EditorConfig is awesome: https://EditorConfig.org\n\n# top-most EditorConfig file\nroot = true\n\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\nmax_line_length = 120\n\n[*.md]\ntrim_trailing_whitespace = false\n" }, { "path": ".github/DISCUSSION_TEMPLATE/feature-requests.yml", "content": "title: \"[Feature Request] \"\nlabels: [\"enhancement\"]\nbody:\n - type: markdown\n attributes:\n value: |\n #### ⚠️ Don't forget to search [existing issues](https://github.com/gethomepage/homepage/search?q=&type=issues) and [discussions](https://github.com/gethomepage/homepage/search?q=&type=discussions) (including closed ones!).\n - type: textarea\n id: description\n attributes:\n label: Description\n description: A clear and concise description of what you would like to see.\n validations:\n required: true\n - type: textarea\n id: other\n attributes:\n label: Other\n description: Add any other context or information about the feature request here.\n" }, { "path": ".github/DISCUSSION_TEMPLATE/support.yml", "content": "body:\n - type: markdown\n attributes:\n value: |\n ### ⚠️ Before opening a discussion:\n\n - [Check the troubleshooting guide](https://gethomepage.dev/troubleshooting/) and include the output of all steps below.\n - [Search existing issues](https://github.com/gethomepage/homepage/search?q=&type=issues) [and discussions](https://github.com/gethomepage/homepage/search?q=&type=discussions) (including closed ones!).\n - type: textarea\n id: description\n attributes:\n label: Description\n description: A clear and concise description of the issue or question. If applicable, add screenshots to help explain your problem.\n validations:\n required: true\n - type: input\n id: version\n attributes:\n label: homepage version\n placeholder: e.g. v0.4.18 (4ea2798)\n validations:\n required: true\n - type: dropdown\n id: install-method\n attributes:\n label: Installation method\n options:\n - Docker\n - Unraid\n - Source\n - Other (please describe above)\n validations:\n required: true\n - type: textarea\n id: config\n attributes:\n label: Configuration\n description: Please provide any relevant service, widget or otherwise related configuration here\n render: yaml\n - type: textarea\n id: container-logs\n attributes:\n label: Container Logs\n description: Please review and provide any logs from the container, if relevant\n - type: textarea\n id: browser-logs\n attributes:\n label: Browser Logs\n description: Please review and provide any logs from the browser, if relevant\n - type: textarea\n id: troubleshooting\n attributes:\n label: Troubleshooting\n description: Please include output from your [troubleshooting steps](https://gethomepage.dev/troubleshooting/#service-widget-errors), if relevant.\n validations:\n required: true\n - type: markdown\n attributes:\n value: |\n ## ⚠️ STOP ⚠️\n\n Before you submit this support request, please ensure you have entered your configuration files and actually followed the steps from the troubleshooting guide linked above *and posted the output*, if relevant. The troubleshooting steps often help to solve the problem or at least can help figure it out.\n\n *Please remember that this project is maintained by regular people **just like you**, so if you don't take the time to fill out the requested information, don't expect a reply back.*\n" }, { "path": ".github/FUNDING.yml", "content": "github: [gethomepage]\nopen_collective: homepage\npatreon: gethomepage\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: 🐛 Bug report\ndescription: Please only raise an issue if you've been advised to do so in a GitHub discussion. Thanks! 🙏\nlabels: [\"bug\"]\nbody:\n - type: markdown\n attributes:\n value: |\n ## ⚠️ Please note\n The starting point for a bug report should always be a [GitHub discussion](https://github.com/gethomepage/homepage/discussions/new?category=support)\n Thank you for contributing to homepage! ✊\n - type: checkboxes\n id: pre-flight\n attributes:\n label: Before submitting, please confirm the following\n options:\n - label: I confirm this was discussed, and the maintainers asked that I open an issue.\n required: true\n - label: I am aware that if I create this issue without a discussion, it will be removed without a response.\n required: true\n - type: input\n id: discussion\n attributes:\n label: Discussion Link\n description: |\n Please link to the GitHub discussion that led to this issue.\n validations:\n required: true\n - type: textarea\n id: additional\n attributes:\n label: Additional context\n description: Optional\n render: Text\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: 🤔 Questions and Help\n url: https://github.com/gethomepage/homepage/discussions\n about: For support, possible bug reports or general questions.\n - name: 💬 Chat\n url: https://discord.gg/k4ruYNrudu\n about: Want to discuss homepage with others? Check out our chat.\n - name: 🚀 Feature Request\n url: https://github.com/gethomepage/homepage/discussions/new?category=feature-requests\n about: Remember to search for existing feature requests and \"up-vote\" any you like\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "\n\n## Proposed change\n\n\n\nCloses # (issue)\n\n## Type of change\n\n\n\n- [ ] New service widget\n- [ ] Bug fix (non-breaking change which fixes an issue)\n- [ ] New feature or enhancement (non-breaking change which adds functionality)\n- [ ] Documentation only\n- [ ] Other (please explain)\n\n## Checklist:\n\n- [ ] If applicable, I have added corresponding documentation changes.\n- [ ] If applicable, I have added or updated tests for new features and bug fixes (see [testing](https://gethomepage.dev/widgets/authoring/getting-started/#testing)).\n- [ ] If applicable, I have reviewed the [feature / enhancement](https://gethomepage.dev/widgets/authoring/getting-started/#new-feature-guidelines) and / or [service widget guidelines](https://gethomepage.dev/widgets/authoring/getting-started/#service-widget-guidelines).\n- [ ] I have checked that all code style checks pass using [pre-commit hooks](https://gethomepage.dev/widgets/authoring/getting-started/#code-formatting-with-pre-commit-hooks) and [linting checks](https://gethomepage.dev/widgets/authoring/getting-started/#code-linting).\n- [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.\n- [ ] In the description above I have disclosed the use of AI tools in the coding of this PR.\n" }, { "path": ".github/dependabot.yml", "content": "# To get started with Dependabot version updates, you'll need to specify which\n# package ecosystems to update and where the package manifests are located.\n# Please see the documentation for all configuration options:\n# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates\n\nversion: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n cooldown:\n default-days: 7\n - package-ecosystem: \"npm\"\n directory: \"/\"\n schedule:\n interval: \"monthly\"\n cooldown:\n default-days: 7\n" }, { "path": ".github/release-drafter.yml", "content": "name-template: 'v$RESOLVED_VERSION'\ntag-template: 'v$RESOLVED_VERSION'\nchange-template: '- $TITLE (#$NUMBER) @$AUTHOR'\nchange-title-escapes: '\\\\<*_&'\n\nversion-resolver:\n major:\n labels:\n - 'major'\n - 'breaking-change'\n minor:\n labels:\n - 'enhancement'\n - 'feature'\n patch:\n labels:\n - 'bug'\n - 'fix'\n - 'dependencies'\n - 'translation'\n - 'documentation'\n default: patch\n\ncategories:\n - title: '⚠️ Breaking Changes'\n labels:\n - 'major'\n - 'breaking-change'\n - title: '🚀 Features'\n labels:\n - 'enhancement'\n - 'feature'\n - title: '🐛 Fixes'\n labels:\n - 'bug'\n - 'fix'\n - title: '🧰 Maintenance'\n labels:\n - 'dependencies'\n - 'ci'\n - 'chore'\n - title: '🌐 Translations'\n labels:\n - 'translation'\n - title: '📚 Documentation'\n labels:\n - 'documentation'\n\nautolabeler:\n - label: 'documentation'\n files:\n - 'docs/**'\n - '*.md'\n - '.github/**/*.md'\n\n - label: 'ci'\n files:\n - '.github/workflows/**'\n\n - label: 'dependencies'\n files:\n - 'package.json'\n - 'pnpm-lock.yaml'\n - 'pyproject.toml'\n - 'uv.lock'\n\n - label: 'feature'\n files:\n - 'src/components/**'\n - 'src/widgets/**'\n - 'src/pages/**'\n - 'src/utils/**'\n\n - label: 'chore'\n files:\n - 'Dockerfile*'\n - 'docker-entrypoint.sh'\n - 'k3d/**'\n\n - label: 'translation'\n files:\n - 'public/locales/**'\n\ntemplate: |\n ## What's Changed\n\n $CHANGES\n" }, { "path": ".github/workflows/crowdin.yml", "content": "name: Crowdin Action\n\non:\n workflow_dispatch:\n schedule:\n - cron: '2 */12 * * *'\n push:\n paths: [\n '/public/locales/en/**',\n ]\n branches: [ dev ]\n\njobs:\n synchronize-with-crowdin:\n name: Crowdin Sync\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n - name: crowdin action\n uses: crowdin/github-action@v2\n with:\n upload_translations: false\n download_translations: true\n crowdin_branch_name: dev\n localization_branch_name: l10n_dev\n pull_request_labels: translation\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}\n CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}\n" }, { "path": ".github/workflows/docker-publish.yml", "content": "name: Docker CI\n\non:\n schedule:\n - cron: '20 0 * * *'\n push:\n branches:\n - main\n - feature/**\n - dev\n tags: [ 'v*.*.*' ]\n pull_request:\n branches: [ \"dev\" ]\n merge_group:\n\nenv:\n IMAGE_NAME: ${{ github.repository }}\n\njobs:\n pre-commit:\n name: Linting Checks\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n\n - name: Install python\n uses: actions/setup-python@v6\n with:\n python-version: 3.x\n\n - name: Check files\n uses: pre-commit/action@v3.0.1\n\n - name: Install pnpm\n uses: pnpm/action-setup@v5\n with:\n version: 10\n run_install: false\n\n - name: Setup Node.js\n uses: actions/setup-node@v6\n with:\n node-version: 24\n cache: 'pnpm'\n\n - name: Install dependencies\n run: pnpm install\n\n - name: Lint frontend\n run: pnpm run lint\n\n build:\n name: Docker Build & Push\n if: github.repository == 'gethomepage/homepage'\n runs-on: self-hosted\n needs: [ pre-commit ]\n permissions:\n contents: read\n packages: write\n id-token: write\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n\n - name: Extract Docker metadata\n id: meta\n uses: docker/metadata-action@v6\n with:\n images: |\n ${{ env.IMAGE_NAME }}\n ghcr.io/${{ env.IMAGE_NAME }}\n tags: |\n # Default tags\n type=schedule,pattern=nightly\n type=ref,event=branch\n type=ref,event=tag\n # Versioning tags\n type=semver,pattern=v{{version}}\n type=semver,pattern=v{{major}}.{{minor}}\n type=semver,pattern=v{{major}}\n flavor: |\n latest=auto\n\n - name: Next.js build cache\n uses: actions/cache@v5\n with:\n path: .next/cache\n key: nextjs-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}-${{ hashFiles('**/*.js', '**/*.jsx') }}\n restore-keys: |\n nextjs-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}\n\n - name: Install pnpm\n uses: pnpm/action-setup@v5\n with:\n version: 10\n run_install: false\n\n - name: Setup Node.js\n uses: actions/setup-node@v6\n with:\n node-version: 24\n cache: 'pnpm'\n\n - name: Install dependencies\n run: pnpm install\n\n - name: Build app\n run: |\n NEXT_PUBLIC_BUILDTIME=\"${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}\" \\\n NEXT_PUBLIC_VERSION=\"${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}\" \\\n NEXT_PUBLIC_REVISION=\"${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }}\" \\\n pnpm run build\n\n - name: Log into registry ${{ env.REGISTRY }}\n if: github.event_name != 'pull_request'\n uses: docker/login-action@v4\n with:\n registry: ghcr.io\n username: ${{ github.actor }}\n password: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Login to Docker Hub\n if: github.event_name != 'pull_request'\n uses: docker/login-action@v4\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n - name: Setup QEMU\n uses: docker/setup-qemu-action@v4.0.0\n\n - name: Setup Docker buildx\n uses: docker/setup-buildx-action@v4\n\n - name: Build and push Docker image\n id: build-and-push\n uses: docker/build-push-action@v7\n with:\n context: .\n push: ${{ github.event_name != 'pull_request' }}\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n build-args: |\n CI=true\n BUILDTIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}\n VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}\n REVISION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }}\n platforms: linux/amd64,linux/arm64\n provenance: false\n cache-from: type=local,src=/tmp/.buildx-cache\n cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max\n\n # https://github.com/docker/build-push-action/issues/252 / https://github.com/moby/buildkit/issues/1896\n - name: Move cache\n run: |\n rm -rf /tmp/.buildx-cache\n mv /tmp/.buildx-cache-new /tmp/.buildx-cache\n" }, { "path": ".github/workflows/docs-publish.yml", "content": "name: Docs\n\non:\n push:\n tags: [\"v*.*.*\"]\n branches: [\"main\"]\n pull_request:\n merge_group:\n workflow_dispatch:\n\npermissions:\n contents: read\n pages: write\n id-token: write\n\njobs:\n pre-commit:\n name: Linting Checks\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install python\n uses: actions/setup-python@v6\n with:\n python-version: 3.x\n - name: Check files\n uses: pre-commit/action@v3.0.1\n\n test:\n name: Test Build Docs\n if: github.repository == 'gethomepage/homepage' && github.event_name == 'pull_request'\n runs-on: ubuntu-latest\n needs:\n - pre-commit\n steps:\n - uses: actions/checkout@v6\n - uses: actions/setup-python@v6\n with:\n python-version-file: \".python-version\"\n - name: Install uv\n uses: astral-sh/setup-uv@v7\n - run: sudo apt-get install pngquant\n - name: Test Docs Build\n run: uv run --frozen zensical build --clean\n deploy:\n name: Build & Deploy Docs\n if: github.repository == 'gethomepage/homepage' && github.event_name != 'pull_request' && github.ref == 'refs/heads/main'\n runs-on: ubuntu-latest\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n needs:\n - pre-commit\n steps:\n - uses: actions/configure-pages@v5\n - uses: actions/checkout@v6\n - uses: actions/setup-python@v6\n with:\n python-version-file: \".python-version\"\n - name: Install uv\n uses: astral-sh/setup-uv@v7\n - run: sudo apt-get install pngquant\n - name: Build Docs\n run: uv run --frozen zensical build --clean\n - uses: actions/upload-pages-artifact@v4\n with:\n path: site\n - uses: actions/deploy-pages@v4\n id: deployment\n" }, { "path": ".github/workflows/pr-quality.yml", "content": "name: PR Quality\n\npermissions:\n contents: read\n issues: read\n pull-requests: write\n\non:\n pull_request_target:\n types: [opened, reopened]\n\njobs:\n anti-slop:\n runs-on: ubuntu-latest\n steps:\n - uses: peakoss/anti-slop@v0\n with:\n max-failures: 4\n" }, { "path": ".github/workflows/reaction-comments.yml", "content": "name: 'Reaction Comments'\n\non:\n issue_comment:\n types: [created, edited]\n pull_request_review_comment:\n types: [created, edited]\n\npermissions:\n actions: write\n issues: write\n pull-requests: write\n\njobs:\n action:\n runs-on: ubuntu-latest\n steps:\n - uses: dessant/reaction-comments@v4\n" }, { "path": ".github/workflows/release-drafter.yml", "content": "name: Release Drafter\n\non:\n push:\n branches:\n - dev\n pull_request_target:\n types: [opened, reopened, synchronize]\n workflow_dispatch:\n inputs:\n version:\n description: \"Optional explicit version override (for example: 2.0.0)\"\n required: false\n type: string\n\npermissions:\n contents: read\n\njobs:\n update_release_draft:\n name: Update Release Draft\n if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'\n permissions:\n contents: write\n pull-requests: read\n runs-on: ubuntu-latest\n steps:\n - if: github.event_name == 'workflow_dispatch' && github.event.inputs.version != ''\n uses: release-drafter/release-drafter@v7\n with:\n config-name: release-drafter.yml\n version: ${{ github.event.inputs.version }}\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - if: github.event_name != 'workflow_dispatch' || github.event.inputs.version == ''\n uses: release-drafter/release-drafter@v7\n with:\n config-name: release-drafter.yml\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n auto_label:\n name: Auto Label PR\n if: github.event_name == 'pull_request_target'\n permissions:\n contents: read\n pull-requests: write\n runs-on: ubuntu-latest\n steps:\n - uses: release-drafter/release-drafter/autolabeler@ebb69bb56f1b0ebd19897745035726b19bef973e\n with:\n config-name: release-drafter.yml\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/repo-maintenance.yml", "content": "name: 'Repository Maintenance'\n\non:\n schedule:\n - cron: '0 3 * * *'\n workflow_dispatch:\n\npermissions:\n issues: write\n pull-requests: write\n discussions: write\n\nconcurrency:\n group: lock\n\njobs:\n stale:\n name: 'Stale'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/stale@v10\n with:\n days-before-stale: 7\n days-before-close: 14\n stale-issue-label: stale\n stale-pr-label: stale\n stale-issue-message: >\n This issue has been automatically marked as stale because it has not had\n recent activity. It will be closed if no further activity occurs. Thank you\n for your contributions. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-respoistory-maintenance) for more details.\n lock-threads:\n name: 'Lock Old Threads'\n runs-on: ubuntu-latest\n steps:\n - uses: dessant/lock-threads@v6\n with:\n issue-inactive-days: '30'\n pr-inactive-days: '30'\n discussion-inactive-days: '30'\n log-output: true\n issue-comment: >\n This issue has been automatically locked since there\n has not been any recent activity after it was closed.\n Please open a new discussion for related concerns.\n See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.\n pr-comment: >\n This pull request has been automatically locked since there\n has not been any recent activity after it was closed.\n Please open a new discussion for related concerns.\n See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.\n discussion-comment: >\n This discussion has been automatically locked since there\n has not been any recent activity after it was closed.\n Please open a new discussion for related concerns.\n See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.\n close-answered-discussions:\n name: 'Close Answered Discussions'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/github-script@v8\n with:\n script: |\n function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n }\n\n const query = `query($owner:String!, $name:String!) {\n repository(owner:$owner, name:$name){\n discussions(first:100, answered:true, states:[OPEN]) {\n nodes {\n id,\n number\n }\n }\n }\n }`;\n const variables = {\n owner: context.repo.owner,\n name: context.repo.repo,\n }\n const result = await github.graphql(query, variables)\n\n console.log(`Found ${result.repository.discussions.nodes.length} open answered discussions`)\n\n for (const discussion of result.repository.discussions.nodes) {\n console.log(`Closing discussion #${discussion.number} (${discussion.id})`)\n\n const addCommentMutation = `mutation($discussion:ID!, $body:String!) {\n addDiscussionComment(input:{discussionId:$discussion, body:$body}) {\n clientMutationId\n }\n }`;\n const commentVariables = {\n discussion: discussion.id,\n body: 'This discussion has been automatically closed because it was marked as answered. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.',\n }\n await github.graphql(addCommentMutation, commentVariables)\n\n const closeDiscussionMutation = `mutation($discussion:ID!, $reason:DiscussionCloseReason!) {\n closeDiscussion(input:{discussionId:$discussion, reason:$reason}) {\n clientMutationId\n }\n }`;\n const closeVariables = {\n discussion: discussion.id,\n reason: \"RESOLVED\",\n }\n await github.graphql(closeDiscussionMutation, closeVariables)\n\n await sleep(1000)\n }\n close-outdated-discussions:\n name: 'Close Outdated Discussions'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/github-script@v8\n with:\n script: |\n function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n }\n\n const CUTOFF_DAYS = 180;\n const cutoff = new Date();\n cutoff.setDate(cutoff.getDate() - CUTOFF_DAYS);\n\n const query = `query(\n $owner:String!,\n $name:String!,\n $supportCategory:ID!,\n $generalCategory:ID!,\n ) {\n supportDiscussions: repository(owner:$owner, name:$name){\n discussions(\n categoryId:$supportCategory,\n last:50,\n answered:false,\n states:[OPEN],\n ) {\n nodes {\n id,\n number,\n updatedAt\n }\n },\n },\n generalDiscussions: repository(owner:$owner, name:$name){\n discussions(\n categoryId:$generalCategory,\n last:50,\n states:[OPEN],\n ) {\n nodes {\n id,\n number,\n updatedAt\n }\n }\n }\n }`;\n const variables = {\n owner: context.repo.owner,\n name: context.repo.repo,\n supportCategory: \"DIC_kwDOH31rQM4CRErR\",\n generalCategory: \"DIC_kwDOH31rQM4CRErQ\"\n }\n const result = await github.graphql(query, variables);\n const combinedDiscussions = [\n ...result.supportDiscussions.discussions.nodes,\n ...result.generalDiscussions.discussions.nodes,\n ]\n\n console.log(`Checking ${combinedDiscussions.length} open discussions`);\n\n for (const discussion of combinedDiscussions) {\n if (new Date(discussion.updatedAt) < cutoff) {\n console.log(`Closing outdated discussion #${discussion.number} (${discussion.id}), last updated at ${discussion.updatedAt}`);\n const addCommentMutation = `mutation($discussion:ID!, $body:String!) {\n addDiscussionComment(input:{discussionId:$discussion, body:$body}) {\n clientMutationId\n }\n }`;\n const commentVariables = {\n discussion: discussion.id,\n body: 'This discussion has been automatically closed due to inactivity. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.',\n }\n await github.graphql(addCommentMutation, commentVariables);\n\n const closeDiscussionMutation = `mutation($discussion:ID!, $reason:DiscussionCloseReason!) {\n closeDiscussion(input:{discussionId:$discussion, reason:$reason}) {\n clientMutationId\n }\n }`;\n const closeVariables = {\n discussion: discussion.id,\n reason: \"OUTDATED\",\n }\n await github.graphql(closeDiscussionMutation, closeVariables);\n\n await sleep(1000);\n }\n }\n close-unsupported-feature-requests:\n name: 'Close Unsupported Feature Requests'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/github-script@v8\n with:\n script: |\n function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n }\n\n const CUTOFF_1_DAYS = 180;\n const CUTOFF_1_COUNT = 20;\n const CUTOFF_2_DAYS = 365;\n const CUTOFF_2_COUNT = 40;\n\n const cutoff1Date = new Date();\n cutoff1Date.setDate(cutoff1Date.getDate() - CUTOFF_1_DAYS);\n const cutoff2Date = new Date();\n cutoff2Date.setDate(cutoff2Date.getDate() - CUTOFF_2_DAYS);\n\n const query = `query(\n $owner:String!,\n $name:String!,\n $featureRequestsCategory:ID!,\n ) {\n repository(owner:$owner, name:$name){\n discussions(\n categoryId:$featureRequestsCategory,\n last:100,\n states:[OPEN],\n ) {\n nodes {\n id,\n number,\n updatedAt,\n upvoteCount,\n }\n },\n }\n }`;\n const variables = {\n owner: context.repo.owner,\n name: context.repo.repo,\n featureRequestsCategory: \"DIC_kwDOH31rQM4CRErS\"\n }\n const result = await github.graphql(query, variables);\n\n for (const discussion of result.repository.discussions.nodes) {\n const discussionDate = new Date(discussion.updatedAt);\n if ((discussionDate < cutoff1Date && discussion.upvoteCount < CUTOFF_1_COUNT) ||\n (discussionDate < cutoff2Date && discussion.upvoteCount < CUTOFF_2_COUNT)) {\n console.log(`Closing discussion #${discussion.number} (${discussion.id}), last updated at ${discussion.updatedAt} with votes ${discussion.upvoteCount}`);\n const addCommentMutation = `mutation($discussion:ID!, $body:String!) {\n addDiscussionComment(input:{discussionId:$discussion, body:$body}) {\n clientMutationId\n }\n }`;\n const commentVariables = {\n discussion: discussion.id,\n body: 'This discussion has been automatically closed due to lack of community support. See our [contributing guidelines](https://github.com/gethomepage/homepage/blob/main/CONTRIBUTING.md#automatic-repository-maintenance) for more details.',\n }\n await github.graphql(addCommentMutation, commentVariables);\n\n const closeDiscussionMutation = `mutation($discussion:ID!, $reason:DiscussionCloseReason!) {\n closeDiscussion(input:{discussionId:$discussion, reason:$reason}) {\n clientMutationId\n }\n }`;\n const closeVariables = {\n discussion: discussion.id,\n reason: \"OUTDATED\",\n }\n await github.graphql(closeDiscussionMutation, closeVariables);\n\n await sleep(1000);\n }\n }\n" }, { "path": ".github/workflows/test.yml", "content": "name: Tests\n\non:\n pull_request:\n push:\n workflow_dispatch:\n\njobs:\n vitest:\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n shard: [1, 2, 3, 4]\n steps:\n - uses: actions/checkout@v6\n\n - uses: pnpm/action-setup@v5\n with:\n version: 9\n\n - uses: actions/setup-node@v6\n with:\n node-version: 20\n cache: pnpm\n\n - run: pnpm install --frozen-lockfile\n # Run Vitest directly so `--shard` is parsed as an option\n - run: pnpm -s exec vitest run --coverage --shard ${{ matrix.shard }}/4 --pool forks\n - name: Upload coverage reports to Codecov\n uses: codecov/codecov-action@v5\n with:\n token: ${{ secrets.CODECOV_TOKEN }}\n files: ./coverage/lcov.info\n flags: vitest,shard-${{ matrix.shard }}\n name: vitest-shard-${{ matrix.shard }}\n fail_ci_if_error: true\n" }, { "path": ".gitignore", "content": "# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.\n\n# dependencies\n/node_modules\n/.pnp\n.pnp.js\n.pnpm-store\n\n# testing\n/coverage\n\n# next.js\n/.next/\n/out/\n\n# production\n/build\n\n# misc\n.DS_Store\n*.pem\n\n# log files\nerror.log\nhomepage.log\n\n# debug\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n.pnpm-debug.log*\n\n# local env files\n.env*.local\n\n# vercel\n.vercel\n\n# typescript\n*.tsbuildinfo\nnext-env.d.ts\n\n# homepage\n/config\n\n# IDEs\n/.idea/\n\n# Zensical documentation\nsite*/\n.cache/\n\n# venv\n.venv/\n" }, { "path": ".pre-commit-config.yaml", "content": "# See https://pre-commit.com for more information\n# See https://pre-commit.com/hooks.html for more hooks\nrepos:\n- repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v3.2.0\n hooks:\n - id: trailing-whitespace\n - id: end-of-file-fixer\n - id: check-yaml\n exclude: \"(^mkdocs\\\\.yml$)\"\n - id: check-added-large-files\n- repo: https://github.com/rbubley/mirrors-prettier\n rev: 'v3.3.3'\n hooks:\n - id: prettier\n types_or:\n - javascript\n - markdown\n - jsx\n additional_dependencies:\n - prettier@3.3.3\n - 'prettier-plugin-organize-imports@4.1.0'\n" }, { "path": ".prettierrc.js", "content": "const config = {\n plugins: [require(\"prettier-plugin-organize-imports\")],\n};\n\nmodule.exports = config;\n" }, { "path": ".python-version", "content": "3.13\n" }, { "path": ".vscode/launch.json", "content": "{\n \"configurations\": [\n {\n \"name\": \"Debug homepage\",\n \"type\": \"node\",\n \"preLaunchTask\": \"pnpm install\",\n \"request\": \"launch\",\n \"runtimeExecutable\": \"pnpm\",\n \"runtimeArgs\": [\"run\", \"dev\"],\n \"env\": {\n \"LOG_LEVEL\": \"debug\"\n },\n \"skipFiles\": [\"/**\"],\n \"console\": \"integratedTerminal\",\n \"serverReadyAction\":{\n \"pattern\": \".*http://localhost:3000.*\",\n \"action\": \"startDebugging\",\n \"name\": \"Launch Chromium\",\n \"killOnServerStop\": true,\n }\n },\n {\n \"name\": \"Launch Chromium\",\n \"type\": \"chrome\",\n \"request\": \"launch\",\n \"url\": \"http://localhost:3000\",\n \"urlFilter\": \"http://localhost:3000\",\n \"webRoot\": \"${workspaceFolder}\",\n \"trace\": true\n }\n ]\n}\n" }, { "path": ".vscode/settings.json", "content": "{\n \"files.exclude\": {\n \"**/.next\": true,\n \"**/node_modules\": true\n },\n \"yaml.schemas\": {\n \"https://squidfunk.github.io/mkdocs-material/schema.json\": \"mkdocs.yml\"\n },\n \"yaml.customTags\": [\n \"!ENV scalar\",\n \"!ENV sequence\",\n \"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg\",\n \"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji\",\n \"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format\"\n ],\n \"[python]\": {\n \"editor.defaultFormatter\": \"ms-python.autopep8\"\n },\n}\n" }, { "path": ".vscode/tasks.json", "content": "{\n\t\"version\": \"2.0.0\",\n\t\"tasks\": [\n\t\t{\n\t\t\t\"type\": \"shell\",\n\t\t\t\"label\": \"pnpm install\",\n \"command\": \"pnpm install\",\n \"group\": {\n \"kind\": \"build\",\n \"isDefault\": true\n },\n \"presentation\": {\n \"clear\": true,\n \"panel\": \"shared\",\n \"showReuseMessage\": false\n },\n \"problemMatcher\": []\n\n\t\t}\n\t]\n}\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n- Demonstrating empathy and kindness toward other people\n- Being respectful of differing opinions, viewpoints, and experiences\n- Giving and gracefully accepting constructive feedback\n- Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n- Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n- The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n- Trolling, insulting or derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or email\n address, without their explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nben@phelps.io.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to Homepage\n\nWe love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:\n\n- Reporting a bug\n- Discussing the current state of the project\n- Submitting a fix\n- Proposing new features\n- Becoming a maintainer\n\n## We Develop with Github\n\nWe use github to host code, to track issues and feature requests, as well as accept pull requests.\n\n## Any contributions you make will be under the GNU General Public License v3.0\n\nIn short, when you submit code changes, your submissions are understood to be under the same [GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern.\n\n## Report bugs using Github [discussions](https://github.com/gethomepage/homepage/discussions)\n\nWe use GitHub discussions to triage bugs. Report a bug by [opening a new discussion](https://github.com/gethomepage/homepage/discussions/new?category=support); it's that easy! Please do not open an issue unless instructed to do so by a project maintainer.\n\n## Write bug reports with detail, background, and sample configurations\n\nHomepage includes a lot of configuration options and is often deploying in larger systems. Please include as much information (configurations, deployment method, Docker & API versions, etc) as you can when reporting an issue.\n\n**Great Bug Reports** tend to have:\n\n- A quick summary and/or background\n- Steps to reproduce\n - Be specific!\n - Give example configurations if you can.\n- What you expected would happen\n- What actually happens\n- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)\n\nPeople _love_ thorough bug reports. I'm not even kidding.\n\n## Development Guidelines\n\nPlease see the [documentation regarding development](https://gethomepage.dev/widgets/authoring/getting-started/#development) and specifically the [guidelines for new service widgets](https://gethomepage.dev/widgets/authoring/getting-started/#service-widget-guidelines) if you are considering making one.\n\n## Use a Consistent Coding Style\n\nPlease see information in the docs regarding [code formatting with pre-commit hooks](https://gethomepage.dev/widgets/authoring/getting-started/#code-formatting-with-pre-commit-hooks).\n\n## License\n\nBy contributing, you agree that your contributions will be licensed under its GNU General Public License.\n\n## Use of AI for pull requests\n\nIn general, homepage does not accept \"AI-generated\" PRs. If you choose to use something like that to aid the development process to generate a significant proportion of the pull request, please make sure this is explicitly stated in the PR itself.\n\n## References\n\nThis document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/main/CONTRIBUTING.md)\n\n## Automatic Respository Maintenance\n\nThe homepage team appreciates all effort and interest from the community in filing bug reports, creating feature requests, sharing ideas and helping other community members. That said, in an effort to keep the repository organized and managebale the project uses automatic handling of certain areas:\n\n- Issues, pull requests and discussions that are closed will be locked after 30 days of inactivity.\n- Discussions with a marked answer will be automatically closed.\n- Discussions in the 'General' or 'Support' categories will be closed after 180 days of inactivity.\n- Feature requests that do not meet the following thresholds will be closed: 20 \"up-votes\" after 180 days of inactivity or 40 \"up-votes\" after 365 days.\n\nIn all cases, threads can be re-opened by project maintainers and, of course, users can always create a new discussion for related concerns.\nFinally, remember that all information remains searchable and 'closed' feature requests can still serve as inspiration for new features.\n\nThank you all for your contributions.\n" }, { "path": "Dockerfile", "content": "# =========================\n# Builder Stage\n# =========================\nFROM node:22-slim AS builder\nWORKDIR /app\n\n# Setup\nRUN mkdir config\nCOPY . .\n\nARG CI\nARG BUILDTIME\nARG VERSION\nARG REVISION\nENV CI=$CI\n\n# Install and build only outside CI\nRUN if [ \"$CI\" != \"true\" ]; then \\\n corepack enable && corepack prepare pnpm@latest --activate && \\\n pnpm install --frozen-lockfile --prefer-offline && \\\n NEXT_TELEMETRY_DISABLED=1 \\\n NEXT_PUBLIC_BUILDTIME=$BUILDTIME \\\n NEXT_PUBLIC_VERSION=$VERSION \\\n NEXT_PUBLIC_REVISION=$REVISION \\\n pnpm run build; \\\n else \\\n echo \"✅ Using prebuilt app from CI context\"; \\\n fi\n\n# =========================\n# Runtime Stage\n# =========================\nFROM node:22-alpine AS runner\nLABEL org.opencontainers.image.title=\"Homepage\"\nLABEL org.opencontainers.image.description=\"A self-hosted services landing page, with docker and service integrations.\"\nLABEL org.opencontainers.image.url=\"https://github.com/gethomepage/homepage\"\nLABEL org.opencontainers.image.documentation='https://github.com/gethomepage/homepage/wiki'\nLABEL org.opencontainers.image.source='https://github.com/gethomepage/homepage'\nLABEL org.opencontainers.image.licenses='Apache-2.0'\n\n# Setup\nWORKDIR /app\n\n# Copy some files from context\nCOPY --link --chown=1000:1000 /public ./public/\nCOPY --link --chmod=755 docker-entrypoint.sh /usr/local/bin/\n\n# Copy only necessary files from the build stage\nCOPY --link --from=builder --chown=1000:1000 /app/.next/standalone/ ./\nCOPY --link --from=builder --chown=1000:1000 /app/.next/static/ ./.next/static\n\nRUN apk add --no-cache su-exec iputils-ping shadow\n\nUSER root\n\nENV NODE_ENV=production\nENV HOSTNAME=::\nENV PORT=3000\nEXPOSE $PORT\n\nHEALTHCHECK --interval=10s --timeout=3s --start-period=20s \\\n CMD wget --no-verbose --tries=1 --spider http://127.0.0.1:$PORT/api/healthcheck || exit 1\n\nENTRYPOINT [\"docker-entrypoint.sh\"]\nCMD [\"node\", \"server.js\"]\n" }, { "path": "Dockerfile-tilt", "content": "# syntax = docker/dockerfile:latest\nFROM docker.io/node:18-alpine\n\nWORKDIR /app\n\nCOPY --link package.json pnpm-lock.yaml* ./\n\nRUN <\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n Copyright (C) \n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n.\n" }, { "path": "README.md", "content": "

\n \n \n \n \n

\n\n

\n A modern, fully static, fast, secure fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.\n

\n\n

\n \n

\n\n

\n \"GitHub\n  \n \n  \n \n  \n \"Discord\"\n  \n \n  \n \"GitHub\n

\n\n

\n \"DigitalOcean\n

\n

\nHomepage builds are kindly powered by DigitalOcean.\n

\n\n# Features\n\nWith features like quick search, bookmarks, weather support, a wide range of integrations and widgets, an elegant and modern design, and a focus on performance, Homepage is your ideal start to the day and a handy companion throughout it.\n\n- **Fast** - The site is statically generated at build time for instant load times.\n- **Secure** - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.\n- **For Everyone** - Images built for AMD64, ARM64.\n- **Full i18n** - Support for over 40 languages.\n- **Service & Web Bookmarks** - Add custom links to the homepage.\n- **Docker Integration** - Container status and stats. Automatic service discovery via labels.\n- **Service Integration** - Over 100 service integrations, including popular starr and self-hosted apps.\n- **Information & Utility Widgets** - Weather, time, date, search, and more.\n- **And much more...**\n\n## Docker Integration\n\nHomepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker Service Discovery](https://gethomepage.dev/configs/docker/#automatic-service-discovery) page for more information.\n\n## Service Widgets\n\nHomepage also has support for hundreds of 3rd-party services, including all popular \\*arr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd-party APIs. See the [Service](https://gethomepage.dev/widgets/) page for more information.\n\n## Information Widgets\n\nHomepage has built-in support for a number of information providers, including weather, time, date, search, glances and more. System and status information presented at the top of the page. See the [Information Providers](https://gethomepage.dev/widgets/) page for more information.\n\n## Customization\n\nHomepage is highly customizable, with support for custom themes, custom CSS & JS, custom layouts, formatting, localization and more. See the [Settings](https://gethomepage.dev/configs/settings/) page for more information.\n\n# Getting Started\n\nFor configuration options, examples and more, [please check out the homepage documentation](http://gethomepage.dev).\n\n## Security Notice 🔒\n\nPlease note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. If Homepage is reachable from any untrusted network, it **must** sit behind a reverse proxy (and/or VPN) that enforces authentication, TLS, and strictly validates Host headers. The built-in host check in Homepage is a best-effort guard and should not be treated as security when exposed publicly.\n\n## With Docker\n\nUsing docker compose:\n\n```yaml\nservices:\n homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n environment:\n HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts\n PUID: 1000 # optional, your user id\n PGID: 1000 # optional, your group id\n ports:\n - 3000:3000\n volumes:\n - /path/to/config:/app/config # Make sure your local config directory exists\n - /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations\n restart: unless-stopped\n```\n\nor docker run:\n\n```bash\ndocker run --name homepage \\\n -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev \\\n -e PUID=1000 \\\n -e PGID=1000 \\\n -p 3000:3000 \\\n -v /path/to/config:/app/config \\\n -v /var/run/docker.sock:/var/run/docker.sock:ro \\\n --restart unless-stopped \\\n ghcr.io/gethomepage/homepage:latest\n```\n\n## From Source\n\nFirst, clone the repository:\n\n```bash\ngit clone https://github.com/gethomepage/homepage.git\n```\n\nThen install dependencies and build the production bundle:\n\n```bash\npnpm install\npnpm build\n```\n\nIf this is your first time starting, copy the `src/skeleton` directory to `config/` to populate initial example config files.\n\nFinally, run the server in production mode:\n\n```bash\npnpm start\n```\n\n# Configuration\n\nPlease refer to the [homepage documentation website](https://gethomepage.dev/) for more information. Everything you need to know about configuring Homepage is there. Please read everything carefully before asking for help, as most questions are answered there or are simple YAML configuration issues.\n\n# Development\n\nInstall NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!):\n\n```bash\npnpm install\n```\n\nStart the development server:\n\n```bash\npnpm dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) to start.\n\nThis is a [Next.js](https://nextjs.org/) application, see their documentation for more information.\n\n# Documentation\n\nThe homepage documentation is available at [https://gethomepage.dev/](https://gethomepage.dev/).\n\nHomepage uses Zensical for documentation. To run the documentation locally, first install the dependencies:\n\n```bash\nuv sync\n```\n\nThen run the development server:\n\n```bash\nuv run zensical serve # or build, to build the static site\n```\n\n# Support & Suggestions\n\nIf you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/gethomepage/homepage/discussions) page.\n\n## Troubleshooting\n\nIn addition to the docs, the [troubleshooting guide](https://gethomepage.dev/troubleshooting/) can help reveal many basic config or network issues. If you're having a problem, it's a good place to start.\n\n## Contributing & Contributors\n\nContributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.\n\nThanks to the over 200 contributors who have helped make this project what it is today!\n\nEspecially huge thanks to [@shamoon](https://github.com/shamoon), who has been the backbone of this community from the very start.\n" }, { "path": "crowdin.yml", "content": "project_id_env: CROWDIN_PROJECT_ID\napi_token_env: CROWDIN_PERSONAL_TOKEN\npreserve_hierarchy: true\nfiles:\n - source: /public/locales/en/*.json\n translation: /public/locales/%osx_locale%/%original_file_name%\n" }, { "path": "docker-entrypoint.sh", "content": "#!/bin/sh\n\nset -e\n\n# Default to root, so old installations won't break\nexport PUID=${PUID:-0}\nexport PGID=${PGID:-0}\n\n# This is in attempt to preserve the original behavior of the Dockerfile,\n# while also supporting the lscr.io /config directory\n[ ! -d \"/app/config\" ] && ln -s /config /app/config\n\nexport HOMEPAGE_BUILDTIME=$(date +%s)\n\n# Try IPv6 first (dual stack when available), but fall back to IPv4 if the bind fails\nexport HOSTNAME=${HOSTNAME:-::}\nif [ \"$HOSTNAME\" = \"::\" ]; then\n if ! node -e \"const server = require('http').createServer(() => {}); const host = '::'; const port = process.env.PORT || 3000; server.once('error', (err) => { console.error('IPv6 bind failed:', err.message); process.exit(1); }); server.listen(port, host, () => server.close(() => process.exit(0)));\"; then\n echo \"Falling back to IPv4 bind at 0.0.0.0\"\n export HOSTNAME=0.0.0.0\n fi\nfi\n\n# Check ownership before chown\nif [ \"$PUID\" = \"0\" ]; then\n echo \"Skipping ownership changes for /app/config\"\nelif [ -e /app/config ]; then\n CURRENT_UID=$(stat -c %u /app/config)\n CURRENT_GID=$(stat -c %g /app/config)\n\n if [ \"$CURRENT_UID\" -ne \"$PUID\" ] || [ \"$CURRENT_GID\" -ne \"$PGID\" ]; then\n echo \"Fixing ownership of /app/config\"\n if ! chown -R \"$PUID:$PGID\" /app/config 2>/dev/null; then\n echo \"Warning: Could not chown /app/config; continuing anyway\"\n fi\n else\n echo \"/app/config already owned by correct UID/GID, skipping chown\"\n fi\nelse\n echo \"/app/config does not exist; skipping ownership check\"\nfi\n\n# Ensure /app/config/logs exists and is owned\nif [ \"$PUID\" = \"0\" ]; then\n echo \"Skipping ownership changes for /app/config/logs\"\nelif [ -n \"$PUID\" ] && [ -n \"$PGID\" ]; then\n mkdir -p /app/config/logs 2>/dev/null || true\n if [ -d /app/config/logs ]; then\n LOG_UID=$(stat -c %u /app/config/logs)\n LOG_GID=$(stat -c %g /app/config/logs)\n if [ \"$LOG_UID\" -ne \"$PUID\" ] || [ \"$LOG_GID\" -ne \"$PGID\" ]; then\n echo \"Fixing ownership of /app/config/logs\"\n chown -R \"$PUID:$PGID\" /app/config/logs 2>/dev/null || echo \"Warning: Could not chown /app/config/logs\"\n fi\n fi\nfi\n\nif [ -d /app/.next ]; then\n CURRENT_UID=$(stat -c %u /app/.next)\n CURRENT_GID=$(stat -c %g /app/.next)\n\n if [ \"$PUID\" -ne 0 ] && ([ \"$CURRENT_UID\" -ne \"$PUID\" ] || [ \"$CURRENT_GID\" -ne \"$PGID\" ]); then\n echo \"Fixing ownership of /app/.next\"\n if ! chown -R \"$PUID:$PGID\" /app/.next 2>/dev/null; then\n echo \"Warning: Could not chown /app/.next; continuing anyway\"\n fi\n else\n echo \"/app/.next already owned by correct UID/GID or running as root, skipping chown\"\n fi\nfi\n\n# Drop privileges (when asked to) if root, otherwise run as current user\nif [ \"$(id -u)\" = \"0\" ] && [ \"${PUID}\" != \"0\" ]; then\n exec su-exec ${PUID}:${PGID} \"$@\"\nelse\n exec \"$@\"\nfi\n" }, { "path": "docs/CNAME", "content": "gethomepage.dev\n" }, { "path": "docs/configs/bookmarks.md", "content": "---\ntitle: Bookmarks\ndescription: Bookmark Configuration\n---\n\nBookmarks are configured in the `bookmarks.yaml` file. They function much the same as [Services](services.md), in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.\n\nThe design of homepage expects `abbr` to be 2 letters, but is not otherwise forced.\n\nYou can also use an icon for bookmarks similar to the [options for service icons](services.md#icons). If both icon and abbreviation are supplied, the icon takes precedence.\n\nBy default, the description will use the hostname of the link, but you can override it with a custom description.\n\n```yaml\n---\n- Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n\n- Social:\n - Reddit:\n - icon: reddit.png\n href: https://reddit.com/\n description: The front page of the internet\n\n- Entertainment:\n - YouTube:\n - abbr: YT\n href: https://youtube.com/\n```\n\nwhich renders to (depending on your theme, etc.):\n\n\"Bookmarks\"\n\nThe default [bookmarks.yaml](https://github.com/gethomepage/homepage/blob/main/src/skeleton/bookmarks.yaml) is a working example.\n" }, { "path": "docs/configs/custom-css-js.md", "content": "---\ntitle: Custom CSS & JS\ndescription: Adding Custom CSS or JS\n---\n\nAs of version v0.6.30 homepage supports adding your own custom css & javascript. Please do so **at your own risk**.\n\nTo add custom css simply edit the `custom.css` file under your config directory, similarly for javascript you would edit `custom.js`. You can then target elements in homepage with various classes / ids to customize things to your liking.\n\nYou can also set a specific `id` for a service or bookmark to target with your custom css or javascript, e.g.\n\n```yaml\nService:\n id: myserviceid\n icon: icon.png\n ...\n```\n" }, { "path": "docs/configs/docker.md", "content": "---\ntitle: Docker\ndescription: Docker Configuration\n---\n\nDocker instances are configured inside the `docker.yaml` file. Both IP:PORT and Socket connections are supported.\n\nFor IP:PORT, simply make sure your Docker instance [has been configured](https://gist.github.com/styblope/dc55e0ad2a9848f2cc3307d4819d819f) to accept API traffic over the HTTP API.\n\n```yaml\nmy-remote-docker:\n host: 192.168.0.101\n port: 2375\n```\n\n## Using Docker TLS\n\nSince Docker supports connecting with TLS and client certificate authentication, you can include TLS details when connecting to the HTTP API. Further details of setting up Docker to accept TLS connections, and generation of the keys and certs can be found [in the Docker documentation](https://docs.docker.com/engine/security/protect-access/#use-tls-https-to-protect-the-docker-daemon-socket). The file entries are relative to the `config` directory (location of `docker.yaml` file).\n\n```yaml\nmy-remote-docker:\n host: 192.168.0.101\n port: 2375\n tls:\n keyFile: tls/key.pem\n caFile: tls/ca.pem\n certFile: tls/cert.pem\n```\n\n## Using Docker Socket Proxy\n\nDue to security concerns with exposing the docker socket directly, you can use a [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) container to expose the docker socket on a more restricted and secure API.\n\nHere is an example docker-compose file that will expose the docker socket, and then connect to it from the homepage container:\n\n```yaml\ndockerproxy:\n image: ghcr.io/tecnativa/docker-socket-proxy:latest\n container_name: dockerproxy\n environment:\n - CONTAINERS=1 # Allow access to viewing containers\n - SERVICES=1 # Allow access to viewing services (necessary when using Docker Swarm)\n - TASKS=1 # Allow access to viewing tasks (necessary when using Docker Swarm)\n - POST=0 # Disallow any POST operations (effectively read-only)\n ports:\n - 127.0.0.1:2375:2375\n volumes:\n - /var/run/docker.sock:/var/run/docker.sock:ro # Mounted as read-only\n restart: unless-stopped\n\nhomepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n volumes:\n - /path/to/config:/app/config\n ports:\n - 3000:3000\n restart: unless-stopped\n```\n\nThen, inside of your `docker.yaml` settings file, you'd configure the docker instance like so:\n\n```yaml\nmy-docker:\n host: dockerproxy\n port: 2375\n```\n\nUse `protocol: https` if you’re connecting through a reverse proxy (e.g., Traefik) that serves the Docker API over HTTPS:\n\n```yaml\nmy-docker:\n host: dockerproxy\n port: 443\n protocol: https\n```\n\n!!! note\n\n Note: This does not require TLS certificates if the proxy handles encryption. Do not use `protocol: https` unless you’re sure the target host supports HTTPS.\n\nYou can also include `headers` for the connection, for example, if you are using a reverse proxy that requires authentication:\n\n```yaml\nmy-docker:\n host: dockerproxy\n port: 443\n protocol: https\n headers:\n Authorization: Basic \n```\n\n## Using Socket Directly\n\nIf you'd rather use the socket directly, first make sure that you're passing the local socket into the Docker container.\n\n!!! note\n\n In order to use the socket directly homepage must be running as root\n\n```yaml\nhomepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n volumes:\n - /path/to/config:/app/config\n - /var/run/docker.sock:/var/run/docker.sock # pass local proxy\n ports:\n - 3000:3000\n restart: unless-stopped\n```\n\nIf you're using `docker run`, this would be `-v /var/run/docker.sock:/var/run/docker.sock`.\n\nThen, inside of your `docker.yaml` settings file, you'd configure the docker instance like so:\n\n```yaml\nmy-docker:\n socket: /var/run/docker.sock\n```\n\n## Services\n\nOnce you've configured your docker instances, you can then apply them to your services, to get stats and status reporting shown.\n\nInside of the service you'd like to connect to docker:\n\n```yaml\n- Emby:\n icon: emby.png\n href: \"http://emby.home/\"\n description: Media server\n server: my-docker # The docker server that was configured\n container: emby # The name of the container you'd like to connect\n```\n\n## Automatic Service Discovery\n\nHomepage features automatic service discovery for containers with the proper labels attached, all configuration options can be applied using dot notation, beginning with `homepage`.\n\nBelow is an example of the same service entry shown above, as docker labels.\n\n```yaml\nservices:\n emby:\n image: lscr.io/linuxserver/emby:latest\n container_name: emby\n ports:\n - 8096:8096\n restart: unless-stopped\n labels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\n```\n\nWhen your Docker instance has been properly configured, this service will be automatically discovered and added to your Homepage. **You do not need to specify the `server` or `container` values, as they will be automatically inferred.**\n\n**When using docker swarm use _deploy/labels_**\n\n## Widgets\n\nYou may also configure widgets, along with the standard service entry, again, using dot notation.\n\n```yaml\nlabels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\n - homepage.widget.type=emby\n - homepage.widget.url=http://emby.home\n - homepage.widget.key=yourembyapikeyhere\n - homepage.widget.fields=[\"field1\",\"field2\"] # optional\n```\n\n!!! note\n\n If you use mapping syntax (`:`) for labels instead of list syntax (`-`), array values like `fields` must be wrapped in single quotes so they are passed as a string:\n\n ```yaml\n labels:\n ...\n homepage.widget.fields: '[\"field1\",\"field2\"]'\n ```\n\nMultiple widgets can be specified by incrementing the index, e.g.\n\n```yaml\nlabels: ...\n - homepage.widgets[0].type=emby\n - homepage.widgets[0].url=http://emby.home\n - homepage.widgets[0].key=yourembyapikeyhere\n - homepage.widgets[1].type=uptimekuma\n - homepage.widgets[1].url=http://uptimekuma.home\n - homepage.widgets[1].slug=youreventslughere\n```\n\nTo pass custom HTTP headers with a widget request when using labels, use the same dot-notation: `homepage.widget.headers.X-Auth-Key=secret` (or `homepage.widgets[0].headers.X-Auth-Key=secret` when multiple widgets are present).\n\nYou can add specify fields for e.g. the [CustomAPI](../widgets/services/customapi.md) widget by using array-style dot notation:\n\n```yaml\nlabels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.href=http://emby.home/\n - homepage.description=Media server\n - homepage.widget.type=customapi\n - homepage.widget.url=http://argus.service/api/v1/service/summary/emby\n - homepage.widget.mappings[0].label=Deployed Version\n - homepage.widget.mappings[0].field.status=deployed_version\n - homepage.widget.mappings[1].label=Latest Version\n - homepage.widget.mappings[1].field.status=latest_version\n```\n\n## Docker Swarm\n\nDocker swarm is supported and Docker services are specified with the same `server` and `container` notation. To enable swarm support you will need to include a `swarm` setting in your docker.yaml, e.g.\n\n```yaml\nmy-docker:\n socket: /var/run/docker.sock\n swarm: true\n```\n\nFor the automatic service discovery to discover all services it is important that homepage should be deployed on a manager node. Set deploy requirements to the master node in your stack yaml config, e.g.\n\n```yaml\n....\n deploy:\n placement:\n constraints:\n - node.role == manager\n...\n```\n\nIn order to detect every service within the Docker swarm it is necessary that service labels should be used and not container labels. Specify the homepage labels as:\n\n```yaml\n....\n deploy:\n labels:\n - homepage.icon=foobar\n...\n```\n\n## Multiple Homepage Instances\n\nThe optional field `instanceName` can be configured in [settings.yaml](settings.md#instance-name) to differentiate between multiple homepage instances.\n\nTo limit a label to an instance, insert `.instance.{{instanceName}}` after the `homepage` prefix.\n\n```yaml\nlabels:\n - homepage.group=Media\n - homepage.name=Emby\n - homepage.icon=emby.png\n - homepage.instance.internal.href=http://emby.lan/\n - homepage.instance.public.href=https://emby.mydomain.com/\n - homepage.description=Media server\n```\n\n## Ordering\n\nAs of v0.6.4 discovered services can include an optional `weight` field to determine sorting such that:\n\n- Default weight for discovered services is 0\n- Default weight for configured services is their index within their group scaled by 100, i.e. (index + 1) \\* 100\n- If two items have the same weight value, then they will be sorted by name\n\n## Show stats\n\nYou can show the docker stats by clicking the status indicator but this can also be controlled per-service with:\n\n```yaml\n- Example Service:\n ...\n showStats: true\n```\n\nAlso see the settings for [show docker stats](settings.md#show-container-stats).\n" }, { "path": "docs/configs/index.md", "content": "---\ntitle: Configuration\ndescription: Homepage Configuration\nicon: material/cog\n---\n\nHomepage uses YAML for configuration, YAML stands for \"YAML Ain't Markup Language.\". It's a human-readable data serialization format that's a superset of JSON. Great for config files, easy to read and write. Supports complex data types like lists and objects. **Indentation matters.** If you already use Docker Compose, you already use YAML.\n\nHere are some tips when writing YAML:\n\n1. **Use Indentation Carefully**: YAML relies on indentation, not brackets.\n2. Avoid Tabs: Stick to spaces for indentation to avoid parsing errors. 2 spaces are common.\n3. Quote Strings: Use single or double quotes for strings with special characters, this is especially important for API keys.\n4. Key-Value Syntax: Use key: value format. Colon must be followed by a space.\n5. Validate: Always validate your YAML with a linter before deploying.\n\nYou can find tons of online YAML validators, here's one: [https://codebeautify.org/yaml-validator](https://codebeautify.org/yaml-validator), heres another: [https://jsonformatter.org/yaml-validator](https://jsonformatter.org/yaml-validator).\n" }, { "path": "docs/configs/info-widgets.md", "content": "---\ntitle: Information Widgets\ndescription: Homepage info widgets.\n---\n\nInformation widgets are widgets that provide information about your system or environment and are displayed at the top of the homepage. You can find a list of all available info widgets under the [Info Widgets](../widgets/info/index.md) section.\n\nInfo widgets are defined in the widgets.yaml\n\nEach widget has its own configuration options, which are detailed in the widget's documentation.\n\n## Layout\n\nInfo widgets are displayed in the order they are defined in the `widgets.yaml` file. You can change the order by moving the widgets around in the file. However, some widgets (weather, search and datetime) are aligned to the right side of the screen which can affect the layout of the widgets.\n\n## Adding A Link\n\nYou can add a link to an info widget such as the logo or text widgets by adding an `href` option, for example:\n\n```yaml\nlogo:\n href: https://example.com\n target: _blank # Optional, can be set in settings\n```\n" }, { "path": "docs/configs/kubernetes.md", "content": "---\ntitle: Kubernetes\ndescription: Kubernetes Configuration\n---\n\nThe Kubernetes connectivity has the following requirements:\n\n- Kubernetes 1.19+\n- Metrics Service\n- An Ingress controller\n - Optionally: Gateway-API\n\nThe Kubernetes connection is configured in the `kubernetes.yaml` file. There are 3 modes to choose from:\n\n- **disabled** - disables kubernetes connectivity\n- **default** - uses the default kubeconfig [resolution](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/)\n- **cluster** - uses a service account inside the cluster\n\n```yaml\nmode: default\n```\n\nTo configure Kubernetes gateway-api, ingress or ingressRoute service discovery, add one or multiple of the following settings.\n\nExample settings:\n\n```yaml\ningress: true # default, enable ingress only\n```\n\nor\n\n```yaml\ningress: true # default, enable ingress\ntraefik: true # enable traefik ingressRoute\ngateway: true # enable gateway-api\n```\n\n## Services\n\nOnce the Kubernetes connection is configured, individual services can be configured to pull statistics. Only CPU and Memory are currently supported.\n\nInside of the service you'd like to connect to a pod:\n\n```yaml\n- Emby:\n icon: emby.png\n href: \"http://emby.home/\"\n description: Media server\n namespace: media # The kubernetes namespace the app resides in\n app: emby # The name of the deployed app\n```\n\nThe `app` field is used to create a label selector, in this example case it would match pods with the label: `app.kubernetes.io/name=emby`.\n\nSometimes this is insufficient for complex or atypical application deployments. In these cases, the `podSelector` field can be used. Any field selector can be used with it, so it allows for some very powerful selection capabilities.\n\nFor instance, it can be utilized to roll multiple underlying deployments under one application to see a high-level aggregate:\n\n```yaml\n- Element Chat:\n icon: matrix-light.png\n href: https://chat.example.com\n description: Matrix Synapse Powered Chat\n app: matrix-element\n namespace: comms\n podSelector: >-\n app.kubernetes.io/instance in (\n matrix-element,\n matrix-media-repo,\n matrix-media-repo-postgresql,\n matrix-synapse\n )\n```\n\n!!! note\n\n A blank string as a podSelector does not deactivate it, but will actually select all pods in the namespace. This is a useful way to capture the resource usage of a complex application siloed to a single namespace, like Longhorn.\n\n## Automatic Service Discovery\n\nHomepage features automatic service discovery by Ingress annotations. All configuration options can be applied using typical annotation syntax, beginning with `gethomepage.dev/`.\n\n```yaml\napiVersion: networking.k8s.io/v1\nkind: Ingress\nmetadata:\n name: emby\n annotations:\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/description: Media Server\n gethomepage.dev/group: Media\n gethomepage.dev/icon: emby.png\n gethomepage.dev/name: Emby\n gethomepage.dev/widget.type: \"emby\"\n gethomepage.dev/widget.url: \"https://emby.example.com\"\n gethomepage.dev/widget.headers.X-Auth-Key: \"your-secret-here\"\n gethomepage.dev/pod-selector: \"\"\n gethomepage.dev/weight: 10 # optional\n gethomepage.dev/instance: \"public\" # optional\nspec:\n rules:\n - host: emby.example.com\n http:\n paths:\n - backend:\n service:\n name: emby\n port:\n number: 8080\n path: /\n pathType: Prefix\n```\n\nWhen the Kubernetes cluster connection has been properly configured, this service will be automatically discovered and added to your Homepage. **You do not need to specify the `namespace` or `app` values, as they will be automatically inferred.**\n\nIf you are using multiple instances of homepage, an `instance` annotation can be specified to limit services to a specific instance. If no instance is provided, the service will be visible on all instances.\n\nIf you have a single service that needs to be shown on multiple specific instances of homepage (but not on all of them), the service can be annotated by multiple `instance.name` annotations, where `name` can be the names of your specific multiple homepage instances. For example, a service that is annotated with `gethomepage.dev/instance.public: \"\"` and `gethomepage.dev/instance.internal: \"\"` will be shown on `public` and `internal` homepage instances.\n\nUse the `gethomepage.dev/pod-selector` selector to specify the pod used for the health check. For example, a service that is annotated with `gethomepage.dev/pod-selector: app.kubernetes.io/name=deployment` would link to a pod with the label `app.kubernetes.io/name: deployment`.\n\n### Traefik IngressRoute support\n\nHomepage can also read ingresses defined using the Traefik IngressRoute custom resource definition. Due to the complex nature of Traefik routing rules, it is required for the `gethomepage.dev/href` annotation to be set:\n\n```yaml\napiVersion: traefik.io/v1alpha1\nkind: IngressRoute\nmetadata:\n name: emby\n annotations:\n gethomepage.dev/href: \"https://emby.example.com\"\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/description: Media Server\n gethomepage.dev/group: Media\n gethomepage.dev/icon: emby.png\n gethomepage.dev/app: emby-app # optional, may be needed if app.kubernetes.io/name != ingress metadata.name\n gethomepage.dev/name: Emby\n gethomepage.dev/widget.type: \"emby\"\n gethomepage.dev/widget.url: \"https://emby.example.com\"\n gethomepage.dev/pod-selector: \"\"\n gethomepage.dev/weight: 10 # optional\n gethomepage.dev/instance: \"public\" # optional\nspec:\n entryPoints:\n - websecure\n routes:\n - kind: Rule\n match: Host(`emby.example.com`)\n services:\n - kind: Service\n name: emby\n namespace: emby\n port: 8080\n scheme: http\n strategy: RoundRobin\n weight: 10\n```\n\nIf the `href` attribute is not present, Homepage will ignore the specific IngressRoute.\n\n### Gateway API HttpRoute support\n\nHomepage also features automatic service discovery for Gateway API. Service definitions are read by annotating the HttpRoute custom resource definition and are indentical to the Ingress example as defined in [Automatic Service Discovery](#automatic-service-discovery).\n\nTo enable Gateway API HttpRoute update `kubernetes.yaml` to include:\n\n```\ngateway: true # enable gateway-api\n```\n\n#### Using the unoffocial helm chart?\n\nIf you are using the unofficial helm chart ensure that the `ClusterRole` has required permissions for `gateway.networking.k8s.io`.\n\nSee [ClusterRole and ClusterRoleBinding](../installation/k8s.md#clusterrole-and-clusterrolebinding)\n\n## Caveats\n\nSimilarly to Docker service discovery, there currently is no rigid ordering to discovered services and discovered services will be displayed above those specified in the `services.yaml`.\n\n## Adding extra configuration files\n\nSome Homepage features (for example, [Proxmox](../configs/proxmox.md)) require additional configuration files such as `proxmox.yaml`.\nWhen running Homepage on Kubernetes, these files must be provided via a `ConfigMap` and mounted into the container at `/app/config`.\n\n### ConfigMap example\n\n```yaml\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: homepage\ndata:\n proxmox.yaml: |\n pve:\n url: https://proxmox.host.or.ip:8006\n token: username@pam!Token ID\n secret: secret\n```\n\nMount the file into `/app/config` by updating the `Deployment`:\n\n```yaml\nvolumeMounts:\n - mountPath: /app/config/proxmox.yaml\n name: homepage-config\n subPath: proxmox.yaml\n```\n" }, { "path": "docs/configs/proxmox.md", "content": "---\ntitle: Proxmox\ndescription: Proxmox Configuration\n---\n\nThe Proxmox connection is configured in the `proxmox.yaml` file. See [Create token](#create-token) section below for details on how to generate the required API token.\nTo configure multiple nodes, ensure the key name in the `proxmox.yaml` matches the `proxmoxNode` field used in your service configuration.\n\n```yaml\npve: # must match your actual Proxmox node name\n url: https://proxmox.host.or.ip:8006\n token: username@pam!Token ID\n secret: secret\n```\n\n## Services\n\nOnce the Proxmox connection is configured, individual services can be configured to pull statistics of VMs or LXCs. Only CPU and Memory are currently supported.\n\n### Configuration Options\n\n- `proxmoxNode`: The name of the Proxmox node where your VM/LXC is running, must match with a node configured in the `proxmox.yaml`\n- `proxmoxVMID`: The ID of the Proxmox VM or LXC container\n- `proxmoxType`: (Optional) The type of Proxmox virtual machine. Defaults to `qemu` for VMs, but can be set to `lxc` for LXC containers\n\n#### Examples\n\nFor a QEMU VM (default):\n\n```yaml\n- HomeAssistant:\n icon: home-assistant.png\n href: http://homeassistant.local/\n description: Home automation\n proxmoxNode: pve\n proxmoxVMID: 101\n # proxmoxType: qemu # This is the default, so it can be omitted\n```\n\nFor an LXC container:\n\n```yaml\n- Nginx:\n icon: nginx.png\n href: http://nginx.local/\n description: Web server\n proxmoxNode: pve\n proxmoxVMID: 200\n proxmoxType: lxc\n```\n\n## Create token\n\nYou will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user.\n\n1. Navigate to the Proxmox portal, click on Datacenter\n2. Expand Permissions, click on Groups\n3. Click the Create button\n4. Name the group something informative, like api-ro-users\n5. Click on the Permissions \"folder\"\n6. Click Add -> Group Permission\n - Path: /\n - Group: group from bullet 4 above\n - Role: PVEAuditor\n - Propagate: Checked\n7. Expand Permissions, click on Users\n8. Click the Add button\n - User name: something informative like `api`\n - Realm: Linux PAM standard authentication\n - Group: group from bullet 4 above\n9. Expand Permissions, click on API Tokens\n10. Click the Add button\n - User: user from bullet 8 above\n - Token ID: something informative like the application or purpose like `homepage`\n - Privilege Separation: Checked\n11. Go back to the \"Permissions\" menu\n12. Click Add -> API Token Permission\n - Path: /\n - API Token: select the Token ID created in Step 10\n - Role: PVE Auditor\n - Propagate: Checked\n" }, { "path": "docs/configs/services.md", "content": "---\ntitle: Services\ndescription: Service Configuration\n---\n\nServices are configured inside the `services.yaml` file. You can have any number of groups, and any number of services per group.\n\n## Groups\n\nGroups are defined as top-level array entries.\n\n```yaml\n- Group A:\n - Service A:\n href: http://localhost/\n\n- Group B:\n - Service B:\n href: http://localhost/\n```\n\n\"Service\n\n### Nested Groups\n\nGroups can be nested by using the same format as the top-level groups.\n\n```yaml\n- Group A:\n - Service A:\n href: http://localhost/\n\n - Group B:\n - Service B:\n href: http://localhost/\n\n - Service C:\n href: http://localhost/\n```\n\n## Services\n\nServices are defined as array entries on groups,\n\n```yaml\n- Group A:\n - Service A:\n href: http://localhost/\n\n - Service B:\n href: http://localhost/\n\n - Service C:\n href: http://localhost/\n\n- Group B:\n - Service D:\n href: http://localhost/\n```\n\n\"Service\n\n### Service Widgets\n\nEach service can have widgets attached to it (often matching the service type, but that's not forced).\n\nIn addition to the href of the service, you can also specify the target location in which to open that link. See [Link Target](settings.md#link-target) for more details.\n\nUsing Emby as an example, this is how you would attach the Emby service widget.\n\n```yaml\n- Emby:\n icon: emby.png\n href: http://emby.host.or.ip/\n description: Movies & TV Shows\n widget:\n type: emby\n url: http://emby.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n```\n\n#### Multiple Widgets\n\nEach service can have multiple widgets attached to it, for example:\n\n```yaml\n- Emby:\n icon: emby.png\n href: http://emby.host.or.ip/\n description: Movies & TV Shows\n widgets:\n - type: emby\n url: http://emby.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n - type: uptimekuma\n url: http://uptimekuma.host.or.ip:port\n slug: statuspageslug\n```\n\n!!! note\n\n Multiple widgets per service are not yet supported with Kubernetes ingress annotations.\n\n#### Custom HTTP headers\n\nWidgets that make HTTP calls support extra request headers via `headers`. This is useful when a reverse proxy expects a secret header.\n\n```yaml\n- UptimeRobot:\n icon: uptimekuma.png\n href: https://uptimerobot.com/\n widget:\n type: uptimerobot\n url: https://api.uptimerobot.com\n key: ${UPTIMEROBOT_API_KEY}\n headers:\n User-Agent: homepage\n X-Auth-Key: your-secret-here\n```\n\nIf you define services via Docker labels or Kubernetes annotations, use the same key with dot-notation (for example `homepage.widget.headers.X-Auth-Key=secret` or `gethomepage.dev/widget.headers.X-Auth-Key: \"secret\"`).\n\n#### Field Visibility\n\nEach widget can optionally provide a list of which fields should be visible via the `fields` widget property. If no fields are specified, then all fields will be displayed. The `fields` property must be a valid YAML array of strings. As an example, here is the entry for Sonarr showing only a couple of fields.\n\n**In all cases a widget will work and display all fields without specifying the `fields` property.**\n\n```yaml\n- Sonarr:\n icon: sonarr.png\n href: http://sonarr.host.or.ip\n widget:\n type: sonarr\n fields: [\"wanted\", \"queued\"]\n url: http://sonarr.host.or.ip\n key: apikeyapikeyapikeyapikeyapikey\n```\n\n### Block Highlighting\n\nWidgets can tint their metric block text automatically based on rules defined alongside the service. Attach a `highlight` section to the widget configuration and map each block to one or more numeric or string rules using the field key (for example, `queued`, `lan_users`).\n\n```yaml\n- Sonarr:\n icon: sonarr.png\n href: http://sonarr.host.or.ip\n widget:\n type: sonarr\n url: http://sonarr.host.or.ip\n key: ${SONARR_API_KEY}\n highlight:\n queued:\n numeric:\n - level: danger\n when: gte\n value: 20\n - level: warn\n when: gte\n value: 5\n - level: good\n when: eq\n value: 0\n status:\n string:\n - level: danger\n when: regex\n value: \"(failed|import) pending\"\n - level: good\n when: equals\n value: \"All good\"\n status_code:\n string:\n - level: warn\n when: regex\n value: \"^5\\\\d{2}$\"\n```\n\nSupported numeric operators for the `when` property are `gt`, `gte`, `lt`, `lte`, `eq`, `ne`, `between`, and `outside`. String rules support `equals`, `includes`, `startsWith`, `endsWith`, and `regex`. Each rule can be inverted with `negate: true`, and string rules may pass `caseSensitive: true` or custom regex `flags`. The highlight engine does its best to coerce formatted values, but you will get the most reliable results when you pass plain numbers or strings into ``.\n\n#### Value Only Highlighting\n\nYou can optionally apply highlighting only to the value portion of a block (not the label) by setting `valueOnly: true` on the field configuration. This keeps the label visible while highlighting only the metric value itself.\n\n```yaml\n- Sonarr:\n ...\n highlight:\n queued:\n valueOnly: true\n ...\n```\n\n## Descriptions\n\nServices may have descriptions,\n\n```yaml\n- Group A:\n - Service A:\n href: http://localhost/\n description: This is my service\n\n- Group B:\n - Service B:\n href: http://localhost/\n description: This is another service\n```\n\n\"Service\n\n## Icons\n\nServices may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/homarr-labs/dashboard-icons) automatically, by passing the name of the icon, with, or without `.png`, `.webp` or `.svg` to specify the desired version.\n\nYou can also specify prefixed icons from:\n\n- [Material Design Icons](https://pictogrammers.com/library/mdi/) with `mdi-XX`\n- [Simple Icons](https://simpleicons.org/) with `si-XX`\n- [selfh.st/icons](https://selfh.st/icons/) with `sh-XX` to use the png version or `sh-XX.svg/png/webp` for a specific version\n\nYou can specify a custom color for `mdi` and `si` icons by adding a hex color code as a suffix e.g. `mdi-XX-#f0d453` or `si-XX-#a712a2`.\n\nTo use a remote icon, use the absolute URL (e.g. `https://...`).\n\nTo use a local icon, first create a Docker mount to `/app/public/icons` and then reference your icon as `/icons/myicon.png`. You will need to restart the container when adding new icons.\n\n!!! warning\n\n Material Design Icons for **brands** were deprecated and may be removed in the future. Using Simple Icons for brand icons will prevent any issues if / when the Material Design Icons are removed.\n\n```yaml\n- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n description: Series management\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n description: Movie management\n\n- Group C:\n - Service:\n icon: mdi-flask-outline\n href: http://service.host/\n description: My cool service\n```\n\n\"Service\n\n## Ping\n\nServices may have an optional `ping` property that allows you to monitor the availability of an external host. As of v0.8.0, the ping feature attempts to use a true (ICMP) ping command on the underlying host. Currently, only IPv4 is supported.\n\n!!! note\n\n Because ping uses the ping command on the underlying host, in some cases you may need to install e.g. the `iputils-ping` package on the host system.\n\n```yaml\n- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n ping: sonarr.host\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n ping: some.other.host\n```\n\n\"Ping\"\n\nYou can also apply different styles to the ping indicator by using the `statusStyle` property, see [settings](settings.md#status-style).\n\n## Site Monitor\n\nServices may have an optional `siteMonitor` property (formerly `ping`) that allows you to monitor the availability of a URL you chose and have the response time displayed. You do not need to set your monitor URL equal to your href or ping URL.\n\n!!! note\n\n The site monitor feature works by making an http `HEAD` request to the URL, and falls back to `GET` in case that fails. It will not, for example, login if the URL requires auth or is behind e.g. Authelia. In the case of a reverse proxy and/or auth this usually requires the use of an 'internal' URL to make the site monitor feature correctly display status.\n\n```yaml\n- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n siteMonitor: http://sonarr.host/\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n siteMonitor: http://some.other.host/\n```\n\nYou can also apply different styles to the site monitor indicator by using the `statusStyle` property, see [settings](settings.md#status-style).\n\n## Docker Integration\n\nServices may be connected to a Docker container, either running on the local machine, or a remote machine.\n\n```yaml\n- Group A:\n - Service A:\n href: http://localhost/\n description: This is my service\n server: my-server\n container: my-container\n\n- Group B:\n - Service B:\n href: http://localhost/\n description: This is another service\n server: other-server\n container: other-container\n```\n\n\"Service\n\n**Clicking on the status label of a service with Docker integration enabled will expand the container stats, where you can see CPU, Memory, and Network activity.**\n\n!!! note\n\n This can also be controlled with `showStats`. See [show docker stats](docker.md#show-stats) for more information\n\n\"Docker\n\n## Service Integrations\n\nServices may also have a service widget (or integration) attached to them, this works independently of the Docker integration.\n\nYou can find information and configuration for each of the supported integrations on the [Widgets](../widgets/index.md) page.\n\nHere is an example of a Radarr & Sonarr service, with their respective integrations.\n\n```yaml\n- Group A:\n - Sonarr:\n icon: sonarr.png\n href: http://sonarr.host/\n description: Series management\n widget:\n type: sonarr\n url: http://sonarr.host\n key: apikeyapikeyapikeyapikeyapikey\n\n- Group B:\n - Radarr:\n icon: radarr.png\n href: http://radarr.host/\n description: Movie management\n widget:\n type: radarr\n url: http://radarr.host\n key: apikeyapikeyapikeyapikeyapikey\n```\n\n\"Service\n" }, { "path": "docs/configs/settings.md", "content": "---\ntitle: Settings\ndescription: Service Configuration\n---\n\nThe `settings.yaml` file allows you to define application level options. For changes made to this file to take effect, you will need to regenerate the static HTML, this can be done by clicking the refresh icon in the bottom right of the page.\n\n## Title\n\nYou can customize the title of the page if you'd like.\n\n```yaml\ntitle: My Awesome Homepage\n```\n\n## Description\n\nYou can customize the description of the page if you'd like.\n\n```yaml\ndescription: A description of my awesome homepage\n```\n\n## Start URL\n\nYou can customize the start_url as required for installable apps. The default is \"/\".\n\n```yaml\nstartUrl: https://custom.url\n```\n\n## Background Image\n\n!!! warning \"Heads Up!\"\n\n You will need to restart the container any time you add new images, this is a limitation of the Next.js static site server.\n\n!!! warning \"Heads Up!\"\n\n Do not create a bind mount to the entire `/app/public/` directory.\n\nIf you'd like to use a background image instead of the solid theme color, you may provide a full URL to an image of your choice.\n\n```yaml\nbackground: https://images.unsplash.com/photo-1502790671504-542ad42d5189?auto=format&fit=crop&w=2560&q=80\n```\n\nOr you may pass the path to a local image relative to e.g. `/app/public/images` directory.\n\nFor example, inside of your Docker Compose file, mount a path to where your images are kept:\n\n```yaml\nvolumes:\n - /my/homepage/images:/app/public/images\n```\n\nand then reference that image:\n\n```yaml\nbackground: /images/background.png\n```\n\n### Background Opacity & Filters\n\nYou can specify filters to apply over your background image for blur, saturation and brightness as well as opacity to blend with the background color. The first three filter settings use tailwind CSS classes, see notes below regarding the options for each. You do not need to specify all options.\n\n```yaml\nbackground:\n image: /images/background.png\n blur: sm # sm, \"\", md, xl... see https://tailwindcss.com/docs/backdrop-blur\n saturate: 50 # 0, 50, 100... see https://tailwindcss.com/docs/backdrop-saturate\n brightness: 50 # 0, 50, 75... see https://tailwindcss.com/docs/backdrop-brightness\n opacity: 50 # 0-100\n```\n\n### Card Background Blur\n\nYou can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the background blur, saturate and brightness filters.\n\n```yaml\ncardBlur: xs # xs, md, etc... see https://tailwindcss.com/docs/backdrop-blur\n```\n\n## Favicon\n\nIf you'd like to use a custom favicon instead of the included one, you may provide a full URL to an image of your choice.\n\n```yaml\nfavicon: https://www.google.com/favicon.ico\n```\n\nOr you may pass the path to a local image relative to the `/app/public` directory. See [Background Image](#background-image) for more detailed information on how to provide your own files.\n\n## Theme\n\nYou can configure a fixed theme (and disable the theme switcher) by passing the `theme` option, like so:\n\n```yaml\ntheme: dark # or light\n```\n\n## Color Palette\n\nYou can configure a fixed color palette (and disable the palette switcher) by passing the `color` option, like so:\n\n```yaml\ncolor: slate\n```\n\nSupported colors are: `slate`, `gray`, `zinc`, `neutral`, `stone`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`, `red`, `white`\n\n## Block Highlight Levels\n\nYou can override the default Tailwind classes applied when a widget highlight rule resolves to the `good`, `warn`, or `danger` level.\n\n```yaml\nblockHighlights:\n levels:\n good: \"bg-emerald-500/40 text-emerald-950 dark:bg-emerald-900/60 dark:text-emerald-400\"\n warn: \"bg-amber-300/30 text-amber-900 dark:bg-amber-900/30 dark:text-amber-200\"\n danger: \"bg-rose-700/45 text-rose-200 dark:bg-rose-950/70 dark:text-rose-400\"\n```\n\nAny unspecified level falls back to the built-in defaults.\n\n## Progressive Web App (PWA)\n\nA progressive web app is an app that can be installed on a device and provide user experience like a native app. Homepage comes with built-in support for PWA with some default configurations, but you can customize them.\n\nMore information on PWAs can be found in [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps).\n\n## App icons\n\nYou can set custom icons for installable apps. More information about how you can set them can be found in the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Manifest/Reference/icons).\n\nThe default value is the Homepage icon in sizes 192x192 and 512x512.\n\n```yaml\npwa:\n icons:\n - src: https://developer.mozilla.org/favicon-192x192.png\n type: image/png\n sizes: 192x192\n - src: https://developer.mozilla.org/favicon-512x512.png\n type: image/png\n sizes: 512x512\n```\n\nFor icon `src` you can pass either full URL or a local path relative to the `/app/public` directory. See [Background Image](#background-image) for more detailed information on how to provide your own files.\n\n### Shortcuts\n\nShortcuts can e used to specify links to tabs, to be preselected when the homepage is opened as an app.\nMore information about how you can set them can be found in the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Manifest/Reference/shortcuts).\n\n```yaml\npwa:\n shortcuts:\n - name: First\n url: \"/#first\" # opens the first tab\n - name: Second\n url: \"/#second\" # opens the second tab\n - name: Third\n url: \"/#third\" # opens the third tab\n```\n\n### Other PWA configurations\n\nHomepage sets few other PWA configurations, that are based on global settings in `settings.yaml`:\n\n- `name`, `short_name` - Both equal to the [`title`](#title) setting.\n- `theme_color`, `background_color` - Both based on the [`color`](#color-palette) and [`theme`](#theme) settings.\n- `display` - It is always set to \"standalone\".\n- `start_url` - Equal to the [`startUrl`](#start-url) setting.\n\nMore information for wach of the PWA configurations can be found in the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Manifest/Reference).\n\n## Layout\n\nYou can configure service and bookmarks sections to be either \"column\" or \"row\" based layouts, like so:\n\nAssuming you have a group named `Media` in your `services.yaml` or `bookmarks.yaml` file,\n\n```yaml\nlayout:\n Media:\n style: row\n columns: 4\n```\n\nAs an example, this would produce the following layout:\n\n\"Screenshot\n\n### Icons-Only Layout\n\nYou can also specify the an icon-only layout for bookmarks, either like so:\n\n```yaml\nlayout:\n Media:\n iconsOnly: true\n```\n\nor globally:\n\n```yaml\nbookmarksStyle: icons\n```\n\n### Sorting\n\nService groups and bookmark groups can be mixed in order, **but should use different group names**. If you do not specify any bookmark groups they will all show at the bottom of the page.\n\n**_Using the same name for a service and bookmark group can cause unexpected behavior like a bookmark group being hidden_**\n\nGroups will sort based on the order in the layout block. You can also mix in groups defined by docker labels, e.g.\n\n```yaml\nlayout:\n - Auto-Discovered1:\n - Configured1:\n - Configured2:\n - Auto-Discovered2:\n - Configured3:\n style: row\n columns: 3\n```\n\n### Nested Groups\n\nIf your services config has nested groups, you can apply settings to these groups by nesting them in the layout block\nand using the same settings. For example\n\n```yaml\nlayout:\n Group A:\n style: row\n columns: 4\n Group C:\n style: row\n columns: 2\n Nested Group A:\n style: row\n columns: 2\n Nested Group B:\n style: row\n columns: 2\n```\n\n### Headers\n\nYou can hide headers for each section in the layout as well by passing `header` as false, like so:\n\n```yaml\nlayout:\n Section A:\n header: false\n Section B:\n style: row\n columns: 3\n header: false\n```\n\n### Category Icons\n\nYou can also add an icon to a category under the `layout` setting similar to the [options for service icons](services.md#icons), e.g.\n\n```yaml\n Home Management & Info:\n icon: home-assistant.png\n Server Tools:\n icon: https://cdn-icons-png.flaticon.com/512/252/252035.png\n ...\n```\n\n### Icon Style\n\nThe default style for icons (e.g. `icon: mdi-XXXX`) is a gradient, or you can specify that prefixed icons match your theme with a 'flat' style using the setting below.\nMore information about prefixed icons can be found in [options for service icons](services.md#icons).\n\n```yaml\niconStyle: theme # optional, defaults to gradient\n```\n\n### Tabs\n\nVersion 0.6.30 introduced a tabbed view to layouts which can be optionally specified in the layout. Tabs is only active if you set the `tab` field on at least one layout group.\n\nTabs are sorted based on the order in the layout block. If a group has no tab specified (and tabs are set on other groups), services and bookmarks will be shown on all tabs.\n\nEvery tab can be accessed directly by visiting Homepage URL with `#Group` (name lowercase and URI-encoded) at the end of the URL.\n\nFor example, the following would create four tabs:\n\n```yaml\nlayout:\n ...\n Bookmark Group on First Tab:\n tab: First\n\n First Service Group:\n tab: First\n style: row\n columns: 4\n\n Second Service Group:\n tab: Second\n columns: 4\n\n Third Service Group:\n tab: Third\n style: row\n\n Bookmark Group on Fourth Tab:\n tab: Fourth\n\n Service Group on every Tab:\n style: row\n columns: 4\n```\n\n### Full Width\n\nYou can make homepage take up the entire window width by adding:\n\n```yaml\nfullWidth: true\n```\n\n### Maximum Group Columns\n\nYou can set the maximum number of columns of groups on larger screen sizes (note this is only for groups with the default `style: columns`, not groups with `style: row`) by adding:\n\n```yaml\nmaxGroupColumns: 8 # default is 4 for services, 6 for bookmarks, max 8\n```\n\nBy default homepage will max out at 4 columns for services and 6 for bookmarks, thus the minimum for this setting is _5_. Of course, if you're setting this to higher numbers, you may want to consider enabling the [fullWidth](#full-width) option as well.\n\nIf you want to set the maximum columns for bookmark groups separately, you can do so by adding:\n\n```yaml\nmaxBookmarkGroupColumns: 6 # default is 6, max 8\n```\n\n### Collapsible sections\n\nYou can disable the collapsible feature of services & bookmarks by adding:\n\n```yaml\ndisableCollapse: true\n```\n\nBy default the feature is enabled.\n\n### Initially collapsed sections\n\nYou can initially collapse sections by adding the `initiallyCollapsed` option to the layout group.\n\n```yaml\nlayout:\n Section A:\n initiallyCollapsed: true\n```\n\nThis can also be set globaly using the `groupsInitiallyCollapsed` option.\n\n```yaml\ngroupsInitiallyCollapsed: true\n```\n\nThe value set on a group will overwrite the global setting.\n\nBy default the feature is disabled.\n\n### Use Equal Height Cards\n\nYou can enable equal height cards for groups of services, this will make all cards in a row the same height.\n\nGlobal setting in `settings.yaml`:\n\n```yaml\nuseEqualHeights: true\n```\n\nPer layout group in `settings.yaml`:\n\n```yaml\nuseEqualHeights: false\nlayout:\n ...\n Group Name:\n useEqualHeights: true # overrides global setting\n```\n\nBy default the feature is disabled\n\n## Header Style\n\nThere are currently 4 options for header styles, you can see each one below.\n\n\"underlined\"\n\n```yaml\nheaderStyle: underlined # default style\n```\n\n---\n\n\"boxed\"\n\n```yaml\nheaderStyle: boxed\n```\n\n---\n\n\"clean\"\n\n```yaml\nheaderStyle: clean\n```\n\n---\n\n\"boxedWidgets\"\n\n```yaml\nheaderStyle: boxedWidgets\n```\n\n## Base URL\n\nIn some proxy configurations, it may be necessary to set the documents base URL. You can do this by providing a `base` value, like so:\n\n```yaml\nbase: http://host.local/homepage\n```\n\n**_The URL must be a full, absolute URL, or it will be ignored by the browser._**\n\n## Language\n\nSet your desired language using:\n\n```yaml\nlanguage: fr\n```\n\nCurrently supported languages: ca, de, en, es, fr, he, hr, hu, it, nb-NO, nl, pt, ru, sv, vi, zh-Hans (Simplified), zh-Hant (Traditional)\n\n`zh-CN` will still work and is automatically mapped to `zh-Hans` for backwards compatibility.\n\nYou can also specify locales e.g. for the DateTime widget, e.g. en-AU, en-GB, etc.\n\n## Link Target\n\nChanges the behaviour of links on the homepage,\n\n```yaml\ntarget: _blank # Possible options include _blank, _self, and _top\n```\n\nUse `_blank` to open links in a new tab, `_self` to open links in the same tab, and `_top` to open links in a new window.\n\nThis can also be set for individual services. Note setting this at the service level overrides any setting in settings.json, e.g.:\n\n```yaml\n- Example Service:\n href: https://example.com/\n ...\n target: _self\n```\n\n## Providers\n\nThe `providers` section allows you to define shared API provider options and secrets.\n\n```yaml\nproviders:\n openweathermap: openweathermapapikey\n finnhub: yourfinnhubapikeyhere\n longhorn:\n url: https://longhorn.example.com\n username: admin\n password: LonghornPassword\n```\n\nYou can then pass `provider` instead of `apiKey` in your widget configuration.\n\n```yaml\n- openweathermap:\n latitude: 50.449684\n longitude: 30.525026\n provider: openweathermap\n```\n\n## Quick Launch\n\nYou can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesn't have focus).\n\n\"quicklaunch\"\n\nThere are a few optional settings for the Quick Launch feature:\n\n- `searchDescriptions`: which lets you control whether item descriptions are included in searches. This is false by default. When enabled, results that match the item name will be placed above those that only match the description.\n- `hideInternetSearch`: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.\n- `showSearchSuggestions`: show search suggestions for the internet search. If this is not specified then the setting will be inherited from the search widget. If it is not specified there either, it will default to false. For custom providers the `suggestionUrl` needs to be set in order for this to work.\n- `provider`: search engine provider. If none is specified it will try to use the provider set for the Search Widget, if neither are present then internet search will be disabled.\n- `hideVisitURL`: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.\n- `mobileButtonPosition`: enables and sets the position of the mobile quicklaunch button. Options are `top-left`, `top-right`, `bottom-left`, `bottom-right`. This is empty by default, disabling the feature.\n\n```yaml\nquicklaunch:\n searchDescriptions: true\n hideInternetSearch: true\n showSearchSuggestions: true\n hideVisitURL: true\n provider: google # google, duckduckgo, bing, baidu, brave or custom\n```\n\nor for a custom search:\n\n```yaml\nquicklaunch:\n provider: custom\n url: https://www.ecosia.org/search?q=\n target: _blank\n suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q=\n```\n\n## Homepage Version & Update Checking\n\nBy default the release version is displayed at the bottom of the page. To hide this, use the `hideVersion` setting, like so:\n\n```yaml\nhideVersion: true\n```\n\nYou can disable checking for new versions from GitHub (enabled by default) with:\n\n```yaml\ndisableUpdateCheck: true\n```\n\n## Log Path\n\nBy default the homepage logfile is written to the a `logs` subdirectory of the `config` folder. In order to customize this path, you can set the `logpath` setting. A `logs` folder will be created in that location where the logfile will be written.\n\n```yaml\nlogpath: /logfile/path\n```\n\nBy default, logs are sent both to `stdout` and to a file at the path specified. This can be changed by setting the `LOG_TARGETS` environment variable to one of `both` (default), `stdout` or `file`.\n\n## Show Container Stats\n\nYou can show all docker or proxmox stats expanded in `settings.yaml`:\n\n```yaml\nshowStats: true\n```\n\nor per-service (`services.yaml`) with:\n\n```yaml\n- Example Service:\n ...\n showStats: true\n```\n\nIf you have both set the per-service settings take precedence.\n\n## Status Style\n\nYou can choose from the following styles for docker or k8s status, site monitor and ping: `dot` or `basic`\n\n- The default is no value, and displays the monitor and ping response time in ms and the docker / k8s container status\n- `dot` shows a green dot for a successful monitor ping or healthy status.\n- `basic` shows either UP or DOWN for monitor & ping\n\nFor example:\n\n```yaml\nstatusStyle: \"dot\"\n```\n\nor per-service (`services.yaml`) with:\n\n```yaml\n- Example Service:\n ...\n statusStyle: 'dot'\n```\n\nIf you have both set, the per-service settings take precedence.\n\n## Instance Name\n\nName used by automatic docker service discovery to differentiate between multiple homepage instances.\n\nFor example:\n\n```yaml\ninstanceName: public\n```\n\n## Hide Widget Error Messages\n\nHide the visible API error messages either globally in `settings.yaml`:\n\n```yaml\nhideErrors: true\n```\n\nor per service widget (`services.yaml`) with:\n\n```yaml\n- Example Service:\n ...\n widget:\n ...\n hideErrors: true\n```\n\nIf either value is set to true, the error message will be hidden.\n\n## Disable Search Engine Indexing\n\nYou can request that search engines not to index your Homepage instance by enabling the `disableIndexing` setting.\n\n```yaml\ndisableIndexing: true\n```\n\nWhen enabled, this will:\n\n- Disallow all crawlers in `robots.txt`\n- Add `` tags to prevent indexing\n\nBy default this feature is disabled.\n" }, { "path": "docs/index.md", "content": "---\ntitle: Home\ndescription: A modern, fully static, fast, secure, fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages.\nicon: material/home\nhide:\n - navigation\n - toc\n - path\n---\n\n#\n\n
\n\n
\n\n\"homepage\"\n\n\"homepage\"\n\n

A modern, fully static, fast, secure fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery.

\n\n
\n\n\n" }, { "path": "docs/installation/docker.md", "content": "---\ntitle: Docker Installation\ndescription: Install and run homepage from Docker\n---\n\nUsing docker compose:\n\n```yaml\nservices:\n homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n ports:\n - 3000:3000\n volumes:\n - /path/to/config:/app/config # Make sure your local config directory exists\n - /var/run/docker.sock:/var/run/docker.sock:ro # (optional) For docker integrations\n environment:\n HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts\n```\n\n### Running as non-root\n\nBy default, the Homepage container runs as root. Homepage also supports running your container as non-root via the standard `PUID` and `PGID` environment variables. When using these variables, make sure that any volumes mounted in to the container have the correct ownership and permissions set.\n\n_Using the docker socket directly is not the recommended method of integration and requires either running homepage as root or that the user be part of the docker group_\n\nIn the docker compose example below, the environment variables `$PUID` and `$PGID` are set in a `.env` file.\n\n```yaml\nservices:\n homepage:\n image: ghcr.io/gethomepage/homepage:latest\n container_name: homepage\n ports:\n - 3000:3000\n volumes:\n - /path/to/config:/app/config # Make sure your local config directory exists\n - /var/run/docker.sock:/var/run/docker.sock:ro # (optional) For docker integrations, see alternative methods\n environment:\n HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts\n PUID: $PUID\n PGID: $PGID\n```\n\n### With Docker Run\n\n```bash\ndocker run -p 3000:3000 -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest\n```\n\n### Using Environment Secrets\n\nYou can also include environment variables in your config files to protect sensitive information. Note:\n\n- Environment variables must start with `HOMEPAGE_VAR_` or `HOMEPAGE_FILE_`\n- The value of env var `HOMEPAGE_VAR_XXX` will replace `{{HOMEPAGE_VAR_XXX}}` in any config\n- The value of env var `HOMEPAGE_FILE_XXX` must be a file path, the contents of which will be used to replace `{{HOMEPAGE_FILE_XXX}}` in any config\n" }, { "path": "docs/installation/index.md", "content": "---\ntitle: Installation\ndescription: Docs intro\nicon: simple/docker\n---\n\nYou have a few options for deploying homepage, depending on your needs. We offer docker images for a majority of platforms. You can also install and run homepage from source if Docker is not your thing. It can even be installed on Kubernetes with Helm.\n\n!!! info\n\n Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.\n\n
\n\n
\n[:simple-docker:   Install on Docker :octicons-arrow-right-24:](docker.md)\n{ .card }\n\n[:simple-kubernetes:   Install on Kubernetes :octicons-arrow-right-24:](k8s.md)\n{ .card }\n\n[:simple-unraid:   Install on UNRAID :octicons-arrow-right-24:](unraid.md)\n{ .card }\n\n[:simple-nextdotjs:   Building from source :octicons-arrow-right-24:](source.md)\n{ .card }\n\n
\n\n### `HOMEPAGE_ALLOWED_HOSTS`\n\nAs of v1.0 there is one required environment variable to access homepage via a URL other than `localhost`, HOMEPAGE_ALLOWED_HOSTS. The setting helps prevent certain kinds of attacks when retrieving data from the homepage API proxy.\n\nThe value is a comma-separated (no spaces) list of allowed hosts (sometimes with the port) that can host your homepage install. See the [docker](docker.md), [kubernetes](k8s.md) and [source](source.md) installation pages for more information about where / how to set the variable.\n\n`localhost:3000` and `127.0.0.1:3000` are always included, but you can add a domain or IP address to this list to allow that host such as `HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev,192.168.1.2:1234`, etc.\n\nIf you are seeing errors about host validation, check the homepage logs and ensure that the host exactly as output in the logs is in the `HOMEPAGE_ALLOWED_HOSTS` list.\n\nThis can be disabled by setting `HOMEPAGE_ALLOWED_HOSTS` to `*` but this is not recommended. Public deployments must rely on a reverse proxy (and/or VPN) that enforces authentication, TLS, and unexpected Host headers; the built-in host check is a best-effort guard for local setups and is not a substitute for edge protections.\n" }, { "path": "docs/installation/k8s.md", "content": "---\ntitle: Kubernetes Installation\ndescription: Install on Kubernetes\n---\n\n## Install with Kubernetes Manifests\n\nIf you don't want to use the unofficial Helm chart, you can also create your own Kubernetes manifest(s) and apply them with `kubectl apply -f filename.yaml`.\n\nHere's a working example of the resources you need:\n\n#### ServiceAccount\n\n```yaml\napiVersion: v1\nkind: ServiceAccount\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\nsecrets:\n - name: homepage\n```\n\n#### Secret\n\n```yaml\napiVersion: v1\nkind: Secret\ntype: kubernetes.io/service-account-token\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\n kubernetes.io/service-account.name: homepage\n```\n\n#### ConfigMap\n\n```yaml\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\ndata:\n kubernetes.yaml: |\n mode: cluster\n settings.yaml: \"\"\n #settings.yaml: |\n # providers:\n # longhorn:\n # url: https://longhorn.my.network\n custom.css: \"\"\n custom.js: \"\"\n bookmarks.yaml: |\n - Developer:\n - Github:\n - abbr: GH\n href: https://github.com/\n services.yaml: |\n - My First Group:\n - My First Service:\n href: http://localhost/\n description: Homepage is awesome\n\n - My Second Group:\n - My Second Service:\n href: http://localhost/\n description: Homepage is the best\n\n - My Third Group:\n - My Third Service:\n href: http://localhost/\n description: Homepage is 😎\n widgets.yaml: |\n - kubernetes:\n cluster:\n show: true\n cpu: true\n memory: true\n showLabel: true\n label: \"cluster\"\n nodes:\n show: true\n cpu: true\n memory: true\n showLabel: true\n - resources:\n backend: resources\n expanded: true\n cpu: true\n memory: true\n network: default\n - search:\n provider: duckduckgo\n target: _blank\n docker.yaml: \"\"\n```\n\n#### ClusterRole and ClusterRoleBinding\n\n```yaml\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRole\nmetadata:\n name: homepage\n labels:\n app.kubernetes.io/name: homepage\nrules:\n - apiGroups:\n - \"\"\n resources:\n - namespaces\n - pods\n - nodes\n verbs:\n - get\n - list\n - apiGroups:\n - extensions\n - networking.k8s.io\n resources:\n - ingresses\n verbs:\n - get\n - list\n - apiGroups:\n - traefik.io\n resources:\n - ingressroutes\n verbs:\n - get\n - list\n - apiGroups:\n - gateway.networking.k8s.io\n resources:\n - httproutes\n - gateways\n verbs:\n - get\n - list\n - apiGroups:\n - metrics.k8s.io\n resources:\n - nodes\n - pods\n verbs:\n - get\n - list\n---\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRoleBinding\nmetadata:\n name: homepage\n labels:\n app.kubernetes.io/name: homepage\nroleRef:\n apiGroup: rbac.authorization.k8s.io\n kind: ClusterRole\n name: homepage\nsubjects:\n - kind: ServiceAccount\n name: homepage\n namespace: default\n```\n\n#### Service\n\n```yaml\napiVersion: v1\nkind: Service\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\nspec:\n type: ClusterIP\n ports:\n - port: 3000\n targetPort: http\n protocol: TCP\n name: http\n selector:\n app.kubernetes.io/name: homepage\n```\n\n#### Deployment\n\n```yaml\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\nspec:\n revisionHistoryLimit: 3\n replicas: 1\n strategy:\n type: RollingUpdate\n selector:\n matchLabels:\n app.kubernetes.io/name: homepage\n template:\n metadata:\n labels:\n app.kubernetes.io/name: homepage\n spec:\n serviceAccountName: homepage\n automountServiceAccountToken: true\n dnsPolicy: ClusterFirst\n enableServiceLinks: true\n containers:\n - name: homepage\n image: \"ghcr.io/gethomepage/homepage:latest\"\n imagePullPolicy: Always\n securityContext:\n allowPrivilegeEscalation: false\n capabilities:\n drop:\n - ALL\n runAsNonRoot: true\n runAsUser: 1000\n runAsGroup: 1000\n seccompProfile:\n type: RuntimeDefault\n env:\n - name: MY_POD_IP\n valueFrom:\n fieldRef:\n fieldPath: status.podIP\n - name: HOMEPAGE_ALLOWED_HOSTS\n value: \"$(MY_POD_IP):3000,gethomepage.dev\" # See gethomepage.dev/installation/#homepage_allowed_hosts . Value before the comma is required for the k8s probe\n ports:\n - name: http\n containerPort: 3000\n protocol: TCP\n livenessProbe:\n httpGet:\n path: /api/healthcheck\n port: http\n initialDelaySeconds: 5\n periodSeconds: 15\n volumeMounts:\n - mountPath: /app/config/custom.js\n name: homepage-config\n subPath: custom.js\n - mountPath: /app/config/custom.css\n name: homepage-config\n subPath: custom.css\n - mountPath: /app/config/bookmarks.yaml\n name: homepage-config\n subPath: bookmarks.yaml\n - mountPath: /app/config/docker.yaml\n name: homepage-config\n subPath: docker.yaml\n - mountPath: /app/config/kubernetes.yaml\n name: homepage-config\n subPath: kubernetes.yaml\n - mountPath: /app/config/services.yaml\n name: homepage-config\n subPath: services.yaml\n - mountPath: /app/config/settings.yaml\n name: homepage-config\n subPath: settings.yaml\n - mountPath: /app/config/widgets.yaml\n name: homepage-config\n subPath: widgets.yaml\n - mountPath: /app/config/logs\n name: logs\n volumes:\n - name: homepage-config\n configMap:\n name: homepage\n - name: logs\n emptyDir: {}\n```\n\n#### Ingress\n\n```yaml\napiVersion: networking.k8s.io/v1\nkind: Ingress\nmetadata:\n name: homepage\n namespace: default\n labels:\n app.kubernetes.io/name: homepage\n annotations:\n gethomepage.dev/description: Dynamically Detected Homepage\n gethomepage.dev/enabled: \"true\"\n gethomepage.dev/group: Cluster Management\n gethomepage.dev/icon: homepage.png\n gethomepage.dev/name: Homepage\nspec:\n rules:\n - host: \"homepage.my.network\"\n http:\n paths:\n - path: \"/\"\n pathType: Prefix\n backend:\n service:\n name: homepage\n port:\n number: 3000\n```\n\n### Multiple Replicas\n\nIf you plan to deploy homepage with a replica count greater than 1, you may\nwant to consider enabling sticky sessions on the homepage route. This will\nprevent unnecessary re-renders on page loads and window / tab focusing. The\nprocedure for enabling sticky sessions depends on your Ingress controller. Below\nis an example using Traefik as the Ingress controller.\n\n```yaml\napiVersion: traefik.io/v1alpha1\nkind: IngressRoute\nmetadata:\n name: homepage.example.com\nspec:\n entryPoints:\n - websecure\n routes:\n - kind: Rule\n match: Host(`homepage.example.com`)\n services:\n - kind: Service\n name: homepage\n port: 3000\n sticky:\n cookie:\n httpOnly: true\n secure: true\n sameSite: none\n```\n" }, { "path": "docs/installation/source.md", "content": "---\ntitle: Source Installation\ndescription: Install and run homepage from source\n---\n\nFirst, clone the repository:\n\n```bash\ngit clone https://github.com/gethomepage/homepage.git\n```\n\nIf `pnpm` is not installed, install it:\n\n```bash\nnpm install -g pnpm\n```\n\nThen install dependencies and build the production bundle:\n\n```bash\npnpm install\npnpm build\n```\n\nIf this is your first time starting, copy the `src/skeleton` directory to `config/` to populate initial example config files.\n\nFinally, run the server:\n\n```bash\nHOMEPAGE_ALLOWED_HOSTS=gethomepage.dev:1234 pnpm start\n```\n\nWhen updating homepage versions you will need to re-build the static files i.e. repeat the process above.\n\nSee [HOMEPAGE_ALLOWED_HOSTS](index.md#homepage_allowed_hosts) for more information on this environment variable.\n" }, { "path": "docs/installation/unraid.md", "content": "---\ntitle: UNRAID Installation\ndescription: Install and run homepage on UNRAID\n---\n\nHomepage has an UNRAID community package that you may use to install homepage. This is the easiest way to get started with homepage on UNRAID.\n\n## Install the Plugin\n\n- In the UNRAID webGUI, go to the **Apps** tab.\n- In the search bar, search for `homepage`.\n- Click on **Install**.\n- Change the parameters to your liking.\n - Click on **APPLY**.\n\n## Run the Container\n\n- While the container is running, open the WebUI.\n - Opening the page will generate the configuration files.\n\nYou may need to set the permissions of the folders to be able to edit the files.\n\n- Click on the Homepage icon.\n- Click on **Console**.\n - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/config` and press **Enter**.\n - Enter `chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons` and press **Enter**.\n - Enter `chown -R nobody:users /app/config` and press **Enter**.\n - Enter `chown -R nobody:users /app/public/icons` and press **Enter**.\n\n## Some Other Notes\n\n- To use the [Docker integration](../configs/docker.md), you only need to use the `container:` parameter. There is no need to set the server.\n\n!!! note\n\n To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, `container:` will still need to be set. For example:\n\n```\n - Plex:\n icon: /icons/plex.png\n href: https://app.plex.com\n container: plex\n```\n\n- When you upload a new image into the **/images** folder, you will need to restart the container for it to show up in the WebUI. Please see the [service icons](../configs/services.md#icons) for more information.\n" }, { "path": "docs/layouts/custom.yml", "content": "# Copyright (c) 2016-2024 Martin Donath \n\n# Permission is hereby granted, free of charge, to any person obtaining a copy\n# of this software and associated documentation files (the \"Software\"), to\n# deal in the Software without restriction, including without limitation the\n# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n# sell copies of the Software, and to permit persons to whom the Software is\n# furnished to do so, subject to the following conditions:\n\n# The above copyright notice and this permission notice shall be included in\n# all copies or substantial portions of the Software.\n\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n# IN THE SOFTWARE.\n\n# -----------------------------------------------------------------------------\n# Configuration\n# -----------------------------------------------------------------------------\n\n# Definitions\ndefinitions:\n # Background image\n - &background_image >-\n {{ layout.background_image | x }}\n\n # Background color (default: indigo)\n - &background_color >-\n {%- if layout.background_color -%}\n {{ layout.background_color }}\n {%- else -%}\n {%- set palette = config.theme.palette or {} -%}\n {%- if not palette is mapping -%}\n {%- set list = palette | selectattr(\"primary\") | list + palette -%}\n {%- set palette = list | first -%}\n {%- endif -%}\n {%- set primary = palette.get(\"primary\", \"indigo\") -%}\n {%- set primary = primary.replace(\" \", \"-\") -%}\n {{ {\n \"red\": \"#ef5552\",\n \"pink\": \"#e92063\",\n \"purple\": \"#ab47bd\",\n \"deep-purple\": \"#7e56c2\",\n \"indigo\": \"#4051b5\",\n \"blue\": \"#2094f3\",\n \"light-blue\": \"#02a6f2\",\n \"cyan\": \"#00bdd6\",\n \"teal\": \"#009485\",\n \"green\": \"#4cae4f\",\n \"light-green\": \"#8bc34b\",\n \"lime\": \"#cbdc38\",\n \"yellow\": \"#ffec3d\",\n \"amber\": \"#ffc105\",\n \"orange\": \"#ffa724\",\n \"deep-orange\": \"#ff6e42\",\n \"brown\": \"#795649\",\n \"grey\": \"#757575\",\n \"blue-grey\": \"#546d78\",\n \"black\": \"#000000\",\n \"white\": \"#ffffff\"\n }[primary] or \"#4051b5\" }}\n {%- endif -%}\n\n # Text color (default: white)\n - &color >-\n {%- if layout.color -%}\n {{ layout.color }}\n {%- else -%}\n {%- set palette = config.theme.palette or {} -%}\n {%- if not palette is mapping -%}\n {%- set list = palette | selectattr(\"primary\") | list + palette -%}\n {%- set palette = list | first -%}\n {%- endif -%}\n {%- set primary = palette.get(\"primary\", \"indigo\") -%}\n {%- set primary = primary.replace(\" \", \"-\") -%}\n {{ {\n \"red\": \"#ffffff\",\n \"pink\": \"#ffffff\",\n \"purple\": \"#ffffff\",\n \"deep-purple\": \"#ffffff\",\n \"indigo\": \"#ffffff\",\n \"blue\": \"#ffffff\",\n \"light-blue\": \"#ffffff\",\n \"cyan\": \"#ffffff\",\n \"teal\": \"#ffffff\",\n \"green\": \"#ffffff\",\n \"light-green\": \"#ffffff\",\n \"lime\": \"#000000\",\n \"yellow\": \"#000000\",\n \"amber\": \"#000000\",\n \"orange\": \"#000000\",\n \"deep-orange\": \"#ffffff\",\n \"brown\": \"#ffffff\",\n \"grey\": \"#ffffff\",\n \"blue-grey\": \"#ffffff\",\n \"black\": \"#ffffff\",\n \"white\": \"#000000\"\n }[primary] or \"#ffffff\" }}\n {%- endif -%}\n\n # Font family (default: Roboto)\n - &font_family >-\n {%- if layout.font_family -%}\n {{ layout.font_family }}\n {%- elif config.theme.font is mapping -%}\n {{ config.theme.font.get(\"text\", \"Roboto\") }}\n {%- else -%}\n Roboto\n {%- endif -%}\n\n # Font variant\n - &font_variant >-\n {%- if layout.font_variant -%}\n {{ layout.font_variant }}\n {%- endif -%}\n\n # Site name\n - &site_name >-\n {{ config.site_name }}\n\n # Page title\n - &page_title >-\n {%- if layout.title -%}\n {{ layout.title }}\n {%- else -%}\n {{ page.meta.get(\"title\", page.title) }}\n {%- endif -%}\n\n # Page title with site name\n - &page_title_with_site_name >-\n {%- if not page.is_homepage -%}\n {{ page.meta.get(\"title\", page.title) }} - {{ config.site_name }}\n {%- else -%}\n {{ page.meta.get(\"title\", page.title) }}\n {%- endif -%}\n\n # Page description\n - &page_description >-\n {%- if layout.description -%}\n {{ layout.description }}\n {%- else -%}\n {{ page.meta.get(\"description\", config.site_description) | x }}\n {%- endif -%}\n\n # Page icon\n - &page_icon >-\n {{ page.meta.icon | x }}\n\n # Logo\n - &logo >-\n {%- if layout.logo -%}\n {{ layout.logo }}\n {%- elif config.theme.logo -%}\n {{ config.docs_dir }}/{{ config.theme.logo }}\n {%- endif -%}\n\n # Logo (icon)\n - &logo_icon >-\n {%- if not layout.logo and config.theme.icon -%}\n {{ config.theme.icon.logo | x }}\n {%- endif -%}\n\n# Meta tags\ntags:\n # Open Graph\n og:type: website\n og:title: *page_title_with_site_name\n og:description: *page_description\n og:image: \"{{ image.url }}\"\n og:image:type: \"{{ image.type }}\"\n og:image:width: \"{{ image.width }}\"\n og:image:height: \"{{ image.height }}\"\n og:url: \"{{ page.canonical_url }}\"\n\n # Twitter\n twitter:card: summary_large_image\n twitter:title: *page_title_with_site_name\n twitter:description: *page_description\n twitter:image: \"{{ image.url }}\"\n\n# -----------------------------------------------------------------------------\n# Specification\n# -----------------------------------------------------------------------------\n\n# Card size and layers\nsize: { width: 1200, height: 630 }\nlayers:\n # Background\n - background:\n image: *background_image\n color: *background_color\n\n # Page icon\n - size: { width: 630, height: 630 }\n offset: { x: 800, y: 0 }\n icon:\n value: *page_icon\n color: \"#FFFFFF20\"\n\n # Logo\n - size: { width: 64, height: 64 }\n offset: { x: 64, y: 64 }\n background:\n image: *logo\n icon:\n value: *logo_icon\n color: *color\n\n # Site name\n - size: { width: 768, height: 42 }\n offset: { x: 160, y: 74 }\n typography:\n content: *site_name\n color: *color\n font:\n family: *font_family\n variant: *font_variant\n style: Bold\n\n # Page title\n - size: { width: 864, height: 256 }\n offset: { x: 62, y: 192 }\n typography:\n content: *page_title\n align: start\n color: *color\n line:\n amount: 3\n height: 1.25\n font:\n family: *font_family\n variant: *font_variant\n style: Bold\n\n # Page description\n - size: { width: 864, height: 64 }\n offset: { x: 64, y: 512 }\n typography:\n content: *page_description\n align: start\n color: *color\n line:\n amount: 2\n height: 1.5\n font:\n family: *font_family\n variant: *font_variant\n style: Regular\n" }, { "path": "docs/more/coverage.md", "content": "---\ntitle: Community Coverage\ndescription: Homepage has been covered by quite a few YouTube channels, here are some of them.\n---\n\nHomepage has been covered by quite a few YouTube channels, here are some of them. If you have a video you'd like to add, please open a PR!\n\n## English\n\n
\n\n[![Youtube Video](https://img.youtube.com/vi/mC3tjysJ01E/maxresdefault.jpg)](https://www.youtube.com/watch?v=mC3tjysJ01E)\n\n[![Youtube Video](https://img.youtube.com/vi/o9SLve4wBPY/maxresdefault.jpg)](https://www.youtube.com/watch?v=o9SLve4wBPY)\n\n[![Youtube Video](https://img.youtube.com/vi/j9kbQucNwlc/maxresdefault.jpg)](https://www.youtube.com/watch?v=j9kbQucNwlc)\n\n[![Youtube Video](https://img.youtube.com/vi/3Ux7zfCCM1A/maxresdefault.jpg)](https://www.youtube.com/watch?v=3Ux7zfCCM1A)\n\n[![Youtube Video](https://img.youtube.com/vi/4AwUNy2eztA/maxresdefault.jpg)](https://www.youtube.com/watch?v=4AwUNy2eztA)\n\n[![Youtube Video](https://img.youtube.com/vi/7mUUCB3kP0E/maxresdefault.jpg)](https://www.youtube.com/watch?v=7mUUCB3kP0E)\n\n[![Youtube Video](https://img.youtube.com/vi/a5-4u0qFKaE/maxresdefault.jpg)](https://www.youtube.com/watch?v=a5-4u0qFKaE)\n\n[![Youtube Video](https://img.youtube.com/vi/tV7-06FU4gQ/maxresdefault.jpg)](https://www.youtube.com/watch?v=tV7-06FU4gQ)\n\n[![Youtube Video](https://img.youtube.com/vi/X2ycbT7rPu4/maxresdefault.jpg)](https://www.youtube.com/watch?v=X2ycbT7rPu4)\n\n[![Youtube Video](https://img.youtube.com/vi/1jEWUJqL-eo/maxresdefault.jpg)](https://www.youtube.com/watch?v=1jEWUJqL-eo)\n\n
\n\n
\n\n
\n## French\n[![Youtube Video](https://img.youtube.com/vi/aGztk8you6o/maxresdefault.jpg)](https://www.youtube.com/watch?v=aGztk8you6o)\n[![Youtube Video](https://img.youtube.com/vi/pQfhWqZh7YE/maxresdefault.jpg)](https://www.youtube.com/watch?v=pQfhWqZh7YE)\n
\n\n
\n## German\n[![Youtube Video](https://img.youtube.com/vi/DrDgg-WRA2g/maxresdefault.jpg)](https://www.youtube.com/watch?v=DrDgg-WRA2g)\n
\n\n
\n## Chinese\n[![Youtube Video](https://img.youtube.com/vi/DAW15ckt4n4/mqdefault.jpg){: style=\"width: 100%\"}](https://www.youtube.com/watch?v=DAW15ckt4n4)\n
\n\n
\n## Russian\n[![Youtube Video](https://img.youtube.com/vi/dk3Cp5ck8mY/maxresdefault.jpg)](https://www.youtube.com/watch?v=dk3Cp5ck8mY)\n
\n\n
\n" }, { "path": "docs/more/homepage-move.md", "content": "---\ntitle: Homepage Move\ndescription: Homepage Container Deprecation\n---\n\nAs of v0.7.2 homepage migrated from benphelps/homepage to an \"organization\" repository located at [gethomepage/homepage](https://github.com/gethomepage/homepage/). The reason for this was to setup the project for longevity and allow for community maintenance.\n\nMigrating your installation should be as simple as changing `image: ghcr.io/benphelps/homepage:latest` to `image: ghcr.io/gethomepage/homepage:latest`.\n" }, { "path": "docs/more/index.md", "content": "---\ntitle: More\ndescription: More homepage resources and guides.\nicon: material/information-slab-circle\n---\n\nHere you'll find resources and guides for Homepage, troubleshooting tips, and more.\n" }, { "path": "docs/more/sponsors.md", "content": "---\ntitle: Sponsors\ndescription: Homepage is supported by these awesome people and companies.\n---\n\nIf you would like to support the Homepage project, you can do so by becoming a sponsor. Your sponsorship helps to keep the project running and growing.\n\n
\n\n[:simple-github: GitHub Sponsors](https://github.com/sponsors/gethomepage){ .md-button }\n\n[:simple-opencollective: OpenCollective](https://opencollective.com/homepage){ .md-button }\n\n[:simple-patreon: Patreon](https://www.patreon.com/gethomepage){ .md-button .w-full }\n\n
\n\n
\n\nThese companies help the Homepage project by providing services, tools, and resources.\n\n
\n
\n \"DigitalOcean\"\n

\n DigitalOcean provides the GitHub Actions runner for the project. Dramatically speeding up the CI/CD process.\n

\n
\n\n
\n \"Crowdin\"\n

\n Crowdin provides the translation platform for the project. Making it easy to translate the project into multiple languages.\n

\n
\n\n
\n \"JetBrains\"\n

\n JetBrains provides the project with free licenses for their awesome tools.\n

\n
\n\n
\n \"BuySellAds\"\n

\n BuySellAds provides the project with the ability to monetize the website, with high quality ads from the CarbonAds network. All earnings are sent directly to the projects OpenCollective.\n

\n
\n
\n\n\n" }, { "path": "docs/more/translations.md", "content": "---\ntitle: Translations\ndescription: Contributing Translations\n---\n\nHomepage is developed in English, component contributions must be in English. All translations are community provided, so a huge thanks go out to all those who have helped out so far!\n\n## Support Translations\n\nIf you'd like to lend a hand in translating Homepage into more languages, or to improve existing translations, the process is very simple:\n\n1. Create a free account at [Crowdin](https://crowdin.com/join)\n2. Visit the [Homepage project](https://crowdin.com/project/gethomepage)\n3. Select the language you'd like to translate\n4. Start translating!\n\n## Adding a new language\n\nIf you'd like to add a new language, please [create a new Discussion on Crowdin](https://crowdin.com/project/gethomepage/discussions), and we'll add it to the project.\n" }, { "path": "docs/overrides/main.html", "content": "{% extends \"base.html\" %}\n\n{% block header %}\n
\n {% include \"partials/header.html\" %}\n{% endblock %}\n\n{% block site_nav %}\n \n {% if nav %}\n {% if page.meta and page.meta.hide %}\n {% set hidden = \"hidden\" if \"navigation\" in page.meta.hide %}\n {% endif %}\n