├── requirements-lint.txt ├── test-boot ├── test-stop ├── .gitignore ├── test-logs ├── test-admin ├── test-pip ├── .dclintrc ├── test-checks ├── test-inspect ├── .github ├── renovate.json.license ├── PULL_REQUEST_TEMPLATE.md.license ├── FUNDING.yml ├── renovate.json ├── PULL_REQUEST_TEMPLATE.md ├── workflows │ ├── dependency-review.yml │ ├── label-sync.yml │ ├── pull_requests.yaml │ ├── stale.yml │ ├── closing.yml │ ├── dockerimage.yml │ ├── pre-commit.yml │ └── labels.yml ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── feature_request.yml │ └── bug_report.yml └── labels.yml ├── test-saml ├── test-supervisor ├── .yamllint.yml ├── test-commands ├── .markdownlint.yml ├── test-content ├── test-online ├── .editorconfig ├── docker-compose.yml ├── docker-compose-single-celery.yml ├── SECURITY.md ├── test-health ├── docker-compose-https.yml ├── README.rst ├── .pre-commit-config.yaml ├── environment ├── test-generate ├── docker-compose-split.yml └── LICENSE /requirements-lint.txt: -------------------------------------------------------------------------------- 1 | pre-commit==4.5.1 2 | -------------------------------------------------------------------------------- /test-boot: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose up -d 3 | -------------------------------------------------------------------------------- /test-stop: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose down 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /docker-compose.override.yml 2 | /.env 3 | /.venv 4 | -------------------------------------------------------------------------------- /test-logs: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose logs 3 | docker compose ps 4 | -------------------------------------------------------------------------------- /test-admin: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose exec -T --user weblate weblate weblate createadmin --update || exit 1 3 | -------------------------------------------------------------------------------- /test-pip: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose exec -T weblate /bin/sh -c '. /app/venv/bin/activate && uv pip list --no-cache-dir' 3 | -------------------------------------------------------------------------------- /.dclintrc: -------------------------------------------------------------------------------- 1 | rules: 2 | no-unbound-port-interfaces: 0 3 | service-image-require-explicit-tag: 0 4 | require-project-name-field: 0 5 | -------------------------------------------------------------------------------- /test-checks: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose exec -T \ 3 | --user weblate \ 4 | weblate weblate check --deploy --fail-level WARNING 5 | -------------------------------------------------------------------------------- /test-inspect: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | CONTAINER=$(docker compose ps | grep -e "-weblate-[0-9]" | sed 's/[[:space:]].*//') 3 | docker inspect "$CONTAINER" 4 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /test-saml: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | if [ "$1" = "saml" ]; then 3 | docker compose exec -T weblate openssl x509 -in /app/data/ssl/saml.crt -text -noout 4 | else 5 | docker compose exec -T weblate test ! -f /app/data/ssl/saml.crt 6 | fi 7 | -------------------------------------------------------------------------------- /test-supervisor: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose exec -T weblate supervisorctl status all 3 | RET=$? 4 | # The 3 happens with EXITED check and supervisor 4 5 | if [ $RET -ne 0 ] && [ $RET -ne 3 ]; then 6 | docker compose logs 7 | exit 1 8 | fi 9 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "github>WeblateOrg/meta:renovate" 5 | ], 6 | "packageRules": [ 7 | { 8 | "matchDatasources": [ 9 | "docker" 10 | ], 11 | "pinDigests": false 12 | } 13 | ] 14 | } 15 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /test-commands: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -e 3 | docker compose exec -T \ 4 | --user weblate \ 5 | weblate git --version 6 | docker compose exec -T \ 7 | --user weblate \ 8 | weblate hg --version 9 | docker compose exec -T \ 10 | --user weblate \ 11 | weblate ssh -V 12 | docker compose exec -T \ 13 | --user weblate \ 14 | weblate uv python list 15 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /test-content: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | STORAGE=$(mktemp) 4 | cleanup() { 5 | rm "$STORAGE" 6 | } 7 | trap cleanup EXIT 8 | 9 | echo "Creating container..." 10 | docker create --name="tmp_$$" "${TEST_CONTAINER:-weblate/weblate:edge}" 11 | echo "Listing content container..." 12 | docker export tmp_$$ | tar t > "$STORAGE" 13 | echo "Removing container..." 14 | docker rm tmp_$$ 15 | echo "Checking content..." 16 | 17 | # /app/data is not checked because it contains stub for customization 18 | if grep -E '^(app/cache|tmp|run)/.+' "$STORAGE"; then 19 | echo "Volumes contain files!" 20 | exit 1 21 | fi 22 | 23 | echo "$STORAGE" 24 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 15 | -------------------------------------------------------------------------------- /test-online: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # shellcheck disable=SC1091 3 | . ./.test.env 4 | echo "Checking $URL..." 5 | TIMEOUT=0 6 | while ! curl --insecure --fail --max-time 5 --silent --output /dev/null "$URL"; do 7 | sleep 5 8 | TIMEOUT=$((TIMEOUT + 1)) 9 | if [ $TIMEOUT -gt 300 ]; then 10 | break 11 | fi 12 | done 13 | curl --insecure --verbose --fail --max-time 3 "${URL}about/" | grep 'Powered by.*Weblate' 14 | RET=$? 15 | curl --insecure --verbose --fail --max-time 3 --output /dev/null "${URL}static/weblate-128.png" 16 | RET2=$? 17 | # Display logs so far 18 | docker compose logs 19 | 20 | if [ $RET2 -ne 0 ] || [ $RET -ne 0 ]; then 21 | exit 1 22 | fi 23 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | cache: 3 | image: valkey/valkey:9.0.1 4 | volumes: 5 | - redis-data:/data 6 | command: [valkey-server, --save, '60', '1', --loglevel, warning] 7 | restart: always 8 | read_only: true 9 | database: 10 | image: postgres:18-alpine 11 | volumes: 12 | - postgres-data:/var/lib/postgresql 13 | env_file: 14 | - ./environment 15 | restart: always 16 | weblate: 17 | image: weblate/weblate 18 | depends_on: 19 | - cache 20 | - database 21 | volumes: 22 | - weblate-data:/app/data 23 | - weblate-cache:/app/cache 24 | env_file: 25 | - ./environment 26 | restart: always 27 | read_only: true 28 | tmpfs: 29 | - /run 30 | - /tmp 31 | volumes: 32 | weblate-cache: {} 33 | weblate-data: {} 34 | postgres-data: {} 35 | redis-data: {} 36 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /docker-compose-single-celery.yml: -------------------------------------------------------------------------------- 1 | services: 2 | cache: 3 | image: valkey/valkey:9.0.1 4 | volumes: 5 | - redis-data:/data 6 | command: [valkey-server, --save, '60', '1', --loglevel, warning] 7 | restart: always 8 | read_only: true 9 | database: 10 | image: postgres:18-alpine 11 | volumes: 12 | - postgres-data:/var/lib/postgresql 13 | env_file: 14 | - ./environment 15 | restart: always 16 | weblate: 17 | image: weblate/weblate 18 | depends_on: 19 | - cache 20 | - database 21 | volumes: 22 | - weblate-data:/app/data 23 | - weblate-cache:/app/cache 24 | environment: 25 | SINGLE_CELERY_PROCESS: 1 26 | env_file: 27 | - ./environment 28 | restart: always 29 | read_only: true 30 | tmpfs: 31 | - /run 32 | - /tmp 33 | volumes: 34 | weblate-cache: {} 35 | weblate-data: {} 36 | postgres-data: {} 37 | redis-data: {} 38 | -------------------------------------------------------------------------------- /.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 | contact_links: 8 | - name: Read our clear, thorough and localized docs 9 | url: https://docs.weblate.org/ 10 | 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. 11 | - name: Get professional support 12 | url: https://weblate.org/support/ 13 | 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. 14 | - name: Ask the community 15 | url: https://github.com/WeblateOrg/weblate/discussions 16 | about: Want to discuss something with a community? Do it in discussions! 17 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /test-health: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker compose ps 3 | docker compose exec -T \ 4 | --user weblate \ 5 | weblate /app/bin/health_check 6 | 7 | failure=0 8 | 9 | # shellcheck disable=SC2013 10 | for service in $(sed -n 's/^ \(weblate.*\):$/\1/p' docker-compose.yml); do 11 | container_id="$(docker compose ps -q "$service")" 12 | # shellcheck disable=SC2034 13 | for i in $(seq 30); do 14 | container_status="$(docker inspect --format '{{json .State.Health.Status }}' "$container_id")" 15 | if [ "$container_status" != '"starting"' ]; then 16 | break 17 | fi 18 | echo "Waiting for container $service to be up..." 19 | sleep 1 20 | done 21 | container_status="$(docker inspect --format '{{json .State.Health.Status }}' "$container_id")" 22 | echo "Container $service is $container_status" 23 | if [ "$container_status" != '"healthy"' ]; then 24 | failure=$((failure + 1)) 25 | docker inspect --format "{{json .State.Health }}" 67926a72d8b20e8ea379d7d03449fdde6d38bd39599b0b21b4fb880479049da3 | jq 26 | echo 27 | fi 28 | done 29 | 30 | if [ "$failure" -gt 0 ]; then 31 | echo "Failed $failure services!" 32 | exit 1 33 | fi 34 | -------------------------------------------------------------------------------- /docker-compose-https.yml: -------------------------------------------------------------------------------- 1 | services: 2 | cache: 3 | image: valkey/valkey:9.0.1 4 | volumes: 5 | - redis-data:/data 6 | command: [valkey-server, --save, '60', '1', --loglevel, warning] 7 | restart: always 8 | read_only: true 9 | database: 10 | image: postgres:18-alpine 11 | volumes: 12 | - postgres-data:/var/lib/postgresql 13 | env_file: 14 | - ./environment 15 | restart: always 16 | https-portal: 17 | image: steveltn/https-portal:1 18 | volumes: 19 | - ssl-certs:/var/lib/https-portal 20 | environment: 21 | STAGE: production 22 | PROXY_READ_TIMEOUT: 3600 23 | ports: 24 | - 80:80 25 | - 443:443 26 | restart: always 27 | weblate: 28 | image: weblate/weblate 29 | depends_on: 30 | - cache 31 | - database 32 | volumes: 33 | - weblate-data:/app/data 34 | - weblate-cache:/app/cache 35 | environment: 36 | WEBLATE_ENABLE_HTTPS: 1 37 | WEBLATE_IP_PROXY_HEADER: HTTP_X_FORWARDED_FOR 38 | WEBLATE_SECURE_PROXY_SSL_HEADER: HTTP_X_FORWARDED_PROTO,https 39 | env_file: 40 | - ./environment 41 | restart: always 42 | read_only: true 43 | tmpfs: 44 | - /run 45 | - /tmp 46 | volumes: 47 | weblate-cache: {} 48 | weblate-data: {} 49 | postgres-data: {} 50 | redis-data: {} 51 | ssl-certs: {} 52 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. image:: https://s.weblate.org/cdn/Logo-Darktext-borders.png 2 | :alt: Weblate 3 | :target: https://weblate.org/ 4 | :height: 80px 5 | 6 | **Weblate is libre software web-based continuous localization system, 7 | used by over 2500 libre projects and companies in more than 165 countries.** 8 | 9 | The docker-compose for Docker container for Weblate 10 | 11 | .. image:: https://readthedocs.org/projects/weblate/badge/ 12 | :alt: Documentation 13 | :target: https://docs.weblate.org/en/latest/admin/install/docker.html 14 | 15 | Documentation 16 | ------------- 17 | 18 | Detailed documentation is available in Weblate documentation: 19 | 20 | https://docs.weblate.org/en/latest/admin/install/docker.html 21 | 22 | Getting started 23 | --------------- 24 | 25 | 1. Clone the docker-compose repository: 26 | 27 | .. code-block:: shell 28 | 29 | git clone https://github.com/WeblateOrg/docker-compose.git 30 | cd docker-compose 31 | 32 | 2. Create a ``docker-compose.override.yml`` file with your settings. 33 | 34 | .. code-block:: yml 35 | 36 | services: 37 | weblate: 38 | ports: 39 | - 80:8080 40 | environment: 41 | WEBLATE_SITE_DOMAIN: example.com 42 | WEBLATE_EMAIL_HOST: smtp.example.com 43 | WEBLATE_EMAIL_HOST_USER: user 44 | WEBLATE_EMAIL_HOST_PASSWORD: pass 45 | WEBLATE_ALLOWED_HOSTS: your hosts 46 | WEBLATE_ADMIN_PASSWORD: password for admin user 47 | 48 | 3. Start it up: 49 | 50 | .. code-block:: shell 51 | 52 | docker compose up 53 | 54 | 5. For more detailed instructions and configuration visit https://docs.weblate.org/en/latest/admin/install/docker.html 55 | 56 | Rebuilding the weblate docker image 57 | ----------------------------------- 58 | 59 | The `docker-compose` files can be found in https://github.com/WeblateOrg/docker-compose. 60 | The weblate docker image is built from https://github.com/WeblateOrg/docker. 61 | -------------------------------------------------------------------------------- /.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 | - repo: https://github.com/executablebooks/mdformat 31 | rev: 1.0.0 32 | hooks: 33 | - id: mdformat 34 | additional_dependencies: 35 | - mdformat-gfm==1.0.0 36 | - repo: https://github.com/shellcheck-py/shellcheck-py 37 | rev: v0.11.0.1 38 | hooks: 39 | - id: shellcheck 40 | require_serial: true 41 | - repo: https://github.com/scop/pre-commit-shfmt 42 | rev: v3.12.0-2 43 | hooks: 44 | - id: shfmt 45 | args: [--write] 46 | - repo: https://github.com/docker-compose-linter/pre-commit-dclint 47 | rev: v3.1.0 48 | hooks: 49 | - id: dclint 50 | - repo: https://github.com/codespell-project/codespell 51 | rev: v2.4.1 52 | hooks: 53 | - id: codespell 54 | additional_dependencies: 55 | - tomli 56 | - repo: https://github.com/rhysd/actionlint 57 | rev: v1.7.9 58 | hooks: 59 | - id: actionlint 60 | - repo: https://github.com/zizmorcore/zizmor-pre-commit 61 | rev: v1.18.0 62 | hooks: 63 | - id: zizmor 64 | - repo: https://github.com/gitleaks/gitleaks 65 | rev: v8.30.0 66 | hooks: 67 | - id: gitleaks 68 | ci: 69 | autoupdate_schedule: quarterly 70 | skip: [] 71 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /environment: -------------------------------------------------------------------------------- 1 | # See Weblate documentation for detailed description: 2 | # https://docs.weblate.org/en/latest/admin/install/docker.html#generic-settings 3 | 4 | # Weblate setup 5 | WEBLATE_DEBUG=0 6 | WEBLATE_LOGLEVEL=INFO 7 | WEBLATE_SITE_TITLE=Weblate 8 | WEBLATE_ADMIN_NAME=Weblate Admin 9 | WEBLATE_ADMIN_EMAIL=weblate@example.com 10 | WEBLATE_ADMIN_PASSWORD= 11 | WEBLATE_SERVER_EMAIL=weblate@example.com 12 | WEBLATE_DEFAULT_FROM_EMAIL=weblate@example.com 13 | WEBLATE_ALLOWED_HOSTS=* 14 | WEBLATE_REGISTRATION_OPEN=1 15 | 16 | # Extra 17 | #WEBLATE_TIME_ZONE= 18 | #WEBLATE_MT_GOOGLE_KEY= 19 | #WEBLATE_MT_GOOGLE_CREDENTIALS= 20 | #WEBLATE_MT_GOOGLE_PROJECT= 21 | #WEBLATE_MT_GOOGLE_LOCATION= 22 | #WEBLATE_SOCIAL_AUTH_GITHUB_KEY= 23 | #WEBLATE_SOCIAL_AUTH_GITHUB_SECRET= 24 | #WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY= 25 | #WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET= 26 | #WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY= 27 | #WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET= 28 | #WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_KEY= 29 | #WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET= 30 | 31 | # SSL configuration should match your SSL termination setup 32 | #WEBLATE_ENABLE_HTTPS=1 33 | #WEBLATE_IP_PROXY_HEADER=HTTP_X_FORWARDED_FOR 34 | #WEBLATE_SECURE_PROXY_SSL_HEADER=HTTP_X_FORWARDED_PROTO,https 35 | 36 | # Login required 37 | #WEBLATE_REQUIRE_LOGIN=1 38 | 39 | # LDAP Auth 40 | #WEBLATE_AUTH_LDAP_SERVER_URI=ldap://ldap.example.org 41 | #WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE=uid=%(user)s,ou=People,dc=example,dc=net 42 | #WEBLATE_AUTH_LDAP_USER_ATTR_MAP=first_name:name,email:mail 43 | 44 | # PostgreSQL setup 45 | POSTGRES_PASSWORD=weblate 46 | POSTGRES_USER=weblate 47 | POSTGRES_DB=weblate 48 | POSTGRES_HOST=database 49 | POSTGRES_PORT= 50 | 51 | # TODO: needed for Weblate 5.4.x and older containers 52 | POSTGRES_DATABASE=weblate 53 | 54 | # Cache setup 55 | # https://docs.weblate.org/en/latest/admin/install.html#production-cache 56 | REDIS_HOST=cache 57 | REDIS_PORT=6379 58 | 59 | # Mail server, the server has to listen on port 587 and understand TLS 60 | WEBLATE_EMAIL_HOST=127.0.0.1 61 | # Do NOT use quotes here 62 | WEBLATE_EMAIL_HOST_USER= 63 | # Do NOT use quotes here 64 | WEBLATE_EMAIL_HOST_PASSWORD= 65 | 66 | # GitLab lab setup 67 | # WEBLATE_GITLAB_USERNAME= 68 | # WEBLATE_GITLAB_HOST= 69 | # WEBLATE_GITLAB_TOKEN= 70 | 71 | CLIENT_MAX_BODY_SIZE=1000M 72 | -------------------------------------------------------------------------------- /.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/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 | -------------------------------------------------------------------------------- /test-generate: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | if [ "$3" = "saml" ]; then 3 | TEST_EXTRA_ENV='WEBLATE_SAML_IDP_URL: https://example.com/idp' 4 | elif [ "$3" = "celery-single" ]; then 5 | TEST_EXTRA_ENV='CELERY_SINGLE_PROCESS: 1' 6 | elif [ "$3" = "anubis" ]; then 7 | TEST_EXTRA_ENV='WEBLATE_ANUBIS_URL: http://anubis:8923' 8 | else 9 | TEST_EXTRA_ENV='' 10 | fi 11 | 12 | cat > docker-compose.override.yml << EOT 13 | services: 14 | weblate: 15 | image: ${TEST_CONTAINER:-weblate/weblate:edge} 16 | restart: no 17 | environment: 18 | WEBLATE_TIME_ZONE: Europe/Prague 19 | WEBLATE_SITE_DOMAIN: test.example.com 20 | WEBLATE_SILENCED_SYSTEM_CHECKS: weblate.E003,weblate.E011,weblate.E012,weblate.E013,weblate.E017,security.W004,security.W008,security.W012,security.W018,weblate.I021,weblate.E016,weblate.I028,weblate.C030,otp_webauthn.E031 21 | ${TEST_EXTRA_ENV} 22 | ports: 23 | - 8080:8080 24 | - 4443:4443 25 | EOT 26 | 27 | if [ "$3" = "anubis" ]; then 28 | cat > botPolicy.yaml << EOT 29 | bots: 30 | - name: well-known 31 | path_regex: ^/.well-known/.*$ 32 | action: ALLOW 33 | - name: favicon 34 | path_regex: ^/favicon.ico$ 35 | action: ALLOW 36 | - name: robots-txt 37 | path_regex: ^/robots.txt$ 38 | action: ALLOW 39 | - name: generic-browser 40 | user_agent_regex: Mozilla 41 | action: CHALLENGE 42 | EOT 43 | cat >> docker-compose.override.yml << EOT 44 | depends_on: 45 | - anubis 46 | 47 | anubis: 48 | image: ghcr.io/techarohq/anubis:latest 49 | environment: 50 | BIND: ":8923" 51 | DIFFICULTY: "4" 52 | METRICS_BIND: ":9090" 53 | SERVE_ROBOTS_TXT: "false" 54 | TARGET: " " 55 | POLICY_FNAME: "/data/cfg/botPolicy.yaml" 56 | OG_PASSTHROUGH: "false" 57 | ED25519_PRIVATE_KEY_HEX: "$(openssl rand -hex 32)" 58 | volumes: 59 | - "./botPolicy.yaml:/data/cfg/botPolicy.yaml:ro" 60 | 61 | EOT 62 | fi 63 | 64 | if [ "$3" = "split" ]; then 65 | mv docker-compose-split.yml docker-compose.yml 66 | for service in celery-backup celery-beat celery-celery celery-memory celery-notify celery-translate; do 67 | cat >> docker-compose.override.yml << EOT 68 | weblate-${service}: 69 | image: ${TEST_CONTAINER:-weblate/weblate:edge} 70 | restart: no 71 | environment: 72 | WEBLATE_TIME_ZONE: Europe/Prague 73 | WEBLATE_SITE_DOMAIN: test.example.com 74 | EOT 75 | done 76 | fi 77 | if [ "$3" = "read-write" ] || [ "$3" = "localtime" ]; then 78 | sed -i -e '/tmpfs:/D' -e '/- \/run/D' -e '/- \/tmp/D' -e '/read_only: true/D' docker-compose.yml 79 | if [ "$3" = "localtime" ]; then 80 | sed -i -e '/weblate-cache:\/app\/cache/a\ 81 | - /etc/localtime:/etc/localtime:ro' docker-compose.yml 82 | fi 83 | else 84 | # Allow execution in tmp 85 | sed -i 's/- \/tmp/- \/tmp:exec/' docker-compose.yml 86 | fi 87 | 88 | IP=127.0.0.1 89 | PORT=${1:-8080} 90 | PROTO=${2:-http} 91 | 92 | cat > .test.env << EOT 93 | URL=$PROTO://$IP:$PORT/ 94 | EOT 95 | 96 | echo "Weblate will be running on $PROTO://$IP:$PORT/" 97 | echo 98 | echo "Weblate configuration (docker.compose.yml):" 99 | cat docker-compose.yml 100 | echo "Weblate configuration (docker.compose.override.yml):" 101 | cat docker-compose.override.yml 102 | -------------------------------------------------------------------------------- /.github/workflows/dockerimage.yml: -------------------------------------------------------------------------------- 1 | name: Docker Image CI 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | read-only: 7 | runs-on: ubuntu-24.04 8 | env: 9 | # Use short project name, otherwise inspect output is messy 10 | COMPOSE_PROJECT_NAME: wl 11 | 12 | steps: 13 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 14 | with: 15 | persist-credentials: false 16 | - name: Test content 17 | run: ./test-content 18 | - name: Generate configuration 19 | run: ./test-generate 8080 http saml 20 | - name: Startup container 21 | run: ./test-boot 22 | - name: List Python packages 23 | run: ./test-pip 24 | - name: Inspect container 25 | run: ./test-inspect 26 | - name: Check service is running 27 | run: ./test-online 28 | - name: Check service health status 29 | run: ./test-health 30 | - name: Run Django Checks 31 | run: ./test-checks 32 | - name: Verify supervisor 33 | run: ./test-supervisor 34 | - name: Test admin creation 35 | run: ./test-admin 36 | - name: Verify SAML certificate 37 | run: ./test-saml saml 38 | - name: Run commands 39 | run: ./test-commands 40 | - name: Display logs 41 | run: ./test-logs 42 | if: always() 43 | - name: Shutdown service 44 | run: ./test-stop 45 | 46 | read-write: 47 | runs-on: ubuntu-24.04 48 | env: 49 | # Use short project name, otherwise inspect output is messy 50 | COMPOSE_PROJECT_NAME: wl 51 | 52 | steps: 53 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 54 | with: 55 | persist-credentials: false 56 | - name: Generate configuration 57 | run: ./test-generate 8080 http read-write 58 | - name: Startup container 59 | run: ./test-boot 60 | - name: List Python packages 61 | run: ./test-pip 62 | - name: Inspect container 63 | run: ./test-inspect 64 | - name: Check service is running 65 | run: ./test-online 66 | - name: Check service health status 67 | run: ./test-health 68 | - name: Run Django Checks 69 | run: ./test-checks 70 | - name: Verify supervisor 71 | run: ./test-supervisor 72 | - name: Test admin creation 73 | run: ./test-admin 74 | - name: Verify SAML certificate 75 | run: ./test-saml read-write 76 | - name: Run commands 77 | run: ./test-commands 78 | - name: Display logs 79 | run: ./test-logs 80 | if: always() 81 | - name: Shutdown service 82 | run: ./test-stop 83 | 84 | anubis: 85 | runs-on: ubuntu-24.04 86 | env: 87 | # Use short project name, otherwise inspect output is messy 88 | COMPOSE_PROJECT_NAME: wl 89 | 90 | steps: 91 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 92 | with: 93 | persist-credentials: false 94 | - name: Generate configuration 95 | run: ./test-generate 8080 http anubis 96 | - name: Startup container 97 | run: ./test-boot 98 | - name: List Python packages 99 | run: ./test-pip 100 | - name: Inspect container 101 | run: ./test-inspect 102 | - name: Check service is running 103 | run: ./test-online 104 | - name: Check service health status 105 | run: ./test-health 106 | - name: Run Django Checks 107 | run: ./test-checks 108 | - name: Verify supervisor 109 | run: ./test-supervisor 110 | - name: Test admin creation 111 | run: ./test-admin 112 | - name: Verify SAML certificate 113 | run: ./test-saml read-write 114 | - name: Run commands 115 | run: ./test-commands 116 | - name: Display logs 117 | run: ./test-logs 118 | if: always() 119 | - name: Shutdown service 120 | run: ./test-stop 121 | permissions: 122 | contents: read 123 | -------------------------------------------------------------------------------- /.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.18 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 | -------------------------------------------------------------------------------- /docker-compose-split.yml: -------------------------------------------------------------------------------- 1 | services: 2 | cache: 3 | image: valkey/valkey:9.0.1 4 | volumes: 5 | - redis-data:/data 6 | command: [valkey-server, --save, '60', '1', --loglevel, warning] 7 | restart: always 8 | read_only: true 9 | database: 10 | image: postgres:18-alpine 11 | volumes: 12 | - postgres-data:/var/lib/postgresql 13 | env_file: 14 | - ./environment 15 | restart: always 16 | weblate: 17 | image: weblate/weblate 18 | depends_on: 19 | - cache 20 | - database 21 | - weblate-celery-beat 22 | volumes: 23 | - type: volume 24 | source: weblate-data 25 | target: /app/data 26 | environment: 27 | WEBLATE_SERVICE: web 28 | env_file: 29 | - ./environment 30 | restart: always 31 | read_only: true 32 | tmpfs: 33 | - /run 34 | - /tmp 35 | - /app/cache 36 | weblate-celery-backup: 37 | image: weblate/weblate 38 | depends_on: 39 | - cache 40 | - database 41 | - weblate-celery-beat 42 | volumes: 43 | - type: volume 44 | source: weblate-data 45 | target: /app/data 46 | volume: 47 | nocopy: true 48 | environment: 49 | WEBLATE_SERVICE: celery-backup 50 | env_file: 51 | - ./environment 52 | restart: always 53 | read_only: true 54 | tmpfs: 55 | - /run 56 | - /tmp 57 | - /app/cache 58 | weblate-celery-beat: 59 | image: weblate/weblate 60 | depends_on: 61 | - cache 62 | - database 63 | volumes: 64 | - type: volume 65 | source: weblate-data 66 | target: /app/data 67 | volume: 68 | nocopy: true 69 | environment: 70 | WEBLATE_SERVICE: celery-beat 71 | env_file: 72 | - ./environment 73 | restart: always 74 | read_only: true 75 | tmpfs: 76 | - /run 77 | - /tmp 78 | - /app/cache 79 | weblate-celery-celery: 80 | image: weblate/weblate 81 | depends_on: 82 | - cache 83 | - database 84 | - weblate-celery-beat 85 | volumes: 86 | - type: volume 87 | source: weblate-data 88 | target: /app/data 89 | volume: 90 | nocopy: true 91 | environment: 92 | WEBLATE_SERVICE: celery-celery 93 | env_file: 94 | - ./environment 95 | restart: always 96 | read_only: true 97 | tmpfs: 98 | - /run 99 | - /tmp 100 | - /app/cache 101 | weblate-celery-memory: 102 | image: weblate/weblate 103 | depends_on: 104 | - cache 105 | - database 106 | - weblate-celery-beat 107 | volumes: 108 | - type: volume 109 | source: weblate-data 110 | target: /app/data 111 | volume: 112 | nocopy: true 113 | environment: 114 | WEBLATE_SERVICE: celery-memory 115 | env_file: 116 | - ./environment 117 | restart: always 118 | read_only: true 119 | tmpfs: 120 | - /run 121 | - /tmp 122 | - /app/cache 123 | weblate-celery-notify: 124 | image: weblate/weblate 125 | depends_on: 126 | - cache 127 | - database 128 | - weblate-celery-beat 129 | volumes: 130 | - type: volume 131 | source: weblate-data 132 | target: /app/data 133 | volume: 134 | nocopy: true 135 | environment: 136 | WEBLATE_SERVICE: celery-notify 137 | env_file: 138 | - ./environment 139 | restart: always 140 | read_only: true 141 | tmpfs: 142 | - /run 143 | - /tmp 144 | - /app/cache 145 | weblate-celery-translate: 146 | image: weblate/weblate 147 | depends_on: 148 | - cache 149 | - database 150 | - weblate-celery-beat 151 | volumes: 152 | - type: volume 153 | source: weblate-data 154 | target: /app/data 155 | volume: 156 | nocopy: true 157 | environment: 158 | WEBLATE_SERVICE: celery-translate 159 | env_file: 160 | - ./environment 161 | restart: always 162 | read_only: true 163 | tmpfs: 164 | - /run 165 | - /tmp 166 | - /app/cache 167 | volumes: 168 | weblate-data: {} 169 | postgres-data: {} 170 | redis-data: {} 171 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------