Skip to content

Commit b9d862b

Browse files
committed
docs(i18n): recommend free Hosted Weblate (wger approach)
Lyftr is MIT + public, so it qualifies for Hosted Weblate's free libre plan — same as wger. Make that the default path, default .weblate back to hosted.weblate.org, and keep self-hosting as a documented alternative. https://claude.ai/code/session_016WYyAzJvCGWDfDJGdvyRXr
1 parent c5b02f6 commit b9d862b

2 files changed

Lines changed: 25 additions & 28 deletions

File tree

.weblate

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
# NEVER commit an API token here. Store it in ~/.config/weblate under [keys].
99

1010
[weblate]
11-
# Self-hosted instance. (Hosted Weblate users: https://hosted.weblate.org/api/)
12-
url = https://weblate.example.com/api/
11+
# Free Hosted Weblate (libre projects). Self-hosters: set your own URL.
12+
url = https://hosted.weblate.org/api/
1313

1414
# Default project/component the CLI operates on. Adjust to your project slug.
1515
[component "lyftr/web"]

TRANSLATING.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -99,45 +99,42 @@ Configure one component in the Weblate project UI:
9999

100100
The `github` VCS backend ("GitHub pull request") makes Weblate push
101101
translations back as pull requests instead of committing to `main` directly.
102-
For that to work the instance needs GitHub credentials.
103102

104-
### Self-hosting the instance
103+
### Recommended: free Hosted Weblate (the wger approach)
105104

106-
Weblate runs as a Docker stack. Use the official compose — don't fork it:
105+
Lyftr is MIT-licensed and developed in the open, so it qualifies for
106+
[Hosted Weblate's free plan for libre projects](https://hosted.weblate.org/hosting/)
107+
the same setup [wger](https://hosted.weblate.org/engage/wger/) and most
108+
open-source apps use. No server, no Docker.
107109

108-
```bash
109-
git clone https://github.com/WeblateOrg/docker.git weblate-docker
110-
cd weblate-docker
111-
# edit ./environment — at minimum set:
112-
# WEBLATE_SITE_DOMAIN, WEBLATE_ADMIN_EMAIL, WEBLATE_ADMIN_PASSWORD
113-
# WEBLATE_SERVER_EMAIL, WEBLATE_DEFAULT_FROM_EMAIL
114-
# WEBLATE_GITHUB_USERNAME + WEBLATE_GITHUB_TOKEN ← enables the PR backend
115-
docker compose up -d
116-
```
110+
1. Sign in at [hosted.weblate.org](https://hosted.weblate.org/) and **add a
111+
project**, pointing it at `github.com/Cawlumm/lyftr`.
112+
2. Add a component with the values in the table above and `github` as the VCS
113+
backend; authorize Weblate's GitHub App when prompted so it can open PRs.
114+
3. Request libre hosting — a Weblate maintainer approves it (one-time).
117115

118-
It must run on a **persistent host** with a real domain (not in CI / ephemeral
119-
containers). See the [official self-hosting docs](https://docs.weblate.org/en/latest/admin/install/docker.html)
120-
for the full env reference.
116+
Translators then work at `hosted.weblate.org/projects/lyftr/` and their changes
117+
land as pull requests against `main`.
121118

122-
Once it's up, create the project + component without clicking through the UI:
119+
### Alternative: self-host
120+
121+
To run your own instance (e.g. to keep the repo private), use the official
122+
Docker stack plus [`scripts/weblate-provision.sh`](scripts/weblate-provision.sh),
123+
which creates the project + component via the API:
123124

124125
```bash
125-
WEBLATE_URL=https://weblate.example.com \
126-
WEBLATE_TOKEN=<your admin API token> \
127-
scripts/weblate-provision.sh
126+
git clone https://github.com/WeblateOrg/docker.git weblate-docker
127+
# in ./environment set WEBLATE_SITE_DOMAIN, *_ADMIN_*, WEBLATE_GITHUB_USERNAME+TOKEN, then:
128+
docker compose up -d
129+
WEBLATE_URL=https://weblate.example.com WEBLATE_TOKEN=<token> scripts/weblate-provision.sh
128130
```
129131

130-
The script creates the project and component with the exact values from the
131-
table above. If it rejects `file_format` or `vcs`, confirm the slugs against
132-
your version (`GET <url>/api/file-formats/`) and pass overrides, e.g.
133-
`FILE_FORMAT=… VCS=… scripts/weblate-provision.sh`.
134-
135132
### The `.weblate` CLI config
136133

137134
The repo-root `.weblate` file points the
138135
[`wlc`](https://docs.weblate.org/en/latest/wlc.html) CLI at the server and
139-
default component — update the `url` to your instance. **Never commit an API
140-
token**; `wlc` reads it from `~/.config/weblate`.
136+
default component. It defaults to Hosted Weblate; change the `url` only if you
137+
self-host. **Never commit an API token**; `wlc` reads it from `~/.config/weblate`.
141138

142139
---
143140

0 commit comments

Comments
 (0)