├── patches └── .placeholder ├── requirements-lint.txt ├── .gitignore ├── .deepsource.toml ├── .github ├── bin │ ├── docker-build │ ├── bleeding │ └── get-buildx-args ├── renovate.json ├── renovate.json.license ├── PULL_REQUEST_TEMPLATE.md.license ├── FUNDING.yml ├── release.yml ├── PULL_REQUEST_TEMPLATE.md ├── workflows │ ├── dependency-review.yml │ ├── hadolint.yml │ ├── bleeding.yml │ ├── label-sync.yml │ ├── pull_requests.yaml │ ├── readme-sync.yml │ ├── dockerimage.yml │ ├── stale.yml │ ├── container-build.yml │ ├── closing.yml │ ├── pre-commit.yml │ ├── labels.yml │ ├── container-test.yml │ └── container-ci.yml ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── feature_request.yml │ └── bug_report.yml └── labels.yml ├── .gitmodules ├── .dockerignore ├── etc ├── supervisor │ ├── conf.d │ │ ├── check.conf │ │ ├── celery-beat.conf │ │ ├── celery-single.conf │ │ ├── celery-backup.conf │ │ ├── celery-celery.conf │ │ ├── celery-memory.conf │ │ ├── celery-notify.conf │ │ ├── celery-translate.conf │ │ └── web.conf │ └── supervisord.conf └── nginx │ ├── ffdhe2048.pem │ ├── generate-site.py │ ├── nginx.conf │ └── default.tpl ├── .yamllint.yml ├── .markdownlint.yml ├── health_check ├── .editorconfig ├── SECURITY.md ├── README.md ├── requirements.txt ├── .pre-commit-config.yaml ├── Dockerfile ├── start └── LICENSE /patches/.placeholder: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements-lint.txt: -------------------------------------------------------------------------------- 1 | pre-commit==4.5.0 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /docker-compose.override.yml 2 | /.venv 3 | -------------------------------------------------------------------------------- /.deepsource.toml: -------------------------------------------------------------------------------- 1 | version = 1 2 | 3 | [[analyzers]] 4 | enabled = true 5 | name = "python" 6 | runtime_version = "3.x.x" 7 | -------------------------------------------------------------------------------- /.github/bin/docker-build: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | eval "docker buildx build $(.github/bin/get-buildx-args "$@" | sed 's/$/ /' | tr -d \\n)" 3 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "docker-compose"] 2 | path = docker-compose 3 | url = https://github.com/WeblateOrg/docker-compose.git 4 | branch = main 5 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "github>WeblateOrg/meta:renovate" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | .github 3 | .gitmodules 4 | .dockerignore 5 | .venv 6 | LICENSE 7 | README.md 8 | SECURITY.md 9 | Dockerfile 10 | docker-compose 11 | requirements-lint.txt 12 | -------------------------------------------------------------------------------- /.github/renovate.json.license: -------------------------------------------------------------------------------- 1 | Copyright © Michal Čihař 2 | 3 | SPDX-License-Identifier: CC0-1.0 4 | 5 | This file is maintained in https://github.com/WeblateOrg/meta/ 6 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md.license: -------------------------------------------------------------------------------- 1 | Copyright © Michal Čihař 2 | 3 | SPDX-License-Identifier: CC0-1.0 4 | 5 | This file is maintained in https://github.com/WeblateOrg/meta/ 6 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/check.conf: -------------------------------------------------------------------------------- 1 | [program:check] 2 | command=bash -c "sleep 60 && exec /app/venv/bin/weblate check --deploy" 3 | autorestart = false 4 | exitcodes = 0,1 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | github: WeblateOrg 7 | open_collective: weblate 8 | liberapay: Weblate 9 | custom: https://weblate.org/donate/ 10 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/celery-beat.conf: -------------------------------------------------------------------------------- 1 | [program:celery-beat] 2 | environment = CELERY_WORKER_RUNNING=1,CELERY_APP=weblate.utils 3 | command = /app/venv/bin/celery beat --loglevel info --pidfile /run/celery/beat.pid %(ENV_CELERY_BEAT_OPTIONS)s 4 | autorestart = true 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | -------------------------------------------------------------------------------- /.yamllint.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | # 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | # 7 | extends: default 8 | 9 | rules: 10 | line-length: 11 | max: 500 12 | level: error 13 | document-start: disable 14 | indentation: 15 | indent-sequences: false 16 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/celery-single.conf: -------------------------------------------------------------------------------- 1 | [program:celery] 2 | environment = CELERY_WORKER_RUNNING=1,CELERY_APP=weblate.utils 3 | command = celery --app=weblate.utils worker --queues=celery,notify,memory,translate,backup --pool=solo %(ENV_CELERY_SINGLE_OPTIONS)s 4 | autorestart = true 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | priority = 400 9 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/celery-backup.conf: -------------------------------------------------------------------------------- 1 | [program:celery-backup] 2 | environment = CELERY_WORKER_RUNNING=1,CELERY_APP=weblate.utils 3 | command = /app/venv/bin/celery worker --hostname 'backup@%%h' --loglevel info --pool=threads --concurrency=1 --queues=backup --prefetch-multiplier=2 %(ENV_CELERY_BACKUP_OPTIONS)s 4 | autorestart = true 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/celery-celery.conf: -------------------------------------------------------------------------------- 1 | [program:celery-celery] 2 | environment = CELERY_WORKER_RUNNING=1,CELERY_APP=weblate.utils 3 | command = /app/venv/bin/celery worker --hostname 'celery@%%h' --loglevel info --queues=celery --pool=threads --prefetch-multiplier=4 %(ENV_CELERY_MAIN_OPTIONS)s 4 | autorestart = true 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | priority = 400 9 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/celery-memory.conf: -------------------------------------------------------------------------------- 1 | [program:celery-memory] 2 | environment = CELERY_WORKER_RUNNING=1,CELERY_APP=weblate.utils 3 | command = /app/venv/bin/celery worker --hostname 'memory@%%h' --loglevel info --queues=memory --pool=threads --prefetch-multiplier=10 %(ENV_CELERY_MEMORY_OPTIONS)s 4 | autorestart = true 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | priority = 600 9 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/celery-notify.conf: -------------------------------------------------------------------------------- 1 | [program:celery-notify] 2 | environment = CELERY_WORKER_RUNNING=1,CELERY_APP=weblate.utils 3 | command = /app/venv/bin/celery worker --hostname 'notify@%%h' --loglevel info --queues=notify --pool=threads --prefetch-multiplier=20 %(ENV_CELERY_NOTIFY_OPTIONS)s 4 | autorestart = true 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | priority = 500 9 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/celery-translate.conf: -------------------------------------------------------------------------------- 1 | [program:celery-translate] 2 | environment = CELERY_WORKER_RUNNING=1,CELERY_APP=weblate.utils 3 | command = /app/venv/bin/celery worker --hostname 'translate@%%h' --loglevel info --queues=translate --pool=threads --prefetch-multiplier=4 %(ENV_CELERY_TRANSLATE_OPTIONS)s 4 | autorestart = true 5 | stdout_logfile=/dev/fd/1 6 | stdout_logfile_maxbytes=0 7 | redirect_stderr=true 8 | priority = 700 9 | -------------------------------------------------------------------------------- /etc/nginx/ffdhe2048.pem: -------------------------------------------------------------------------------- 1 | -----BEGIN DH PARAMETERS----- 2 | MIIBCAKCAQEA//////////+t+FRYortKmq/cViAnPTzx2LnFg84tNpWp4TZBFGQz 3 | +8yTnc4kmz75fS/jY2MMddj2gbICrsRhetPfHtXV/WVhJDP1H18GbtCFY2VVPe0a 4 | 87VXE15/V8k1mE8McODmi3fipona8+/och3xWKE2rec1MKzKT0g6eXq8CrGCsyT7 5 | YdEIqUuyyOP7uWrat2DX9GgdT0Kj3jlN9K5W7edjcrsZCwenyO4KbXCeAvzhzffi 6 | 7MA0BM0oNC9hkXL+nOmFg/+OTxIy7vKBg8P+OxtMb61zO7X8vC7CIAXFjvGDfRaD 7 | ssbzSibBsu/6iGtCOGEoXJf//////////wIBAg== 8 | -----END DH PARAMETERS----- 9 | -------------------------------------------------------------------------------- /.markdownlint.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | # 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | 7 | # We do not enforce heading 8 | first-line-heading: false 9 | 10 | # Table style is not well aligned with Unicode 11 | table-column-style: false 12 | 13 | # Avoid length limit checks 14 | line-length: false 15 | 16 | # Allow manual markup for branding 17 | html: 18 | allowed_elements: [a, img] 19 | -------------------------------------------------------------------------------- /.github/release.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | 7 | changelog: 8 | categories: 9 | - title: Changes and improvements 10 | labels: 11 | - '*' 12 | exclude: 13 | labels: 14 | - dependencies 15 | authors: 16 | - weblate 17 | - title: Dependency updates 18 | labels: 19 | - dependencies 20 | - title: Translation updates 21 | authors: 22 | - weblate 23 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 15 | -------------------------------------------------------------------------------- /health_check: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # Web health check if web is started in this container 4 | if [ -f /run/supervisor.conf.d/web.conf ]; then 5 | if [ -f /app/data/ssl/privkey.pem ]; then 6 | curl --silent --max-time 30 --cacert /app/data/ssl/fullchain.pem https://localhost:4443/healthz/ > /dev/null || exit 1 7 | else 8 | curl --silent --max-time 30 http://localhost:8080/healthz/ > /dev/null || exit 1 9 | fi 10 | fi 11 | 12 | # Supervisor based health check 13 | failing="$(supervisorctl status | grep -v '^check *EXITED' | grep -v RUNNING)" 14 | if [ -n "$failing" ]; then 15 | echo "$failing" 16 | exit 1 17 | fi 18 | -------------------------------------------------------------------------------- /etc/supervisor/conf.d/web.conf: -------------------------------------------------------------------------------- 1 | [program:granian] 2 | command = /app/venv/bin/granian 3 | --no-ws 4 | --workers-max-rss 350 5 | --runtime-mode mt 6 | --interface wsgi 7 | --runtime-threads 4 8 | --backpressure 16 9 | --workers %(ENV_WEB_WORKERS)s 10 | --host 127.0.0.1 11 | --port 8081 12 | weblate.wsgi:application 13 | stdout_logfile=/dev/fd/1 14 | stdout_logfile_maxbytes=0 15 | redirect_stderr=true 16 | autorestart = true 17 | priority = 100 18 | 19 | [program:nginx] 20 | command = /usr/sbin/nginx -g "daemon off;" 21 | stdout_logfile=/dev/fd/1 22 | stdout_logfile_maxbytes=0 23 | redirect_stderr=true 24 | autorestart = true 25 | priority = 200 26 | -------------------------------------------------------------------------------- /.github/workflows/dependency-review.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | name: Dependency Review 7 | on: 8 | pull_request: 9 | 10 | permissions: 11 | contents: read 12 | 13 | jobs: 14 | dependency-review: 15 | runs-on: ubuntu-24.04 16 | steps: 17 | - name: Checkout Repository 18 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 19 | with: 20 | persist-credentials: false 21 | - name: Dependency Review 22 | uses: actions/dependency-review-action@3c4e3dcb1aa7874d2c16be7d79418e9b7efd6261 # v4.8.2 23 | -------------------------------------------------------------------------------- /.github/workflows/hadolint.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | name: Hadolint 7 | 8 | on: 9 | push: 10 | branches-ignore: 11 | - deepsource-fix-** 12 | - renovate/** 13 | - weblate 14 | pull_request: 15 | 16 | permissions: 17 | contents: read 18 | 19 | jobs: 20 | hadolint: 21 | 22 | runs-on: ubuntu-24.04 23 | 24 | steps: 25 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 26 | with: 27 | persist-credentials: false 28 | - uses: hadolint/hadolint-action@2332a7b74a6de0dda2e2221d575162eba76ba5e5 # v3.3.0 29 | -------------------------------------------------------------------------------- /.github/workflows/bleeding.yml: -------------------------------------------------------------------------------- 1 | name: Bleeding Docker Image CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | schedule: 9 | - cron: 0 4 * * * 10 | 11 | concurrency: 12 | group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} 13 | cancel-in-progress: true 14 | 15 | permissions: 16 | contents: read 17 | 18 | jobs: 19 | ci: 20 | uses: ./.github/workflows/container-ci.yml 21 | secrets: 22 | DOCKERHUB_ACCESS_TOKEN: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }} 23 | DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} 24 | permissions: 25 | security-events: write 26 | packages: write 27 | contents: read 28 | with: 29 | variant: bleeding 30 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | 7 | root = true 8 | 9 | [*] 10 | indent_style = space 11 | indent_size = 2 12 | end_of_line = lf 13 | charset = utf-8 14 | trim_trailing_whitespace = true 15 | insert_final_newline = true 16 | spaces_around_operators = true 17 | 18 | [*.bat] 19 | end_of_line = crlf 20 | 21 | [*.html] 22 | indent_size = 2 23 | 24 | [*.py] 25 | indent_size = 4 26 | 27 | [*.rst] 28 | indent_size = 3 29 | 30 | [*.js] 31 | quote_type = double 32 | 33 | [*.{markdown,md}] 34 | trim_trailing_whitespace = false 35 | 36 | [[shell]] 37 | indent_style = space 38 | indent_size = 4 39 | space_redirects = true 40 | simplify = true 41 | -------------------------------------------------------------------------------- /.github/workflows/label-sync.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | name: Sync labels 7 | 8 | on: 9 | push: 10 | branches: 11 | - main 12 | paths: 13 | - .github/labels.yml 14 | - .github/workflows/label-sync.yml 15 | 16 | permissions: 17 | issues: write 18 | 19 | jobs: 20 | build: 21 | name: Sync labels 22 | runs-on: ubuntu-24.04 23 | steps: 24 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 25 | with: 26 | persist-credentials: false 27 | - uses: srealmoreno/label-sync-action@850ba5cef2b25e56c6c420c4feed0319294682fd # v2.0.0 28 | with: 29 | clean-labels: true 30 | -------------------------------------------------------------------------------- /.github/workflows/pull_requests.yaml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | 7 | name: Pull request automation 8 | 9 | on: # zizmor: ignore[dangerous-triggers] 10 | pull_request_target: 11 | types: opened 12 | 13 | permissions: 14 | contents: read 15 | 16 | jobs: 17 | weblate_automerge: 18 | runs-on: ubuntu-24.04 19 | name: Weblate automerge 20 | if: github.actor == 'weblate' 21 | steps: 22 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 23 | with: 24 | persist-credentials: false 25 | - name: Enable Pull Request Automerge 26 | run: gh pr merge --rebase --auto "${{ github.event.pull_request.number }}" 27 | env: 28 | GH_TOKEN: ${{ secrets.WEBLATE_CI_TOKEN }} 29 | -------------------------------------------------------------------------------- /.github/workflows/readme-sync.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | name: Docker Hub Description 6 | on: 7 | push: 8 | branches: 9 | - main 10 | paths: 11 | - README.md 12 | - .github/workflows/readme-sync.yml 13 | jobs: 14 | sync-readme: 15 | runs-on: ubuntu-24.04 16 | if: ${{ github.repository == 'WeblateOrg/docker'}} 17 | steps: 18 | - name: Checkout 19 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 20 | with: 21 | persist-credentials: false 22 | - name: Docker Hub Description 23 | uses: peter-evans/dockerhub-description@1b9a80c056b620d92cedb9d9b5a223409c68ddfa # v5.0.0 24 | with: 25 | username: ${{ secrets.DOCKERHUB_USERNAME }} 26 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 27 | repository: weblate/weblate 28 | short-description: ${{ github.event.repository.description }} 29 | permissions: 30 | contents: read 31 | -------------------------------------------------------------------------------- /.github/bin/bleeding: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | SHA=$1 4 | DATE=$2 5 | 6 | if [ -z "$SHA" ] || [ -z "$DATE" ]; then 7 | echo "Usage: .github/bin/bleeding SHA DATE" 8 | exit 1 9 | fi 10 | 11 | # Install Weblate from main branch 12 | sed -i \ 13 | -e "s/\\(ENV WEBLATE_VERSION=.*\\)/\\1+$(date --date "$DATE" -I)/" \ 14 | -e "/ENV WEBLATE_VERSION/a \ 15 | ENV WEBLATE_DOCKER_GIT_REVISION=$SHA" \ 16 | -e "/LABEL org.opencontainers.image.version/a \ 17 | LABEL org.opencontainers.image.revision=\"$SHA\"" \ 18 | Dockerfile 19 | 20 | # Adjust requirements for bleeding by removing ones we install from Git 21 | sed -i \ 22 | -e '/^translate-toolkit==/ D' \ 23 | -e '/^weblate-language-data==/ D' \ 24 | -e '/^openai==/ D' \ 25 | requirements.txt 26 | 27 | # Consistent timestamp 28 | touch --date="$DATE" Dockerfile 29 | 30 | # Store SHA and date 31 | echo "$SHA" > .github/args-sha 32 | echo "$DATE" | sed 's/T.*//' > .github/args-date 33 | 34 | cat Dockerfile 35 | 36 | # Remove patches 37 | find patches -name '*.patch' -delete 38 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | 8 | 9 | # Weblate security 10 | 11 | The Weblate team takes security and related transparency very seriously. 12 | We welcome any peer review of our 100% open-source code to ensure nobody's Weblate 13 | is ever compromised or hacked. 14 | 15 | If you think you have identified a security issue with a Weblate project, **do 16 | not open a public issue**. 17 | 18 | To responsibly report a security issue, please navigate to the Security tab for 19 | the repository and click “Report a vulnerability”. 20 | 21 | Be sure to include as much detail as necessary in your report. As with 22 | reporting normal issues, a minimal reproducible example will help the 23 | maintainers address the issue faster. 24 | 25 | More information about practices for reporting and fixing security issues is 26 | described in [our documentation][1]. This ensures all vulnerabilities are 27 | solved securely, quickly, and transparently. 28 | 29 | [1]: https://docs.weblate.org/en/latest/security/issues.html 30 | -------------------------------------------------------------------------------- /.github/workflows/dockerimage.yml: -------------------------------------------------------------------------------- 1 | name: Docker Image CI 2 | 3 | on: 4 | push: 5 | branches-ignore: 6 | - renovate/** 7 | tags: 8 | - '*' 9 | pull_request: 10 | 11 | concurrency: 12 | group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} 13 | cancel-in-progress: true 14 | 15 | permissions: 16 | contents: read 17 | 18 | jobs: 19 | ci: 20 | uses: ./.github/workflows/container-ci.yml 21 | secrets: 22 | DOCKERHUB_ACCESS_TOKEN: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }} 23 | DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} 24 | permissions: 25 | security-events: write 26 | packages: write 27 | contents: read 28 | with: 29 | variant: stable 30 | 31 | release_github: 32 | runs-on: ubuntu-24.04 33 | name: Create release on GitHub 34 | permissions: 35 | contents: write 36 | needs: 37 | - ci 38 | if: ${{ startsWith(github.ref, 'refs/tags/') && github.repository == 'WeblateOrg/docker' }} 39 | steps: 40 | - uses: ncipollo/release-action@b7eabc95ff50cbeeedec83973935c8f306dfcd0b # v1.20.0 41 | with: 42 | generateReleaseNotes: true 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Weblate 2 | 3 | **Weblate is libre software web-based continuous localization system, 4 | used by over 2500 libre projects and companies in more than 165 countries.** 5 | 6 | # Official Docker container for Weblate 7 | 8 | [![Website](https://img.shields.io/badge/website-weblate.org-blue.svg)](https://weblate.org/) 9 | [![Translation status](https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg)](https://hosted.weblate.org/engage/weblate/?utm_source=widget) 10 | [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/552/badge)](https://bestpractices.coreinfrastructure.org/projects/552) 11 | [![Documentation](https://readthedocs.org/projects/weblate/badge/)][doc] 12 | 13 | ## Running Weblate 14 | 15 | - [Weblate docker-compose](https://github.com/WeblateOrg/docker-compose) 16 | - [OpenShift](https://docs.weblate.org/en/latest/admin/install/openshift.html) 17 | - [Helm chart for Weblate](https://hub.helm.sh/charts/weblate/weblate) 18 | 19 | ## Exposed ports 20 | 21 | The webserver is running on the port 8080. 22 | 23 | ## Documentation 24 | 25 | Detailed documentation is available in [Weblate documentation][doc]. 26 | 27 | [doc]: https://docs.weblate.org/en/latest/admin/install/docker.html 28 | -------------------------------------------------------------------------------- /etc/nginx/generate-site.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import django 3 | import sys 4 | from django.conf import settings 5 | 6 | # Parse args 7 | ( 8 | TEMPLATE_DIRS, 9 | WEBLATE_URL_PREFIX, 10 | WEBLATE_REALIP, 11 | CLIENT_MAX_BODY_SIZE, 12 | WEBLATE_BUILTIN_SSL, 13 | WEBLATE_ANUBIS_URL, 14 | SITE_DOMAIN, 15 | ENABLE_HTTPS, 16 | ) = sys.argv[1:] 17 | 18 | WEBLATE_SITE_URL = "{}://{}".format( 19 | "https" 20 | if ENABLE_HTTPS and ENABLE_HTTPS.lower() not in {"0", "false", "no", "off"} 21 | else "http", 22 | SITE_DOMAIN, 23 | ) 24 | 25 | # Configure Django 26 | TEMPLATES = [ 27 | { 28 | "BACKEND": "django.template.backends.django.DjangoTemplates", 29 | "DIRS": [TEMPLATE_DIRS], 30 | } 31 | ] 32 | settings.configure(TEMPLATES=TEMPLATES) 33 | django.setup() 34 | 35 | # Now we can use templates 36 | from django.template.loader import get_template # noqa: E402 37 | 38 | template = get_template("default.tpl") 39 | print( 40 | template.render( 41 | { 42 | "WEBLATE_URL_PREFIX": WEBLATE_URL_PREFIX, 43 | "WEBLATE_REALIP": WEBLATE_REALIP, 44 | "CLIENT_MAX_BODY_SIZE": CLIENT_MAX_BODY_SIZE, 45 | "WEBLATE_BUILTIN_SSL": WEBLATE_BUILTIN_SSL, 46 | "WEBLATE_ANUBIS_URL": WEBLATE_ANUBIS_URL, 47 | "WEBLATE_SITE_URL": WEBLATE_SITE_URL, 48 | } 49 | ) 50 | ) 51 | -------------------------------------------------------------------------------- /etc/supervisor/supervisord.conf: -------------------------------------------------------------------------------- 1 | ; supervisor config file 2 | 3 | [unix_http_server] 4 | file=/run/supervisor.sock ; (the path to the socket file) 5 | chmod=0700 ; sockef file mode (default 0700) 6 | ; The only purpose of this file is to silent "CRITICAL" error 7 | ; when starting up, see https://github.com/Supervisor/supervisor/issues/694 8 | username = dummy 9 | password = dummy 10 | 11 | [supervisord] 12 | logfile=/dev/null ; (main log file;default $CWD/supervisord.log) 13 | logfile_maxbytes=0 14 | nodaemon=true 15 | pidfile=/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid) 16 | 17 | ; the below section must remain in the config file for RPC 18 | ; (supervisorctl/web interface) to work, additional interfaces may be 19 | ; added by defining them in separate rpcinterface: sections 20 | [rpcinterface:supervisor] 21 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 22 | 23 | [supervisorctl] 24 | serverurl=unix:///run/supervisor.sock ; use a unix:// URL for a unix socket 25 | username = dummy 26 | password = dummy 27 | 28 | ; The [include] section can just contain the "files" setting. This 29 | ; setting can list multiple files (separated by whitespace or 30 | ; newlines). It can also contain wildcards. The filenames are 31 | ; interpreted as relative to this file. Included files *cannot* 32 | ; include files themselves. 33 | 34 | [include] 35 | files = /run/supervisor.conf.d/*.conf 36 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | # 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | # and generated using update-issue-config there. 7 | blank_issues_enabled: false 8 | contact_links: 9 | - name: Weblate issue tracker 10 | url: https://github.com/WeblateOrg/weblate/issues/ 11 | about: For issues not specific to the Docker deployment. 12 | - name: translation-finder issue tracker 13 | url: https://github.com/WeblateOrg/translation-finder/issues/ 14 | about: If this issue only involves translations discovery while importing, please open a new issue there. 15 | - name: wlc issue tracker 16 | url: https://github.com/WeblateOrg/wlc/issues/ 17 | about: If this issue only involves command line client, please open a new issue there. 18 | - name: Get professional support 19 | url: https://weblate.org/support/ 20 | about: As a subscriber, you will always receive fast and helpful replies from our dedicated support team. More responsible and faster for your business, also makes Weblate stronger. 21 | - name: Read our clear, thorough and localized docs 22 | url: https://docs.weblate.org/ 23 | about: Save your time! There is an instant solution for many issues in the docs appreciated by numerous users. And it might be in your preferred language. 24 | - name: Ask the community 25 | url: https://github.com/WeblateOrg/weblate/discussions 26 | about: Want to discuss something with a community? Do it in discussions! 27 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aeidon==1.15 2 | ahocorasick-rs==1.0.3 3 | aliyun-python-sdk-alimt==3.2.0 4 | altcha==1.0.0 5 | argon2-cffi==25.1.0 6 | borgbackup==1.4.3 7 | boto3==1.42.10 8 | celery==5.6.0 9 | certifi==2025.11.12 10 | # For Argon2 and misaka 11 | cffi==2.0.0 12 | # For Azure Tenant auth 13 | cryptography==46.0.3 14 | Django==5.2.9 15 | django-appconf==1.2.0 16 | django-auth-ldap==5.2.0 17 | django-celery-beat==2.8.1 18 | django-cors-headers==4.9.0 19 | django-crispy-forms==2.5 20 | django-otp==1.6.3 21 | django-otp-webauthn==0.7.0 22 | django-redis==6.0.0 23 | django_compressor==4.6.0 24 | djangorestframework==3.16.1 25 | # Alernative Celery pool implementation 26 | gevent==25.9.1 27 | git-review==2.5.0 28 | google-cloud-translate==3.23.0 29 | granian==2.6.0 30 | hiredis==3.3.0 31 | html2text==2025.4.15 32 | iniparse==0.5 33 | lxml==6.0.2 34 | mercurial==7.1.2 35 | mistletoe==1.5.1 36 | nh3==0.3.2 37 | openai==2.12.0 38 | openpyxl==3.1.5 39 | phply==1.2.6 40 | Pillow==12.0.0 41 | psycopg[binary]==3.3.2 42 | Pygments==2.19.2 43 | pyOpenSSL==25.3.0 44 | pyparsing==3.2.5 45 | python-akismet==0.4.3 46 | python-dateutil==2.9.0.post0 47 | python3-saml==1.16.0 48 | qrcode==8.2 49 | rapidfuzz==3.14.3 50 | raven 51 | redis==5.2.1 52 | requests==2.32.5 53 | rollbar==1.3.0 54 | ruamel.yaml==0.18.16 55 | sentry-sdk==2.47.0 56 | siphashc==2.7 57 | social-auth-app-django==5.6.0 58 | social-auth-core==4.8.1 59 | supervisor==4.3.0 60 | tesserocr==2.9.1 61 | tomlkit==0.13.3 62 | translate-toolkit==3.17.4 63 | translation-finder==2.23 64 | unicode-segmentation-rs==0.2.1 65 | urllib3==2.6.2 66 | weblate-language-data==2025.9 67 | wllegal==2025.9 68 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | name: Close stale 7 | 8 | on: 9 | schedule: 10 | - cron: 30 1 * * * 11 | push: 12 | branches: 13 | - main 14 | paths: 15 | - .github/workflows/stale.yml 16 | workflow_dispatch: 17 | 18 | permissions: 19 | contents: read 20 | 21 | jobs: 22 | stale-issues: 23 | runs-on: ubuntu-24.04 24 | permissions: 25 | issues: write 26 | pull-requests: write 27 | 28 | steps: 29 | - uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1 30 | with: 31 | days-before-pr-stale: 30 32 | days-before-pr-close: 14 33 | days-before-stale: 14 34 | days-before-close: 5 35 | exempt-issue-labels: bug,enhancement,documentation,security,dependencies 36 | exempt-pr-labels: backlog 37 | stale-issue-label: wontfix 38 | stale-pr-label: wontfix 39 | repo-token: ${{ secrets.GITHUB_TOKEN }} 40 | stale-issue-message: | 41 | This issue has been automatically marked as stale because there wasn’t any recent activity. 42 | 43 | It will be closed soon if no further action occurs. 44 | 45 | Thank you for your contributions! 46 | stale-pr-message: | 47 | This pull request has been automatically marked as stale because there wasn’t any recent activity. 48 | 49 | It will be closed soon if no further action occurs. 50 | 51 | Thank you for your contributions! 52 | -------------------------------------------------------------------------------- /etc/nginx/nginx.conf: -------------------------------------------------------------------------------- 1 | worker_processes auto; 2 | 3 | pid /run/nginx.pid; 4 | error_log /var/log/nginx/error.log; 5 | include /etc/nginx/modules-enabled/*.conf; 6 | 7 | events { 8 | worker_connections 768; 9 | # multi_accept on; 10 | } 11 | 12 | http { 13 | 14 | ## 15 | # Basic Settings 16 | ## 17 | 18 | sendfile on; 19 | tcp_nopush on; 20 | types_hash_max_size 2048; 21 | # server_tokens off; 22 | 23 | # server_names_hash_bucket_size 64; 24 | # server_name_in_redirect off; 25 | 26 | include /etc/nginx/mime.types; 27 | default_type application/octet-stream; 28 | 29 | client_body_temp_path /tmp/nginx/body; 30 | fastcgi_temp_path /tmp/nginx/fastcgi; 31 | proxy_temp_path /tmp/nginx/proxy; 32 | scgi_temp_path /tmp/nginx/scgi; 33 | uwsgi_temp_path /tmp/nginx/uwsgi; 34 | 35 | ## 36 | # SSL Settings 37 | ## 38 | 39 | ssl_protocols TLSv1.2 TLSv1.3; 40 | ssl_prefer_server_ciphers on; 41 | 42 | ## 43 | # Logging Settings 44 | ## 45 | 46 | access_log /var/log/nginx/access.log; 47 | 48 | ## 49 | # Gzip Settings 50 | ## 51 | 52 | gzip on; 53 | 54 | # gzip_vary on; 55 | # gzip_proxied any; 56 | # gzip_comp_level 6; 57 | # gzip_buffers 16 8k; 58 | # gzip_http_version 1.1; 59 | # gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; 60 | 61 | ## 62 | # Virtual Host Configs 63 | ## 64 | 65 | include /etc/nginx/conf.d/*.conf; 66 | include /etc/nginx/sites-enabled/*; 67 | } 68 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | # and generated from .github/ISSUE_TEMPLATE/snippets there. 7 | name: Feature request 8 | description: Suggest an idea for this project 9 | body: 10 | - type: markdown 11 | attributes: 12 | value: | 13 | Thank you for requesting a change. 14 | This form guides you in creating a useful feature request. 15 | 16 | Want your answer quickly and guaranteed? Visit https://weblate.org/support/ to reach our dedicated support team. As a subscriber, you will always have priority and help Weblate growing. 17 | - type: textarea 18 | id: describe 19 | attributes: 20 | label: Describe the problem 21 | description: > 22 | Is your feature request related to a problem? If so, please provide 23 | a clear and concise description of what the problem is. 24 | placeholder: I'm always frustrated when… 25 | validations: 26 | required: true 27 | - type: textarea 28 | id: solution 29 | attributes: 30 | label: Solution brainstorm 31 | description: We know you have ideas how to address this, please share it. 32 | placeholder: I'd like to get… 33 | validations: 34 | required: true 35 | - type: textarea 36 | id: alternatives 37 | attributes: 38 | label: Describe alternatives you have considered 39 | description: A clear and concise description of any alternative solutions or features you have considered. 40 | placeholder: The issue can also be addressed by… 41 | - type: textarea 42 | id: screenshots 43 | attributes: 44 | label: Screenshots 45 | description: If applicable, add screenshots to better explain your problem. 46 | - type: textarea 47 | id: additional 48 | attributes: 49 | label: Additional context 50 | description: Add any other contextual info about the problem here. 51 | -------------------------------------------------------------------------------- /.github/labels.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | 7 | # Default GitHub labels 8 | - color: d73a4a 9 | name: bug 10 | description: Something is broken. 11 | - color: ffffff 12 | name: duplicate 13 | description: Similar issue or pull request already exists. 14 | - color: a2eeef 15 | name: enhancement 16 | description: Adding or requesting a new feature. 17 | - color: 7057ff 18 | name: good first issue 19 | description: Opportunity for newcoming contributors. 20 | - color: 7057ff 21 | name: help wanted 22 | description: Extra attention is needed. 23 | - color: ffffff 24 | name: invalid 25 | description: This doesn’t seem right. 26 | - color: d876e3 27 | name: question 28 | description: This is more a question for the support than an issue. 29 | - color: ffffff 30 | name: wontfix 31 | description: Nobody will work on this. 32 | # Automated dependency updates 33 | - color: e3f49c 34 | name: dependencies 35 | description: Third-party library dependencies. 36 | # Hacktoberfest 37 | - color: 7057ff 38 | name: hacktoberfest 39 | description: This is suitable for Hacktoberfest. Don’t try to spam. 40 | # Weblate specific 41 | - color: 87a2f2 42 | name: backlog 43 | description: This is not on the Weblate roadmap for now. Can be prioritized by sponsorship. 44 | - color: 0075ca 45 | name: documentation 46 | description: Improvements or additions to the documentation. 47 | - color: e3f49c 48 | name: hosted 49 | description: Issues affecting Hosted Weblate service. 50 | - color: e3f49c 51 | name: naming 52 | description: Discussions about naming Weblate features. 53 | - color: fef2c0 54 | name: translate-toolkit 55 | description: Issues which need to be fixed in the translate-toolkit 56 | - color: 87a2f2 57 | name: undecided 58 | description: These features might not be implemented. Can be prioritized by sponsorship. 59 | - color: e3f49c 60 | name: ux 61 | description: Issues related to user experience. 62 | - color: b38ddd 63 | name: needinfo 64 | description: This needs more information from the reporter to be implemented. 65 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | # See https://pre-commit.com for more information 2 | # See https://pre-commit.com/hooks.html for more hooks 3 | repos: 4 | - repo: https://github.com/pre-commit/pre-commit-hooks 5 | rev: v6.0.0 6 | hooks: 7 | - id: trailing-whitespace 8 | - id: end-of-file-fixer 9 | - id: check-yaml 10 | - id: requirements-txt-fixer 11 | - id: check-merge-conflict 12 | - id: check-json 13 | - id: mixed-line-ending 14 | args: [--fix=lf] 15 | - id: pretty-format-json 16 | args: [--no-sort-keys, --autofix, --no-ensure-ascii] 17 | - repo: https://github.com/adrienverge/yamllint 18 | rev: v1.37.1 19 | hooks: 20 | - id: yamllint 21 | - repo: meta 22 | hooks: 23 | - id: check-hooks-apply 24 | - id: check-useless-excludes 25 | - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks 26 | rev: v2.15.0 27 | hooks: 28 | - id: pretty-format-yaml 29 | args: [--autofix, --indent, '2'] 30 | - id: pretty-format-toml 31 | args: [--autofix] 32 | - repo: https://github.com/executablebooks/mdformat 33 | rev: 1.0.0 34 | hooks: 35 | - id: mdformat 36 | additional_dependencies: 37 | - mdformat-gfm==1.0.0 38 | - repo: https://github.com/shellcheck-py/shellcheck-py 39 | rev: v0.11.0.1 40 | hooks: 41 | - id: shellcheck 42 | require_serial: true 43 | - repo: https://github.com/scop/pre-commit-shfmt 44 | rev: v3.12.0-2 45 | hooks: 46 | - id: shfmt 47 | args: [--write] 48 | - repo: https://github.com/rhysd/actionlint 49 | rev: v1.7.9 50 | hooks: 51 | - id: actionlint 52 | - repo: https://github.com/zizmorcore/zizmor-pre-commit 53 | rev: v1.18.0 54 | hooks: 55 | - id: zizmor 56 | - repo: https://github.com/astral-sh/ruff-pre-commit 57 | rev: v0.14.9 58 | hooks: 59 | - id: ruff-check 60 | args: 61 | - --fix 62 | - --exit-non-zero-on-fix 63 | - id: ruff-format 64 | - repo: https://github.com/adamchainz/djade-pre-commit 65 | rev: 1.7.0 66 | hooks: 67 | - id: djade 68 | args: [--target-version, '5.1'] 69 | files: etc/nginx/default.tpl 70 | - repo: https://github.com/crate-ci/typos 71 | rev: v1.40.0 72 | hooks: 73 | - id: typos 74 | args: [] 75 | require_serial: true 76 | pass_filenames: false 77 | - repo: https://github.com/gitleaks/gitleaks 78 | rev: v8.30.0 79 | hooks: 80 | - id: gitleaks 81 | ci: 82 | autoupdate_schedule: quarterly 83 | skip: [] 84 | -------------------------------------------------------------------------------- /.github/workflows/container-build.yml: -------------------------------------------------------------------------------- 1 | name: Docker container build 2 | 3 | on: 4 | workflow_call: 5 | inputs: 6 | variant: 7 | required: true 8 | type: string 9 | architecture: 10 | required: true 11 | type: string 12 | weblate_sha: 13 | required: false 14 | type: string 15 | weblate_date: 16 | required: false 17 | type: string 18 | 19 | jobs: 20 | container-build: 21 | runs-on: ${{ inputs.architecture == 'arm64' && 'ubuntu-24.04-arm' || 'ubuntu-24.04' }} 22 | name: Build, ${{ inputs.variant }}, ${{ inputs.architecture }} 23 | env: 24 | MATRIX_ARCHITECTURE: linux/${{ inputs.architecture }} 25 | steps: 26 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 27 | with: 28 | persist-credentials: false 29 | - name: uv cache 30 | uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 31 | id: cache 32 | with: 33 | path: uv-cache 34 | key: uv-cache-${{ hashFiles('Dockerfile') }}-${{ inputs.architecture }} 35 | - name: Set up QEMU 36 | if: inputs.architecture != 'amd64' && inputs.architecture != 'arm64' 37 | uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0 38 | with: 39 | platforms: linux/${{ inputs.architecture }} 40 | - name: Expose GitHub Runtime 41 | uses: crazy-max/ghaction-github-runtime@3cb05d89e1f492524af3d41a1c98c83bc3025124 # v3.1.0 42 | - name: Set up Docker Buildx 43 | uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 44 | - name: Adjust bleeding edge image 45 | if: inputs.variant == 'bleeding' 46 | run: .github/bin/bleeding "$WEBLATE_SHA" "$WEBLATE_DATE" 47 | env: 48 | WEBLATE_SHA: ${{ inputs.weblate_sha }} 49 | WEBLATE_DATE: ${{ inputs.weblate_date }} 50 | - name: Configure Docker build 51 | run: .github/bin/get-buildx-args 52 | - name: inject cache into docker 53 | uses: reproducible-containers/buildkit-cache-dance@5b81f4d29dc8397a7d341dba3aeecc7ec54d6361 # v3.3.0 54 | with: 55 | cache-map: | 56 | { 57 | "uv-cache": "/.uv-cache" 58 | } 59 | skip-extraction: ${{ steps.cache.outputs.cache-hit }} 60 | - run: mkdir -p "/tmp/.buildx-cache/$MATRIX_ARCHITECTURE" 61 | - name: Build the Docker image 62 | run: .github/bin/docker-build 63 | - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 64 | with: 65 | name: Docker cache ${{ inputs.architecture }} 66 | path: /tmp/.buildx-cache/linux/${{ inputs.architecture }} 67 | retention-days: 1 68 | permissions: 69 | contents: read 70 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | # and generated from .github/ISSUE_TEMPLATE/snippets there. 7 | name: Reproducible bug report 8 | description: Create a report to help us improve 9 | body: 10 | - type: markdown 11 | attributes: 12 | value: | 13 | Thank you for reporting an issue. 14 | This form guides you in creating a useful issue report. 15 | 16 | Want your answer quickly and guaranteed? Visit https://weblate.org/support/ to reach our dedicated support team. As a subscriber, you will always have priority and help Weblate growing. 17 | - type: textarea 18 | id: what-happened 19 | attributes: 20 | label: Describe the issue 21 | description: > 22 | A clear and concise description of the problem you are facing. 23 | 24 | Please include important information, like the file format you are using and installed add-ons. 25 | placeholder: Tell us what you see! 26 | validations: 27 | required: true 28 | - type: checkboxes 29 | id: tried 30 | attributes: 31 | label: I already tried 32 | description: If you didn’t try already, try searching the documentation and existing issues. 33 | options: 34 | - label: I've read and searched [the documentation](https://docs.weblate.org/). 35 | required: true 36 | - label: I've searched for similar filed issues in this repository. 37 | required: true 38 | - type: textarea 39 | id: reproducer 40 | attributes: 41 | label: Steps to reproduce the behavior 42 | description: What did you do before the problem appeared? 43 | placeholder: | 44 | 1. Go to '…' 45 | 2. Scroll down to '…' 46 | 3. Click on '…' 47 | 4. The error occurs 48 | validations: 49 | required: true 50 | - type: textarea 51 | id: expected 52 | attributes: 53 | label: Expected behavior 54 | description: A clear and concise description of what you expected to happen. 55 | placeholder: Tell us what you want to see! 56 | - type: textarea 57 | id: screenshots 58 | attributes: 59 | label: Screenshots 60 | description: If applicable, add screenshots to better explain your problem. 61 | - type: textarea 62 | id: traceback 63 | attributes: 64 | label: Exception traceback 65 | description: > 66 | In case you observed a server error or crash, please read 67 | [the debugging documentation](https://docs.weblate.org/en/latest/contributing/debugging.html) 68 | for information on obtaining the relevant logs. 69 | 70 | This field will be rendered as a Python traceback automatically. 71 | render: pytb 72 | - type: textarea 73 | id: additional 74 | attributes: 75 | label: Additional context 76 | description: Add any other contextual info about the problem here. 77 | -------------------------------------------------------------------------------- /.github/bin/get-buildx-args: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # Copyright © Michal Čihař 4 | # 5 | # SPDX-License-Identifier: GPL-3.0-or-later 6 | 7 | # Generate command-line options for docker buildx build 8 | 9 | # Load from local cache 10 | if [ -n "$MATRIX_ARCHITECTURE" ]; then 11 | echo --cache-from "type=local,src=/tmp/.buildx-cache/$MATRIX_ARCHITECTURE" 12 | else 13 | for arch in linux/amd64 linux/arm64; do 14 | echo --cache-from "type=local,src=/tmp/.buildx-cache/$arch" 15 | done 16 | fi 17 | 18 | # Expose annotations 19 | if [ "$1" != "load" ]; then 20 | WEBLATE_VERSION=$(sed -n 's/^ENV WEBLATE_VERSION=\(.*\)/\1/p' Dockerfile | head -n 1) 21 | sed -n "s/^LABEL \(org.opencontainers.image.*\)/--annotation index:\1/p" Dockerfile | sed -e "s/\\\$WEBLATE_VERSION/${WEBLATE_VERSION}/" 22 | fi 23 | 24 | # Write to local cache when building (also not compatible with push) 25 | if [ "$1" != "publish" ] && [ "$1" != "load" ]; then 26 | echo --cache-to "type=local,dest=/tmp/.buildx-cache/$MATRIX_ARCHITECTURE,mode=max" 27 | fi 28 | 29 | if [ "$1" = "load" ]; then 30 | # Ommit list of platforms loading, see https://github.com/docker/buildx/issues/59 31 | echo --output=type=docker 32 | # Test tag, to avoid collistion with real ones 33 | echo --tag weblate/weblate:test 34 | else 35 | # List of platforms 36 | echo --platform "${MATRIX_ARCHITECTURE:-linux/amd64,linux/arm64}" 37 | # Enable more platforms in future: 38 | # linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64,linux/386,linux/ppc64le,linux/s390x 39 | 40 | if [ "$1" = "publish-bleeding" ]; then 41 | # Publishing bleeding edge image 42 | echo --output "type=image,push=true" 43 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:bleeding" 44 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:bleeding-$(cat .github/args-date)-$(cat .github/args-sha)" 45 | elif [ "$1" = "publish" ] || [ "$1" = "publish-stable" ]; then 46 | # Publishing normal image 47 | echo --output "type=image,push=true" 48 | 49 | # Generate tags 50 | case "$GITHUB_REF" in 51 | refs/tags/[0-9]*) 52 | RELEASE="${GITHUB_REF#refs/tags/}" 53 | MINOR="${RELEASE%.*.*}" 54 | MAJOR="${MINOR%.*}" 55 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:$RELEASE" 56 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:$MINOR" 57 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:$MAJOR" 58 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:latest" 59 | ;; 60 | refs/heads/main) 61 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:edge" 62 | echo --tag "${DOCKER_IMAGE:-weblate/weblate}:edge-$(date -I)-${GITHUB_SHA}" 63 | ;; 64 | esac 65 | else 66 | echo --output "type=image,push=false" 67 | fi 68 | fi 69 | 70 | # Location 71 | echo --file ./Dockerfile . 72 | -------------------------------------------------------------------------------- /.github/workflows/closing.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | name: Issue closed 7 | 8 | on: 9 | issues: 10 | types: [closed] 11 | 12 | concurrency: 13 | group: ${{ github.workflow }}-${{ github.event.issue.id }} 14 | cancel-in-progress: true 15 | 16 | permissions: 17 | contents: read 18 | 19 | jobs: 20 | issueClosed: 21 | permissions: 22 | issues: write # for peter-evans/create-or-update-comment to create or update comment 23 | pull-requests: write # for peter-evans/create-or-update-comment to create or update comment 24 | runs-on: ubuntu-24.04 25 | steps: 26 | - name: Add closed question comment 27 | uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 28 | if: | 29 | github.actor != 'renovate[bot]' && 30 | github.event.issue.state_reason == 'completed' && 31 | (( 32 | contains(github.event.issue.labels.*.name, 'question') && 33 | ! contains(github.event.issue.labels.*.name, 'duplicate') && 34 | ! contains(github.event.issue.labels.*.name, 'wontfix') 35 | ) || join(github.event.issue.labels.*.name) == '') 36 | with: 37 | token: ${{ secrets.GITHUB_TOKEN }} 38 | issue-number: ${{ github.event.issue.number }} 39 | body: | 40 | The issue you have reported is now resolved. If you don’t feel it’s right, please follow its labels to get a clue for further steps. 41 | 42 | * In case you see a similar problem, please open a separate issue. 43 | * If you are happy with the outcome, don’t hesitate to support Weblate by making a [donation](https://weblate.org/donate/). 44 | - name: Add closed issue comment 45 | uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 46 | if: | 47 | github.actor != 'renovate[bot]' && 48 | github.event.issue.state_reason == 'completed' && 49 | ! contains(github.event.issue.labels.*.name, 'invalid') && 50 | ! contains(github.event.issue.labels.*.name, 'question') && 51 | ! contains(github.event.issue.labels.*.name, 'wontfix') && 52 | ! contains(github.event.issue.labels.*.name, 'duplicate') && 53 | ! contains(github.event.issue.labels.*.name, 'undecided') && 54 | ! contains(github.event.issue.labels.*.name, 'needinfo') && 55 | join(github.event.issue.labels.*.name) != '' 56 | with: 57 | token: ${{ secrets.GITHUB_TOKEN }} 58 | issue-number: ${{ github.event.issue.number }} 59 | body: | 60 | Thank you for your report; the issue you have reported has just been fixed. 61 | 62 | * In case you see a problem with the fix, please comment on this issue. 63 | * In case you see a similar problem, please open a separate issue. 64 | * If you are happy with the outcome, don’t hesitate to support Weblate by making a [donation](https://weblate.org/donate/). 65 | -------------------------------------------------------------------------------- /etc/nginx/default.tpl: -------------------------------------------------------------------------------- 1 | server { 2 | {% if WEBLATE_BUILTIN_SSL %} 3 | listen 4443 ssl; 4 | 5 | ssl_certificate /app/data/ssl/fullchain.pem; 6 | ssl_certificate_key /app/data/ssl/privkey.pem; 7 | 8 | ssl_session_timeout 1d; 9 | ssl_session_cache shared:MozSSL:10m; # about 40000 sessions 10 | ssl_session_tickets off; 11 | 12 | # generated 2025-05-07, Mozilla Guideline v5.7, nginx 1.26.3, OpenSSL 3.4.1, intermediate config 13 | ssl_protocols TLSv1.2 TLSv1.3; 14 | ssl_ecdh_curve X25519:prime256v1:secp384r1; 15 | ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-CHACHA20-POLY1305; 16 | ssl_prefer_server_ciphers off; 17 | 18 | ssl_dhparam /etc/nginx/ffdhe2048.pem; 19 | {% else %} 20 | listen 8080 default_server; 21 | {% endif %} 22 | root /app/cache/static; 23 | client_max_body_size {{ CLIENT_MAX_BODY_SIZE }}; 24 | server_tokens off; 25 | port_in_redirect off; 26 | 27 | {{ WEBLATE_REALIP }} 28 | 29 | {% if WEBLATE_ANUBIS_URL %} 30 | location /.within.website/x/cmd/anubis/static/img/ { 31 | alias /app/cache/static/anubis/; 32 | } 33 | 34 | location /.within.website/ { 35 | proxy_pass {{ WEBLATE_ANUBIS_URL }}; 36 | auth_request off; 37 | proxy_set_header X-Real-IP $remote_addr; 38 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 39 | proxy_set_header Host $http_host; 40 | proxy_set_header X-Original-URI $request_uri; 41 | proxy_set_header X-Forwarded-Host $http_host; 42 | proxy_pass_request_body off; 43 | proxy_set_header content-length ""; 44 | } 45 | 46 | location @redirectToAnubis { 47 | return 307 {{ WEBLATE_SITE_URL }}/.within.website/?redir=$scheme://$host$request_uri; 48 | auth_request off; 49 | } 50 | {% endif %} 51 | 52 | location ~ ^/favicon.ico$ { 53 | # DATA_DIR/static/favicon.ico 54 | alias /app/cache/static/favicon.ico; 55 | expires 30d; 56 | } 57 | 58 | location {{ WEBLATE_URL_PREFIX }}/static/ { 59 | # DATA_DIR/static/ 60 | alias /app/cache/static/; 61 | expires 30d; 62 | } 63 | 64 | location {{ WEBLATE_URL_PREFIX }}/media/ { 65 | # DATA_DIR/media/ 66 | alias /app/data/media/; 67 | expires 30d; 68 | } 69 | 70 | {% if WEBLATE_BUILTIN_SSL %} 71 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 72 | proxy_set_header X-Forwarded-Proto $scheme; 73 | {% endif %} 74 | proxy_set_header Host $http_host; 75 | proxy_read_timeout 3600; 76 | proxy_connect_timeout 3600; 77 | 78 | {% if WEBLATE_ANUBIS_URL %} 79 | location ~ ^{{ WEBLATE_URL_PREFIX }}(/widgets?/|/idp/|/exports/rss/|/healthz/|/hooks/|/accounts/complete/|/accounts/auth/) { 80 | proxy_pass http://127.0.0.1:8081; 81 | } 82 | {% endif %} 83 | 84 | location {{ WEBLATE_URL_PREFIX }}/ { 85 | {% if WEBLATE_ANUBIS_URL %} 86 | auth_request /.within.website/x/cmd/anubis/api/check; 87 | error_page 401 = @redirectToAnubis; 88 | {% endif %} 89 | proxy_pass http://127.0.0.1:8081; 90 | } 91 | } 92 | 93 | {% if WEBLATE_BUILTIN_SSL %} 94 | server { 95 | listen 8080 default_server; 96 | server_tokens off; 97 | return 301 https://$host$request_uri; 98 | } 99 | {% endif %} 100 | -------------------------------------------------------------------------------- /.github/workflows/pre-commit.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | name: Pre-commit check 7 | 8 | on: 9 | push: 10 | branches-ignore: 11 | - renovate/** 12 | - weblate 13 | pull_request: 14 | 15 | permissions: 16 | contents: read 17 | 18 | jobs: 19 | pre-commit: 20 | runs-on: ubuntu-24.04 21 | 22 | steps: 23 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 24 | with: 25 | persist-credentials: false 26 | - name: Get cache tag 27 | id: get-date 28 | run: | 29 | echo "cache_tag=$(/bin/date --utc '+%Y%m')" >> "$GITHUB_OUTPUT" 30 | echo "previous_cache_tag=$(/bin/date --date='1 month ago' --utc '+%Y%m')" >> "$GITHUB_OUTPUT" 31 | shell: bash 32 | - uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 33 | id: pre-commit-cache 34 | with: 35 | path: ~/.cache/pre-commit 36 | key: ${{ runner.os }}-pre-commit-${{ steps.get-date.outputs.cache_tag }}-${{ hashFiles('.pre-commit-config.yaml') }} 37 | restore-keys: | 38 | ${{ runner.os }}-pre-commit-${{ steps.get-date.outputs.cache_tag }} 39 | ${{ runner.os }}-pre-commit-${{ steps.get-date.outputs.previous_cache_tag }} 40 | ${{ runner.os }}-pre-commit- 41 | - name: Setup Python 42 | uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 43 | with: 44 | python-version: '3.14' 45 | - uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867 # v7.1.6 46 | with: 47 | version: 0.9.17 48 | enable-cache: false 49 | - name: detect method 50 | id: detect 51 | run: | 52 | if test -f requirements-lint.txt ; then 53 | echo "method=requirements" >> "$GITHUB_OUTPUT" 54 | elif test -f pyproject.toml && grep -q dependency-groups pyproject.toml ; then 55 | echo "method=pep735" >> "$GITHUB_OUTPUT" 56 | elif test -f pyproject.toml && grep -q dependency-groups pyproject.toml ; then 57 | echo "method=pyproject" >> "$GITHUB_OUTPUT" 58 | else 59 | echo "method=uvx" >> "$GITHUB_OUTPUT" 60 | fi 61 | - name: pre-commit (PEP 735) 62 | if: steps.detect.outputs.method == 'pep735' 63 | run: | 64 | uv run --only-group pre-commit pre-commit run --all --show-diff-on-failure 65 | uv run --only-group pre-commit pre-commit gc 66 | env: 67 | RUFF_OUTPUT_FORMAT: github 68 | REUSE_OUTPUT_FORMAT: github 69 | GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 70 | - name: pre-commit (uvx) 71 | if: steps.detect.outputs.method == 'uvx' 72 | run: | 73 | uvx pre-commit run --all --show-diff-on-failure 74 | uvx pre-commit gc 75 | env: 76 | RUFF_OUTPUT_FORMAT: github 77 | REUSE_OUTPUT_FORMAT: github 78 | GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 79 | - name: Install dependencies 80 | if: steps.detect.outputs.method == 'requirements' 81 | run: uv pip install --system -r requirements-lint.txt 82 | - name: Install dependencies 83 | if: steps.detect.outputs.method == 'pyproject' 84 | run: uv pip install --system "$(sed -n 's/.*"\(pre-commit==\([^"]*\)\)".*/\1/p' pyproject.toml)" 85 | - name: pre-commit (installed) 86 | if: steps.detect.outputs.method == 'requirements' || steps.detect.outputs.method == 'pyproject' 87 | run: | 88 | pre-commit run --all --show-diff-on-failure 89 | pre-commit gc 90 | env: 91 | RUFF_OUTPUT_FORMAT: github 92 | REUSE_OUTPUT_FORMAT: github 93 | GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 94 | - name: diff 95 | run: git diff 96 | if: always() 97 | - uses: pre-commit-ci/lite-action@5d6cc0eb514c891a40562a58a8e71576c5c7fb43 # v1.1.0 98 | if: always() 99 | with: 100 | msg: 'chore(pre-commit): apply code formatting' 101 | -------------------------------------------------------------------------------- /.github/workflows/labels.yml: -------------------------------------------------------------------------------- 1 | # Copyright © Michal Čihař 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | # This file is maintained in https://github.com/WeblateOrg/meta/ 6 | name: Issue labeled 7 | 8 | on: 9 | issues: 10 | types: [labeled] 11 | 12 | permissions: 13 | contents: read 14 | 15 | jobs: 16 | issueLabeled: 17 | permissions: 18 | issues: write # for peter-evans/create-or-update-comment to create or update comment 19 | pull-requests: write # for peter-evans/create-or-update-comment to create or update comment 20 | runs-on: ubuntu-24.04 21 | steps: 22 | - name: Add backlog comment 23 | uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 24 | if: ${{ github.event.label.name == 'backlog' }} 25 | with: 26 | token: ${{ secrets.GITHUB_TOKEN }} 27 | issue-number: ${{ github.event.issue.number }} 28 | body: > 29 | This issue has been added to the backlog. It is not scheduled 30 | on the Weblate roadmap, but it eventually might be implemented. 31 | 32 | 33 | In case you need this feature soon, please consider helping 34 | or push it by [funding the development](https://weblate.org/support/). 35 | - name: Add undecided comment 36 | uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 37 | if: ${{ github.event.label.name == 'undecided' }} 38 | with: 39 | token: ${{ secrets.GITHUB_TOKEN }} 40 | issue-number: ${{ github.event.issue.number }} 41 | body: > 42 | This issue has been put aside. It is currently unclear if it will 43 | ever be implemented as it seems to cover too narrow of a use case 44 | or doesn't seem to fit into Weblate. 45 | 46 | 47 | Please try to clarify the use case or consider proposing something more generic to make it useful to more users. 48 | - name: Add question comment 49 | uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 50 | if: ${{ github.event.label.name == 'question' }} 51 | with: 52 | token: ${{ secrets.GITHUB_TOKEN }} 53 | issue-number: ${{ github.event.issue.number }} 54 | body: > 55 | This issue has been marked as a question by a Weblate team member. 56 | Why? Because it belongs more to the professional [Weblate Care](https://care.weblate.org/) 57 | or community [Discussions](https://github.com/WeblateOrg/weblate/discussions) than here. 58 | We strive to answer these reasonably fast here, too, but 59 | [purchasing the support subscription](https://weblate.org/support/) 60 | is more responsible and faster for your business. 61 | And it makes Weblate stronger as well. Thanks! 62 | 63 | 64 | In case your question is already answered, [making a donation](https://weblate.org/donate/) is the right way to say thank you! 65 | - name: Add translate-toolkit comment 66 | uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 67 | if: ${{ github.event.label.name == 'translate-toolkit' }} 68 | with: 69 | token: ${{ secrets.GITHUB_TOKEN }} 70 | issue-number: ${{ github.event.issue.number }} 71 | body: > 72 | The issue you've reported needs to be addressed in the [translate-toolkit](https://github.com/translate/translate/). 73 | Please file the issue there, and include links to any relevant specifications about the formats (if applicable). 74 | - name: Add good first issue comment 75 | uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 76 | if: ${{ github.event.label.name == 'good first issue' }} 77 | with: 78 | token: ${{ secrets.GITHUB_TOKEN }} 79 | issue-number: ${{ github.event.issue.number }} 80 | body: > 81 | This issue seems to be a good fit for newbie contributors. 82 | You are welcome to contribute to Weblate! Don't hesitate to 83 | ask any questions you would have while implementing this. 84 | 85 | 86 | You can learn about how to get started in our 87 | [contributors documentation](https://docs.weblate.org/en/latest/contributing/index.html). 88 | -------------------------------------------------------------------------------- /.github/workflows/container-test.yml: -------------------------------------------------------------------------------- 1 | name: Docker container test 2 | 3 | on: 4 | workflow_call: 5 | inputs: 6 | variant: 7 | required: true 8 | type: string 9 | test: 10 | required: true 11 | type: string 12 | weblate_sha: 13 | required: false 14 | type: string 15 | weblate_date: 16 | required: false 17 | type: string 18 | port: 19 | required: false 20 | type: number 21 | protocol: 22 | required: false 23 | type: string 24 | 25 | jobs: 26 | container-test: 27 | runs-on: ubuntu-24.04 28 | name: Test container ${{ inputs.test }}, ${{ inputs.variant }} 29 | env: 30 | MATRIX_ARCHITECTURE: linux/amd64 31 | COMPOSE_PROJECT_NAME: wl 32 | PYTHONUNBUFFERED: 1 33 | TEST_CONTAINER: weblate/weblate:test 34 | steps: 35 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 36 | with: 37 | submodules: recursive 38 | persist-credentials: false 39 | - name: Expose GitHub Runtime 40 | uses: crazy-max/ghaction-github-runtime@3cb05d89e1f492524af3d41a1c98c83bc3025124 # v3.1.0 41 | - name: Set up Docker Buildx 42 | uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 43 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 44 | with: 45 | name: Docker cache amd64 46 | path: /tmp/.buildx-cache/linux/amd64 47 | - name: Adjust bleeding edge image 48 | if: inputs.variant == 'bleeding' 49 | run: .github/bin/bleeding "$WEBLATE_SHA" "$WEBLATE_DATE" 50 | env: 51 | WEBLATE_SHA: ${{ inputs.weblate_sha }} 52 | WEBLATE_DATE: ${{ inputs.weblate_date }} 53 | - name: Build the Docker image 54 | run: .github/bin/docker-build load 55 | - name: List Docker images 56 | run: docker image ls --all 57 | - name: Test content 58 | run: ./docker-compose/test-content 59 | - name: Generate configuration 60 | working-directory: docker-compose 61 | run: ./test-generate "$WEBLATE_PORT" "$WEBLATE_PROTOCOL" "$WEBLATE_TEST" 62 | env: 63 | WEBLATE_PORT: ${{ inputs.port || 8080 }} 64 | WEBLATE_PROTOCOL: ${{ inputs.protocol || 'http' }} 65 | WEBLATE_TEST: ${{ inputs.test }} 66 | - name: Generate SSL certificate 67 | if: inputs.protocol == 'https' 68 | working-directory: docker-compose 69 | run: | 70 | docker compose up --no-start 71 | VOLUMEPATH="$(docker volume inspect -f '{{.Mountpoint}}' wl_weblate-data)" 72 | sudo mkdir -p "$VOLUMEPATH/ssl" 73 | sudo openssl req -x509 -nodes -days 365 -subj "/CN=localhost" -newkey rsa:2048 -keyout "$VOLUMEPATH/ssl/privkey.pem" -out "$VOLUMEPATH/ssl/fullchain.pem" 74 | sudo chown -R 1000:1000 "$VOLUMEPATH/ssl" 75 | - name: Startup container 76 | working-directory: docker-compose 77 | run: ./test-boot 78 | - name: Show versions 79 | working-directory: docker-compose 80 | run: docker compose run weblate list_versions 81 | - name: List Python packages 82 | working-directory: docker-compose 83 | run: ./test-pip 84 | - name: Inspect container 85 | working-directory: docker-compose 86 | run: ./test-inspect 87 | - name: Check service is running 88 | working-directory: docker-compose 89 | run: ./test-online 90 | - name: Check service health status 91 | working-directory: docker-compose 92 | run: ./test-health 93 | - name: Run Django Checks 94 | working-directory: docker-compose 95 | run: ./test-checks 96 | - name: Verify supervisor 97 | working-directory: docker-compose 98 | run: ./test-supervisor 99 | - name: Test admin creation 100 | working-directory: docker-compose 101 | run: ./test-admin 102 | - name: Verify SAML certificate 103 | working-directory: docker-compose 104 | run: ./test-saml "$WEBLATE_TEST" 105 | env: 106 | WEBLATE_TEST: ${{ inputs.test }} 107 | - name: Test commands 108 | working-directory: docker-compose 109 | run: ./test-commands 110 | - name: Display logs 111 | if: always() 112 | working-directory: docker-compose 113 | run: ./test-logs 114 | - name: Stop Weblate service 115 | working-directory: docker-compose 116 | run: docker compose stop weblate 117 | - name: Start Weblate service 118 | working-directory: docker-compose 119 | run: docker compose start weblate 120 | - name: Check service is running 121 | working-directory: docker-compose 122 | run: ./test-online 123 | - name: Repeated requests 124 | run: | 125 | . docker-compose/.test.env 126 | set +e 127 | for i in $( seq 40000 ) ; do 128 | if ! curl --silent --show-error --fail-with-body --insecure --output /dev/null --max-time 1 "${URL}healthz/" ; then 129 | echo "Failed after $i requests!" 130 | exit 1 131 | fi 132 | done 133 | - name: Shutdown service 134 | working-directory: docker-compose 135 | run: ./test-stop 136 | permissions: 137 | contents: read 138 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM weblate/dev:2025.51.0@sha256:6578e43e1efb959193caaffbf095ce3925b15e3a80a01ec6b62527aeda9d0243 AS build 2 | 3 | ARG TARGETARCH 4 | 5 | # renovate: datasource=pypi depName=Weblate versioning=pep440 6 | ENV WEBLATE_VERSION=5.15 7 | ENV WEBLATE_EXTRAS=all,MySQL,zxcvbn,saml 8 | 9 | SHELL ["/bin/bash", "-o", "pipefail", "-x", "-c"] 10 | 11 | COPY --link requirements.txt patches /app/src/ 12 | 13 | # Install dependencies 14 | # hadolint ignore=DL3008,DL3013,SC2046,DL3003,SC1091 15 | RUN \ 16 | --mount=type=tmpfs,target=/tmp \ 17 | --mount=type=cache,target=/.uv-cache,sharing=locked \ 18 | export UV_CACHE_DIR=/.uv-cache UV_LINK_MODE=copy \ 19 | && uv venv --python "python${PYVERSION}" /app/venv \ 20 | && . /app/venv/bin/activate \ 21 | && uv --version \ 22 | && python --version \ 23 | && case "$WEBLATE_VERSION" in \ 24 | *+* ) \ 25 | uv pip install \ 26 | --compile-bytecode \ 27 | --no-binary xmlsec \ 28 | --no-binary lxml \ 29 | -r /app/src/requirements.txt \ 30 | "https://github.com/translate/translate/archive/master.zip" \ 31 | "https://github.com/WeblateOrg/language-data/archive/main.zip" \ 32 | "https://github.com/WeblateOrg/weblate/archive/$WEBLATE_DOCKER_GIT_REVISION.zip#egg=Weblate[$WEBLATE_EXTRAS]" \ 33 | ;; \ 34 | * ) \ 35 | uv pip install \ 36 | --compile-bytecode \ 37 | --no-binary xmlsec \ 38 | --no-binary lxml \ 39 | -r /app/src/requirements.txt \ 40 | "Weblate[$WEBLATE_EXTRAS]==$WEBLATE_VERSION" \ 41 | ;; \ 42 | esac \ 43 | && rm -rf /app/venv/lib/python*/site-packages/slapdtest \ 44 | && uv cache prune --ci \ 45 | && du -sh "$UV_CACHE_DIR" \ 46 | && /app/venv/bin/python -c 'from phply.phpparse import make_parser; make_parser()' \ 47 | && ln -s /app/venv/share/weblate/examples/ /app/ 48 | 49 | # Apply hotfixes on Weblate 50 | RUN find /app/src -name '*.patch' -print0 | sort -z | \ 51 | xargs -n1 -0 -r patch -p0 -d "/app/venv/lib/python${PYVERSION}/site-packages/" -i 52 | 53 | 54 | FROM weblate/base:2025.51.0@sha256:a4cb92d3c5759da2899fae7caaa8910ab6207b1f0da77ada5fb82ec68652220b AS final 55 | 56 | # renovate: datasource=pypi depName=Weblate versioning=pep440 57 | ENV WEBLATE_VERSION=5.15 58 | 59 | LABEL name="Weblate" 60 | LABEL version=$WEBLATE_VERSION 61 | LABEL maintainer="Michal Čihař " 62 | LABEL org.opencontainers.image.url="https://weblate.org/" 63 | LABEL org.opencontainers.image.documentation="https://docs.weblate.org/en/latest/admin/install/docker.html" 64 | LABEL org.opencontainers.image.source="https://github.com/WeblateOrg/docker" 65 | LABEL org.opencontainers.image.version=$WEBLATE_VERSION 66 | LABEL org.opencontainers.image.author="Michal Čihař " 67 | LABEL org.opencontainers.image.vendor="Weblate" 68 | LABEL org.opencontainers.image.title="Weblate" 69 | LABEL org.opencontainers.image.description="A web-based continuous localization system with tight version control integration" 70 | LABEL org.opencontainers.image.licenses="GPL-3.0-or-later" 71 | 72 | # Increased start period for migrations run 73 | HEALTHCHECK --interval=30s --timeout=3s --start-period=5m CMD /app/bin/health_check 74 | 75 | # Use Docker specific settings 76 | ENV DJANGO_SETTINGS_MODULE=weblate.settings_docker 77 | 78 | # Copy built environment 79 | COPY --from=build /app /app 80 | 81 | # Configuration for Weblate, nginx and supervisor 82 | COPY --link etc /etc/ 83 | 84 | # Customize Python: 85 | # - Search path for custom modules 86 | RUN \ 87 | echo "/app/data/python" > "/app/venv/lib/python${PYVERSION}/site-packages/weblate-docker.pth" && \ 88 | mkdir -p /app/data/python/customize && \ 89 | touch /app/data/python/customize/__init__.py && \ 90 | touch /app/data/python/customize/models.py && \ 91 | chown -R weblate:weblate /app/data/python 92 | 93 | # Fix permissions and adjust files to be able to edit them as user on start 94 | # - localtime is needed for setting system timezone based on environment 95 | # - timezone is removed to avoid dpkg handling localtime updates 96 | # - we generate nginx configuration based on environment 97 | # - authorize passwd edition so we can fix weblate uid on startup 98 | # - log, run and home directories 99 | # - disable su for non root to avoid privilege escapation by changing /etc/passwd 100 | RUN rm -f /etc/localtime /etc/timezone \ 101 | && ln -s /tmp/localtime /etc/localtime \ 102 | && chgrp -R 0 /var/log/nginx/ /var/lib/nginx /app/data /app/cache /run /home/weblate /etc/supervisor/conf.d \ 103 | && chmod -R 770 /var/log/nginx/ /var/lib/nginx /app/data /app/cache /run /home /home/weblate /etc/supervisor/conf.d \ 104 | && rm -f /etc/nginx/sites-available/default \ 105 | && ln -s /tmp/nginx/weblate-site.conf /etc/nginx/sites-available/default \ 106 | && rm -f /var/log/nginx/access.log /var/log/nginx/error.log \ 107 | && ln -sf /dev/stdout /var/log/nginx/access.log \ 108 | && ln -sf /dev/stderr /var/log/nginx/error.log \ 109 | && rm -rf /run/* \ 110 | && chmod 664 /etc/passwd /etc/group \ 111 | && sed -i '/pam_rootok.so/a auth requisite pam_deny.so' /etc/pam.d/su 112 | 113 | # Entrypoint 114 | COPY --link --chmod=0755 start health_check /app/bin/ 115 | 116 | EXPOSE 8080 117 | VOLUME /app/data 118 | VOLUME /app/cache 119 | 120 | # Numerical value is needed for OpenShift S2I, see 121 | # https://docs.openshift.com/container-platform/latest/openshift_images/create-images.html 122 | USER 1000 123 | 124 | ENTRYPOINT ["/app/bin/start"] 125 | CMD ["runserver"] 126 | -------------------------------------------------------------------------------- /start: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -e 3 | 4 | # shellcheck disable=SC1091 5 | . /app/venv/bin/activate 6 | 7 | # Allow sensitive settings to be defined in a file 8 | # in order to support Docker secrets 9 | if [ -n "${POSTGRES_PASSWORD_FILE}" ]; then 10 | POSTGRES_PASSWORD=$(cat "$POSTGRES_PASSWORD_FILE") 11 | export POSTGRES_PASSWORD 12 | fi 13 | 14 | if [ -n "${REDIS_PASSWORD_FILE}" ]; then 15 | REDIS_PASSWORD=$(cat "$REDIS_PASSWORD_FILE") 16 | export REDIS_PASSWORD 17 | fi 18 | 19 | if [ -z "$CLIENT_MAX_BODY_SIZE" ]; then 20 | CLIENT_MAX_BODY_SIZE=1000m 21 | export CLIENT_MAX_BODY_SIZE 22 | fi 23 | 24 | if [ -n "${WEBLATE_ADMIN_PASSWORD_FILE}" ]; then 25 | WEBLATE_ADMIN_PASSWORD=$(cat "$WEBLATE_ADMIN_PASSWORD_FILE") 26 | export WEBLATE_ADMIN_PASSWORD 27 | fi 28 | 29 | if [ -n "${WEBLATE_EMAIL_HOST_PASSWORD_FILE}" ]; then 30 | WEBLATE_EMAIL_HOST_PASSWORD=$(cat "$WEBLATE_EMAIL_HOST_PASSWORD_FILE") 31 | export WEBLATE_EMAIL_HOST_PASSWORD 32 | fi 33 | 34 | if [ -n "${WEBLATE_AUTH_LDAP_BIND_PASSWORD_FILE}" ]; then 35 | WEBLATE_AUTH_LDAP_BIND_PASSWORD=$(cat "$WEBLATE_AUTH_LDAP_BIND_PASSWORD_FILE") 36 | export WEBLATE_AUTH_LDAP_BIND_PASSWORD 37 | fi 38 | 39 | echo "Starting Weblate $WEBLATE_VERSION..." 40 | 41 | # Fix permissions on SSH private key. 42 | # Fails silently if the file doesn't exist yet. 43 | chmod 600 /app/data/ssh/id_rsa 2> /dev/null || true 44 | chmod 600 /app/data/ssh/id_ed25519 2> /dev/null || true 45 | 46 | # Check whether data volume is writable 47 | if [ ! -w /app/data ]; then 48 | echo "The /app/data volume is not writable, please adjust the permissions. Weblate is running as uid $(id -u)" 49 | echo 50 | echo "Please see https://github.com/WeblateOrg/docker/issues/2096 in case" 51 | echo "the permissions on the volume are actually correct." 52 | exit 1 53 | fi 54 | 55 | # Generate secret 56 | if [ ! -s /app/data/secret ]; then 57 | echo "Generating Django secret..." 58 | # https://github.com/django/django/blob/1.10.2/django/utils/crypto.py#L54-L56 59 | /app/venv/bin/python -c "from django.utils.crypto import get_random_string; print(get_random_string(50))" > /app/data/secret 60 | fi 61 | 62 | # Generate self-signed SAML key 63 | # This has to be done early as it is used from the settings_docker.py 64 | if [ -n "$WEBLATE_SAML_IDP_URL" ]; then 65 | if [ ! -f /app/data/ssl/saml.key ] || [ ! -f /app/data/ssl/saml.crt ]; then 66 | echo "Generating self-signed certificate for SAML..." 67 | mkdir -p /app/data/ssl 68 | openssl req \ 69 | -new \ 70 | -newkey rsa:4096 \ 71 | -x509 \ 72 | -days 3652 \ 73 | -nodes \ 74 | -subj "/OU=Weblate/CN=$WEBLATE_SITE_DOMAIN/emailAddress=$WEBLATE_ADMIN_EMAIL" \ 75 | -out /app/data/ssl/saml.crt \ 76 | -keyout /app/data/ssl/saml.key 77 | fi 78 | fi 79 | 80 | # For openshift, create an account in /etc/passwd 81 | # @see https://docs.okd.io/latest/creating_images/guidelines.html 82 | if ! whoami > /dev/null 2>&1; then 83 | if [ -w /etc/passwd ]; then 84 | echo "${USER_NAME:-weblate}:x:$(id -u):0:${USER_NAME:-weblate} user:${HOME}:/sbin/nologin" >> /etc/passwd 85 | fi 86 | fi 87 | 88 | if [ -z "$WEBLATE_SITE_DOMAIN" ]; then 89 | echo "Missing WEBLATE_SITE_DOMAIN, please configure it" 90 | exit 1 91 | fi 92 | 93 | # Export Weblate variables 94 | export WEBLATE_CMD="/app/venv/bin/weblate" 95 | export WEBLATE_PY_PATH="/app/data/python/customize" 96 | 97 | # Provide sane default value 98 | if [ -z "$POSTGRES_SSL_MODE" ]; then 99 | export POSTGRES_SSL_MODE="prefer" 100 | fi 101 | 102 | # Export variables for psql use 103 | export PGPASSWORD="$POSTGRES_PASSWORD" 104 | export PGSSLMODE="$POSTGRES_SSL_MODE" 105 | 106 | # Update the time zone 107 | if [ -w /tmp/localtime ]; then 108 | zonefile="/usr/share/zoneinfo/$WEBLATE_TIME_ZONE" 109 | if [ -n "$WEBLATE_TIME_ZONE" ] && [ -f "$zonefile" ]; then 110 | cat "$zonefile" > /tmp/localtime 111 | else 112 | cat /usr/share/zoneinfo/Etc/UTC > /tmp/localtime 113 | fi 114 | fi 115 | 116 | # Create fake Python app for customization 117 | if [ ! -d "$WEBLATE_PY_PATH" ]; then 118 | echo "Creating $WEBLATE_PY_PATH" 119 | mkdir -p "$WEBLATE_PY_PATH/static" 120 | touch "$WEBLATE_PY_PATH/__init__.py" 121 | touch "$WEBLATE_PY_PATH/models.py" 122 | fi 123 | 124 | run_weblate() { 125 | "$WEBLATE_CMD" "$@" 126 | } 127 | 128 | fail_dep() { 129 | >&2 echo "$1 not running!" 130 | >&2 echo 131 | >&2 echo "$1 is expected to run as separate Docker container." 132 | >&2 echo 133 | >&2 echo "Please see our docs for more details:" 134 | >&2 echo "https://docs.weblate.org/en/latest/admin/install/docker.html" 135 | exit 1 136 | } 137 | 138 | if ! run_weblate check; then 139 | >&2 echo "Failed to load configuration, please see errors above." 140 | exit 1 141 | fi 142 | 143 | # Wait for redis 144 | TIMEOUT=0 145 | until run_weblate shell -c 'from django.core.cache import cache; cache.has_key("ping")' > /dev/null; do 146 | >&2 echo "redis at ${REDIS_HOST:-cache} is unavailable - retrying $((30 - TIMEOUT))" 147 | TIMEOUT=$((TIMEOUT + 1)) 148 | if [ $TIMEOUT -gt 30 ]; then 149 | run_weblate shell -c 'from django.core.cache import cache; cache.has_key("ping")' 150 | fail_dep redis 151 | fi 152 | sleep 1 153 | done 154 | 155 | if [ -z "$POSTGRES_HOST" ]; then 156 | export POSTGRES_HOST=database 157 | fi 158 | if [ -z "$POSTGRES_PORT" ]; then 159 | export POSTGRES_PORT= 160 | fi 161 | 162 | # Wait for database to get available 163 | TIMEOUT=0 164 | until run_weblate shell -c 'from weblate.auth.models import User; User.objects.raw("SELECT 1")' > /dev/null; do 165 | >&2 echo "Database server at ${POSTGRES_HOST:-db} is unavailable - retrying $((30 - TIMEOUT))" 166 | TIMEOUT=$((TIMEOUT + 1)) 167 | if [ $TIMEOUT -gt 30 ]; then 168 | run_weblate shell -c 'from weblate.auth.models import User; User.objects.exists()' 169 | fail_dep PosgreSQL 170 | fi 171 | sleep 1 172 | done 173 | 174 | VERSION_CHECK=1 175 | case $WEBLATE_DATABASES in 176 | 0 | [fF][aA][lL][sS][eE] | [nN][oO]) 177 | VERSION_CHECK=0 178 | ;; 179 | esac 180 | 181 | if [ $VERSION_CHECK -eq 1 ]; then 182 | # Fetch server version 183 | PGVERSION=$(psql -h "$POSTGRES_HOST" -p "$POSTGRES_PORT" -d "${POSTGRES_DB:-$POSTGRES_DATABASE}" -U "$POSTGRES_USER" -t -A -c 'SHOW server_version_num;') 184 | 185 | unset PGPASSWORD 186 | 187 | >&2 echo "Postgres $PGVERSION is up" 188 | 189 | # Check if supported PostgreSQL version is used 190 | if [ "$PGVERSION" -lt 120000 ]; then 191 | >&2 echo "PostgreSQL 12 or newer is required to run Weblate" 192 | >&2 echo "See https://docs.weblate.org/en/latest/admin/install/docker.html#upgrading-postgresql-container" 193 | exit 1 194 | fi 195 | else 196 | >&2 echo "Database is up" 197 | fi 198 | 199 | # Migrate database to current version and collect static files 200 | if [ "$1" = "runserver" ]; then 201 | 202 | DO_MIGRATE=1 203 | # Select which services to run 204 | SUPERVISOR_CONF=/run/supervisor.conf.d/ 205 | mkdir -p "$SUPERVISOR_CONF" 206 | # Remove possible stale files from previous start 207 | rm -f "$SUPERVISOR_CONF"/* 208 | if [ -n "$WEBLATE_SERVICE" ]; then 209 | if [ "$WEBLATE_SERVICE" != "celery-beat" ]; then 210 | DO_MIGRATE=0 211 | fi 212 | ln -s "/etc/supervisor/conf.d/$WEBLATE_SERVICE.conf" "$SUPERVISOR_CONF" 213 | else 214 | # Symlink all non-celery services 215 | find /etc/supervisor/conf.d -type f ! -name 'celery-*.conf' -print0 | xargs -0 -I '{}' ln -s '{}' "$SUPERVISOR_CONF" 216 | 217 | if [ "${CELERY_SINGLE_PROCESS:-0}" -eq 1 ]; then 218 | # Symlink single process service only 219 | ln -s /etc/supervisor/conf.d/celery-single.conf "$SUPERVISOR_CONF" 220 | ln -s /etc/supervisor/conf.d/celery-beat.conf "$SUPERVISOR_CONF" 221 | else 222 | # Symlink all celery services but the single process 223 | find /etc/supervisor/conf.d -type f -name 'celery-*.conf' ! -name 'celery-single.conf' -print0 | xargs -0 -I '{}' ln -s '{}' "$SUPERVISOR_CONF" 224 | fi 225 | fi 226 | 227 | if [ $DO_MIGRATE -eq 1 ]; then 228 | echo "Starting database migration..." 229 | if ! run_weblate migrate; then 230 | echo 231 | echo "Database migration has failed. Please check the error message above." 232 | echo "Note: Upgrading across major versions is not supported. In case you are upgrading" 233 | echo " from an 4.x version, please upgrade to 5.0.2 first." 234 | echo 235 | echo " Using following for the docker-compose.yaml:" 236 | echo 237 | echo " image: weblate/weblate:5.0.2.2" 238 | exit 1 239 | fi 240 | 241 | # Create or update admin account 242 | if [ -n "$WEBLATE_ADMIN_PASSWORD" ]; then 243 | echo "Updating admin user password (unset WEBLATE_ADMIN_PASSWORD to disable)..." 244 | run_weblate createadmin --password="$WEBLATE_ADMIN_PASSWORD" --update --email="$WEBLATE_ADMIN_EMAIL" --name="$WEBLATE_ADMIN_NAME" 245 | else 246 | run_weblate createadmin --email="$WEBLATE_ADMIN_EMAIL" --name="$WEBLATE_ADMIN_NAME" || true 247 | fi 248 | 249 | echo "Refreshing stats..." 250 | run_weblate ensure_stats 251 | fi 252 | # Run with --clear to ensure all files are up to date 253 | run_weblate collectstatic --noinput --clear 254 | # Compress js and css 255 | run_weblate compress --force --traceback 256 | 257 | # wsgi socket dir 258 | mkdir -p /run/granian/ 259 | 260 | # Celery pid, remove possible stale PID file 261 | mkdir -p /run/celery 262 | rm -f /run/celery/beat.pid 263 | 264 | # Parse upstream X-Forwarded-For 265 | case "$WEBLATE_IP_PROXY_HEADER" in 266 | HTTP_X_FORWARDED_FOR) 267 | WEBLATE_REALIP=" 268 | real_ip_header X-Forwarded-For; 269 | set_real_ip_from 0.0.0.0/0; 270 | " 271 | ;; 272 | *) 273 | WEBLATE_REALIP="" 274 | ;; 275 | esac 276 | 277 | # Detect SSL setup 278 | if [ -f /app/data/ssl/privkey.pem ]; then 279 | WEBLATE_BUILTIN_SSL="1" 280 | if [ -z "$WEBLATE_IP_PROXY_HEADER" ]; then 281 | # Use X-Forwarded-For from the built-in nginx 282 | export WEBLATE_IP_PROXY_HEADER=HTTP_X_FORWARDED_FOR 283 | fi 284 | else 285 | WEBLATE_BUILTIN_SSL="" 286 | fi 287 | 288 | # Make sure WEBLATE_ANUBIS_URL is set 289 | : "${WEBLATE_ANUBIS_URL:=""}" 290 | : "${WEBLATE_ENABLE_HTTPS:=""}" 291 | 292 | # Generate nginx configuration 293 | mkdir -p /tmp/nginx 294 | /app/venv/bin/python /etc/nginx/generate-site.py /etc/nginx "$WEBLATE_URL_PREFIX" "$WEBLATE_REALIP" "$CLIENT_MAX_BODY_SIZE" "$WEBLATE_BUILTIN_SSL" "$WEBLATE_ANUBIS_URL" "$WEBLATE_SITE_DOMAIN" "$WEBLATE_ENABLE_HTTPS" > /tmp/nginx/weblate-site.conf 295 | 296 | # Calculate number of processes, at least 2, at most 4, depending on CPU cores 297 | if [ -z "$WEBLATE_WORKERS" ]; then 298 | PROCESSORS=$(nproc) 299 | WEBLATE_WORKERS=$((PROCESSORS < 2 ? 2 : PROCESSORS > 4 ? 4 : PROCESSORS)) 300 | echo "Auto-scaled to $WEBLATE_WORKERS processes, adjust by setting WEBLATE_WORKERS" 301 | fi 302 | 303 | # default values for celery options 304 | : "${CELERY_MAIN_OPTIONS:="--concurrency $WEBLATE_WORKERS"}" 305 | : "${CELERY_NOTIFY_OPTIONS:="--concurrency $WEBLATE_WORKERS"}" 306 | : "${CELERY_TRANSLATE_OPTIONS:="--concurrency $WEBLATE_WORKERS"}" 307 | : "${CELERY_MEMORY_OPTIONS:="--concurrency $((WEBLATE_WORKERS == 1 ? 1 : WEBLATE_WORKERS / 2))"}" 308 | : "${CELERY_BACKUP_OPTIONS:="--concurrency 1"}" 309 | : "${CELERY_BEAT_OPTIONS:=""}" 310 | : "${CELERY_SINGLE_OPTIONS:=""}" 311 | : "${WEB_WORKERS:="$((WEBLATE_WORKERS <= 3 ? 2 : WEBLATE_WORKERS / 2))"}" 312 | 313 | export CELERY_MAIN_OPTIONS 314 | export CELERY_NOTIFY_OPTIONS 315 | export CELERY_TRANSLATE_OPTIONS 316 | export CELERY_MEMORY_OPTIONS 317 | export CELERY_BACKUP_OPTIONS 318 | export CELERY_BEAT_OPTIONS 319 | export CELERY_SINGLE_OPTIONS 320 | export WEB_WORKERS 321 | export WEB_RUNTIME_THREADS 322 | 323 | # Execute supervisor 324 | exec /app/venv/bin/supervisord \ 325 | --loglevel="${SUPERVISOR_LOGLEVEL:-info}" \ 326 | --logfile="${SUPERVISOR_LOGFILE:-/dev/null}" \ 327 | --configuration=/etc/supervisor/supervisord.conf 328 | fi 329 | 330 | # Start the management command 331 | run_weblate "$@" 332 | -------------------------------------------------------------------------------- /.github/workflows/container-ci.yml: -------------------------------------------------------------------------------- 1 | name: Docker container CI 2 | 3 | on: 4 | workflow_call: 5 | inputs: 6 | variant: 7 | required: true 8 | type: string 9 | secrets: 10 | DOCKERHUB_ACCESS_TOKEN: 11 | description: Docker Hub access token 12 | DOCKERHUB_USERNAME: 13 | description: Docker Hub username 14 | 15 | permissions: 16 | contents: read 17 | 18 | jobs: 19 | revisions: 20 | runs-on: ubuntu-24.04 21 | outputs: 22 | weblate_sha: ${{ steps.get_sha.outputs.sha }} 23 | weblate_date: ${{ steps.get_date.outputs.date }} 24 | steps: 25 | - id: get_sha 26 | run: echo "sha=$(git ls-remote --quiet https://github.com/WeblateOrg/weblate.git HEAD | awk '{print $1}')" >> "$GITHUB_OUTPUT" 27 | - id: get_date 28 | run: echo "date=$(date --iso-8601=ns)" >> "$GITHUB_OUTPUT" 29 | build: 30 | needs: 31 | - revisions 32 | uses: ./.github/workflows/container-build.yml 33 | with: 34 | variant: ${{ inputs.variant }} 35 | architecture: amd64 36 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 37 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 38 | 39 | buildx: 40 | needs: 41 | - revisions 42 | uses: ./.github/workflows/container-build.yml 43 | with: 44 | variant: ${{ inputs.variant }} 45 | architecture: arm64 46 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 47 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 48 | 49 | test-basic: 50 | needs: 51 | - revisions 52 | - build 53 | uses: ./.github/workflows/container-test.yml 54 | with: 55 | variant: ${{ inputs.variant }} 56 | test: basic 57 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 58 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 59 | 60 | test-anubis: 61 | needs: 62 | - revisions 63 | - build 64 | uses: ./.github/workflows/container-test.yml 65 | with: 66 | variant: ${{ inputs.variant }} 67 | test: anubis 68 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 69 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 70 | 71 | test-novolume: 72 | needs: 73 | - revisions 74 | - build 75 | uses: ./.github/workflows/container-test.yml 76 | with: 77 | variant: ${{ inputs.variant }} 78 | test: read-write 79 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 80 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 81 | 82 | test-localtime: 83 | needs: 84 | - revisions 85 | - build 86 | uses: ./.github/workflows/container-test.yml 87 | with: 88 | variant: ${{ inputs.variant }} 89 | test: localtime 90 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 91 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 92 | 93 | test-saml: 94 | needs: 95 | - revisions 96 | - build 97 | uses: ./.github/workflows/container-test.yml 98 | with: 99 | variant: ${{ inputs.variant }} 100 | test: saml 101 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 102 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 103 | 104 | test-split: 105 | needs: 106 | - revisions 107 | - build 108 | uses: ./.github/workflows/container-test.yml 109 | with: 110 | variant: ${{ inputs.variant }} 111 | test: split 112 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 113 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 114 | 115 | test-single-celery: 116 | needs: 117 | - revisions 118 | - build 119 | uses: ./.github/workflows/container-test.yml 120 | with: 121 | variant: ${{ inputs.variant }} 122 | test: celery-single 123 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 124 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 125 | 126 | test-ssl: 127 | needs: 128 | - revisions 129 | - build 130 | uses: ./.github/workflows/container-test.yml 131 | with: 132 | variant: ${{ inputs.variant }} 133 | test: basic 134 | port: 4443 135 | protocol: https 136 | weblate_sha: ${{needs.revisions.outputs.weblate_sha}} 137 | weblate_date: ${{needs.revisions.outputs.weblate_date}} 138 | 139 | anchore: 140 | runs-on: ubuntu-24.04 141 | name: Anchore Container Scan 142 | needs: 143 | - revisions 144 | - build 145 | permissions: 146 | security-events: write 147 | env: 148 | MATRIX_ARCHITECTURE: linux/amd64 149 | steps: 150 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 151 | with: 152 | persist-credentials: false 153 | - name: Expose GitHub Runtime 154 | uses: crazy-max/ghaction-github-runtime@3cb05d89e1f492524af3d41a1c98c83bc3025124 # v3.1.0 155 | - name: Set up Docker Buildx 156 | uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 157 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 158 | with: 159 | name: Docker cache amd64 160 | path: /tmp/.buildx-cache/linux/amd64 161 | - name: Adjust bleeding edge image 162 | if: inputs.variant == 'bleeding' 163 | run: .github/bin/bleeding "$WEBLATE_SHA" "$WEBLATE_DATE" 164 | env: 165 | WEBLATE_SHA: ${{ needs.revisions.outputs.weblate_sha }} 166 | WEBLATE_DATE: ${{ needs.revisions.outputs.weblate_date }} 167 | - name: Build the Docker image 168 | run: .github/bin/docker-build load 169 | - name: List Docker images 170 | run: docker image ls --all 171 | - name: Checkout the code 172 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 173 | with: 174 | persist-credentials: false 175 | - name: Anchore scan action 176 | uses: anchore/scan-action@3c9a191a0fbab285ca6b8530b5de5a642cba332f # v7.2.2 177 | id: scan 178 | with: 179 | image: weblate/weblate:test 180 | fail-build: false 181 | - name: Upload Anchore Scan Report 182 | uses: github/codeql-action/upload-sarif@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4.31.8 183 | with: 184 | sarif_file: ${{ steps.scan.outputs.sarif }} 185 | 186 | trivy: 187 | runs-on: ubuntu-24.04 188 | name: Trivy Container Scan 189 | needs: 190 | - revisions 191 | - build 192 | permissions: 193 | security-events: write 194 | env: 195 | MATRIX_ARCHITECTURE: linux/amd64 196 | steps: 197 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 198 | with: 199 | persist-credentials: false 200 | - name: Expose GitHub Runtime 201 | uses: crazy-max/ghaction-github-runtime@3cb05d89e1f492524af3d41a1c98c83bc3025124 # v3.1.0 202 | - name: Set up Docker Buildx 203 | uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 204 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 205 | with: 206 | name: Docker cache amd64 207 | path: /tmp/.buildx-cache/linux/amd64 208 | - name: Adjust bleeding edge image 209 | if: inputs.variant == 'bleeding' 210 | run: .github/bin/bleeding "$WEBLATE_SHA" "$WEBLATE_DATE" 211 | env: 212 | WEBLATE_SHA: ${{ needs.revisions.outputs.weblate_sha }} 213 | WEBLATE_DATE: ${{ needs.revisions.outputs.weblate_date }} 214 | - name: Build the Docker image 215 | run: .github/bin/docker-build load 216 | - name: List Docker images 217 | run: docker image ls --all 218 | - name: Checkout the code 219 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 220 | with: 221 | persist-credentials: false 222 | - name: Run Trivy vulnerability scanner 223 | uses: aquasecurity/trivy-action@b6643a29fecd7f34b3597bc6acb0a98b03d33ff8 # 0.33.1 224 | with: 225 | image-ref: weblate/weblate:test 226 | format: sarif 227 | output: trivy-results.sarif 228 | severity: CRITICAL,HIGH 229 | 230 | - name: Upload Trivy scan results to GitHub Security tab 231 | uses: github/codeql-action/upload-sarif@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4.31.8 232 | with: 233 | sarif_file: trivy-results.sarif 234 | - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 235 | with: 236 | name: Trivy scan SARIF 237 | path: trivy-results.sarif 238 | 239 | merge: 240 | runs-on: ubuntu-24.04 241 | name: Merge images, ${{ inputs.variant }} 242 | needs: 243 | - build 244 | - buildx 245 | - revisions 246 | steps: 247 | - name: Checkout 248 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 249 | with: 250 | persist-credentials: false 251 | - name: Set up QEMU 252 | uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0 253 | with: 254 | platforms: all 255 | - name: Expose GitHub Runtime 256 | uses: crazy-max/ghaction-github-runtime@3cb05d89e1f492524af3d41a1c98c83bc3025124 # v3.1.0 257 | - name: Set up Docker Buildx 258 | uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 259 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 260 | with: 261 | name: Docker cache amd64 262 | path: /tmp/.buildx-cache/linux/amd64 263 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 264 | with: 265 | name: Docker cache arm64 266 | path: /tmp/.buildx-cache/linux/arm64 267 | - name: Adjust bleeding edge image 268 | if: inputs.variant == 'bleeding' 269 | run: .github/bin/bleeding "$WEBLATE_SHA" "$WEBLATE_DATE" 270 | env: 271 | WEBLATE_SHA: ${{ needs.revisions.outputs.weblate_sha }} 272 | WEBLATE_DATE: ${{ needs.revisions.outputs.weblate_date }} 273 | - name: Configure Docker build 274 | run: .github/bin/get-buildx-args 275 | - name: Merge the Docker images 276 | run: .github/bin/docker-build 277 | 278 | tests-all: 279 | runs-on: ubuntu-24.04 280 | name: Tests, ${{ inputs.variant }} 281 | needs: 282 | - test-basic 283 | - test-anubis 284 | - test-saml 285 | - test-split 286 | - test-single-celery 287 | - test-novolume 288 | - test-ssl 289 | - test-localtime 290 | steps: 291 | # This is dependency only job to collect all test results 292 | - run: echo 293 | 294 | lint-all: 295 | runs-on: ubuntu-24.04 296 | name: Lint, ${{ inputs.variant }} 297 | needs: 298 | - anchore 299 | - trivy 300 | steps: 301 | # This is dependency only job to collect all lint results 302 | - run: echo 303 | 304 | push_dockerhub: 305 | runs-on: ubuntu-24.04 306 | name: Publish to Docker Hub, ${{ inputs.variant }} 307 | needs: 308 | - tests-all 309 | - lint-all 310 | - merge 311 | - revisions 312 | if: ${{ (startsWith(github.ref, 'refs/tags/') || (github.ref == 'refs/heads/main')) && github.repository == 'WeblateOrg/docker' }} 313 | steps: 314 | - name: Checkout 315 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 316 | with: 317 | persist-credentials: false 318 | - name: Set up QEMU 319 | uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0 320 | with: 321 | platforms: all 322 | - name: Expose GitHub Runtime 323 | uses: crazy-max/ghaction-github-runtime@3cb05d89e1f492524af3d41a1c98c83bc3025124 # v3.1.0 324 | - name: Set up Docker Buildx 325 | uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 326 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 327 | with: 328 | name: Docker cache amd64 329 | path: /tmp/.buildx-cache/linux/amd64 330 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 331 | with: 332 | name: Docker cache arm64 333 | path: /tmp/.buildx-cache/linux/arm64 334 | - name: DockerHub login 335 | run: echo "${{ secrets.DOCKERHUB_ACCESS_TOKEN }}" | docker login --username "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin 336 | - name: Adjust bleeding edge image 337 | if: inputs.variant == 'bleeding' 338 | run: .github/bin/bleeding "$WEBLATE_SHA" "$WEBLATE_DATE" 339 | env: 340 | WEBLATE_SHA: ${{ needs.revisions.outputs.weblate_sha }} 341 | WEBLATE_DATE: ${{ needs.revisions.outputs.weblate_date }} 342 | - name: Configure Docker build 343 | run: .github/bin/get-buildx-args "publish-$WEBLATE_VARIANT" 344 | env: 345 | WEBLATE_VARIANT: ${{ inputs.variant }} 346 | - name: Publish the Docker images 347 | run: .github/bin/docker-build "publish-$WEBLATE_VARIANT" 348 | env: 349 | WEBLATE_VARIANT: ${{ inputs.variant }} 350 | 351 | push_github: 352 | runs-on: ubuntu-24.04 353 | name: Publish to GitHub, ${{ inputs.variant }} 354 | permissions: 355 | packages: write 356 | needs: 357 | - tests-all 358 | - lint-all 359 | - merge 360 | - revisions 361 | if: ${{ (startsWith(github.ref, 'refs/tags/') || (github.ref == 'refs/heads/main')) && github.repository == 'WeblateOrg/docker' }} 362 | env: 363 | DOCKER_IMAGE: ghcr.io/weblateorg/weblate 364 | steps: 365 | - name: Checkout 366 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 367 | with: 368 | persist-credentials: false 369 | - name: Set up QEMU 370 | uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0 371 | with: 372 | platforms: all 373 | - name: Expose GitHub Runtime 374 | uses: crazy-max/ghaction-github-runtime@3cb05d89e1f492524af3d41a1c98c83bc3025124 # v3.1.0 375 | - name: Set up Docker Buildx 376 | uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1 377 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 378 | with: 379 | name: Docker cache amd64 380 | path: /tmp/.buildx-cache/linux/amd64 381 | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 382 | with: 383 | name: Docker cache arm64 384 | path: /tmp/.buildx-cache/linux/arm64 385 | - name: Login to GitHub Container Registry 386 | if: ${{ github.event_name != 'pull_request'}} 387 | uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0 388 | with: 389 | registry: ghcr.io 390 | username: ${{ github.actor }} 391 | password: ${{ secrets.GITHUB_TOKEN }} 392 | - name: Adjust bleeding edge image 393 | if: inputs.variant == 'bleeding' 394 | run: .github/bin/bleeding "$WEBLATE_SHA" "$WEBLATE_DATE" 395 | env: 396 | WEBLATE_SHA: ${{ needs.revisions.outputs.weblate_sha }} 397 | WEBLATE_DATE: ${{ needs.revisions.outputs.weblate_date }} 398 | - name: Configure Docker build 399 | run: .github/bin/get-buildx-args "publish-$WEBLATE_VARIANT" 400 | env: 401 | WEBLATE_VARIANT: ${{ inputs.variant }} 402 | - name: Publish the Docker images 403 | run: .github/bin/docker-build "publish-$WEBLATE_VARIANT" 404 | env: 405 | WEBLATE_VARIANT: ${{ inputs.variant }} 406 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------