From b8f70c4d1bd6cadc5fe905a822f28133af4ba5f6 Mon Sep 17 00:00:00 2001 From: whisper67265 Date: Thu, 7 May 2026 12:38:53 -0700 Subject: [PATCH 1/3] Land fork-specific README for weblate-docker. --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 47 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 10f9750f7..dd34c0117 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,59 @@ Weblate -**Weblate is libre software web-based continuous localization system, -used by over 2500 libre projects and companies in more than 165 countries.** +# Boost-Weblate Docker image -# Official Docker container for Weblate +This repository packages **[Boost-Weblate](https://weblate.org/)**—Weblate plus the `boost-weblate` Python distribution—for deployment as **`boost-weblate:latest`**. It is derived from the [WeblateOrg/docker](https://github.com/WeblateOrg/docker) layout (multi-stage `weblate/dev` + `weblate/base`, nginx, supervisor, Celery). -[![Website](https://img.shields.io/badge/website-weblate.org-blue.svg)](https://weblate.org/) -[![Translation status](https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg)](https://hosted.weblate.org/engage/weblate/?utm_source=widget) -[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/552/badge)](https://bestpractices.coreinfrastructure.org/projects/552) -[![Documentation](https://readthedocs.org/projects/weblate/badge/)][doc] +Upstream Weblate remains libre software; see [weblate.org](https://weblate.org/) and the [official Docker install docs][doc]. -## Running Weblate +## Repository layout (required for builds) -- [Weblate docker-compose](https://github.com/WeblateOrg/docker-compose) -- [OpenShift](https://docs.weblate.org/en/latest/admin/install/openshift.html) -- [Helm chart for Weblate](https://hub.helm.sh/charts/weblate/weblate) +The `Dockerfile` expects a **parent directory** as the Docker build context: -## Exposed ports +| Path (relative to parent) | Role | +|---------------------------|------| +| `weblate-docker/` | This repo (Dockerfile, `requirements.txt`, `etc/`, `start`, …) | +| Parent root | **`boost-weblate`** sources (`COPY . /app/boost-weblate/` installs `/app/boost-weblate[extras]`) | -The webserver is running on the port 8080. +`docker-compose.yml` is written for that layout: build **`context: ..`**, **`dockerfile: weblate-docker/Dockerfile`**. Clone or arrange your monorepo so the docker tree lives at **`weblate-docker/`** next to the application root that pip installs as `boost-weblate`. -## Documentation +## Quick start -Detailed documentation is available in [Weblate documentation][doc]. +1. Place this tree at **`../weblate-docker`** relative to your **`boost-weblate`** repo root (see above). +2. Copy and edit environment variables: + + ```bash + cp environment.example environment + ``` + + Set at least **`WEBLATE_SITE_DOMAIN`**, **`POSTGRES_*`**, and any admin/email/Git credentials you need. PostgreSQL is expected **outside** the compose file (for example on the host); **`POSTGRES_HOST`** defaults to `host.docker.internal` in `environment.example`. + +3. From **`weblate-docker/`**, build and run: + + ```bash + docker compose up --build -d + ``` + +4. Open the UI at **http://localhost:8000** (compose maps **8000 → 8080**; nginx listens on **8080** inside the container). + +## Fork-specific settings + +See **`environment.example`** for Boost-oriented options, including: + +- **`AUTO_BATCH_TRANSLATE_VIA_OPENROUTER`** — optional batch translation via OpenRouter. +- **`BOOST_ENDPOINT_ADD_TRANSLATION_SECONDS`** — wait time before treating a component/translation as ready when adding languages. + +Generic Weblate Docker variables (debug, hosts, mail, LDAP, Git hosting tokens, and more) are documented in the [Weblate Docker documentation][doc]. + +## Image details + +- **Image name (compose):** `boost-weblate:latest` +- **Weblate version:** pinned via **`WEBLATE_VERSION`** in the `Dockerfile` (see that file for the current value). +- **Patches:** any `*.patch` files under `weblate-docker/patches` are applied to the installed Weblate packages at build time. + +## Related repositories + +- [Weblate docker-compose](https://github.com/WeblateOrg/docker-compose) — reference stacks (this repo vendors it as a **git submodule** at `docker-compose/`). +- [Official Weblate Docker image docs][doc] [doc]: https://docs.weblate.org/en/latest/admin/install/docker.html From 5e1ac97d4e6736e51589596ed087acab495641ce Mon Sep 17 00:00:00 2001 From: whisper67265 Date: Thu, 7 May 2026 13:47:06 -0700 Subject: [PATCH 2/3] Update README.md --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index dd34c0117..d2b25e63a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Boost-Weblate Docker image -This repository packages **[Boost-Weblate](https://weblate.org/)**—Weblate plus the `boost-weblate` Python distribution—for deployment as **`boost-weblate:latest`**. It is derived from the [WeblateOrg/docker](https://github.com/WeblateOrg/docker) layout (multi-stage `weblate/dev` + `weblate/base`, nginx, supervisor, Celery). +This repository packages **Boost-Weblate**—Weblate plus the `boost-weblate` Python distribution—for deployment as **`boost-weblate:latest`**. It is derived from the [WeblateOrg/docker](https://github.com/WeblateOrg/docker) layout (multi-stage `weblate/dev` + `weblate/base`, nginx, supervisor, Celery). Upstream Weblate remains libre software; see [weblate.org](https://weblate.org/) and the [official Docker install docs][doc]. @@ -51,9 +51,3 @@ Generic Weblate Docker variables (debug, hosts, mail, LDAP, Git hosting tokens, - **Weblate version:** pinned via **`WEBLATE_VERSION`** in the `Dockerfile` (see that file for the current value). - **Patches:** any `*.patch` files under `weblate-docker/patches` are applied to the installed Weblate packages at build time. -## Related repositories - -- [Weblate docker-compose](https://github.com/WeblateOrg/docker-compose) — reference stacks (this repo vendors it as a **git submodule** at `docker-compose/`). -- [Official Weblate Docker image docs][doc] - -[doc]: https://docs.weblate.org/en/latest/admin/install/docker.html From c3392b8192da671137ba50e16f4e31ce7d685cf1 Mon Sep 17 00:00:00 2001 From: whisper67265 Date: Thu, 7 May 2026 13:50:24 -0700 Subject: [PATCH 3/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d2b25e63a..5ce902951 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,4 @@ Generic Weblate Docker variables (debug, hosts, mail, LDAP, Git hosting tokens, - **Weblate version:** pinned via **`WEBLATE_VERSION`** in the `Dockerfile` (see that file for the current value). - **Patches:** any `*.patch` files under `weblate-docker/patches` are applied to the installed Weblate packages at build time. +[doc]: https://docs.weblate.org/en/latest/admin/install/docker.html