Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
55f232e172 | ||
|
|
1f23ea1d78 | ||
|
|
a705a49495 | ||
|
|
5c23ec9310 | ||
|
|
b39c9b9289 | ||
|
|
f2e74564df | ||
|
|
b0edbf2c33
|
No files matched your search
+22
-40
@@ -1,33 +1,25 @@
|
|||||||
# Woodpecker CI pipeline for co-op/docs — THIN on purpose.
|
# Woodpecker CI pipeline for co-op/docs — THIN and SECRET-FREE on purpose.
|
||||||
#
|
#
|
||||||
# It does NOT re-implement the build. The repository's publishing layer is the
|
# It does NOT deploy. Publishing is host-side and split:
|
||||||
# single source of truth and this pipeline only wires it up:
|
|
||||||
#
|
#
|
||||||
# publishing/requirements.txt pinned MkDocs + Material toolchain
|
# /usr/local/sbin/docs-poll host-owned poller (root) — pulls main
|
||||||
# publishing/build.sh stage Markdown -> .site-src/, render .site-build/
|
# publishing/build.sh runs as the unprivileged `docsbuild` user,
|
||||||
# publishing/deploy.sh push .site-build/ into the Cloudron Surfer app
|
# with no credentials and no access to
|
||||||
|
# /home/ubuntu
|
||||||
|
# /usr/local/sbin/docs-publish root-owned publish step — runs no repo code,
|
||||||
|
# holds the Cloudron token from a root-only file
|
||||||
#
|
#
|
||||||
# Any change to how the site is built belongs in publishing/, never here.
|
# CI exists only to prove the repository builds. It runs in a throwaway venv
|
||||||
|
# inside the pipeline workspace, never the agent image's shared /opt/docs-venv:
|
||||||
|
# a push to ANY repo must not be able to change a toolchain that another
|
||||||
|
# pipeline uses. No secret is wired into this pipeline, and none should be
|
||||||
|
# until the Woodpecker agent supports per-pipeline isolation.
|
||||||
#
|
#
|
||||||
# Run model: MANUAL ONLY for now. The Gitea webhook that fires this on push is
|
# Backend note: the co-op's Woodpecker agent is a Cloudron app with no Docker
|
||||||
# deliberately NOT wired — the poll watcher (docs-deploy-poll.service on the
|
# socket, so it uses Woodpecker's `local` backend. Each step runs as a shell
|
||||||
# agent host) remains the live auto-deploy path until a manual run has proven
|
# command INSIDE the agent container; the `image:` field selects the SHELL, not
|
||||||
# the pipeline. Once it has, add `push` to the `when` block below and register
|
# a container image. That is exactly why this file must stay secret-free: the
|
||||||
# the webhook in Gitea.
|
# container is shared by every pipeline.
|
||||||
#
|
|
||||||
# Backend note (IMPORTANT — this is why there are no container images here):
|
|
||||||
# The co-op's Woodpecker agent runs as a Cloudron app, which has no Docker
|
|
||||||
# socket, so it uses Woodpecker's `local` backend. Under `local` each step is
|
|
||||||
# run as a shell command INSIDE the agent container, and the step's `image:`
|
|
||||||
# field selects the SHELL, not a container image. Every tool the steps need is
|
|
||||||
# therefore baked into the agent image (co-op/woodpecker-agent):
|
|
||||||
# python3 + the pinned MkDocs toolchain (venv at /opt/docs-venv, mirroring
|
|
||||||
# publishing/requirements.txt), node + the cloudron CLI, bash, git, tar.
|
|
||||||
# If the toolchain pin changes, rebuild that image — see its Dockerfile.
|
|
||||||
#
|
|
||||||
# Secrets required (Woodpecker repo secret, name `cloudron_token`):
|
|
||||||
# cloudron_token = the Cloudron API token used by publishing/deploy.sh
|
|
||||||
# Do not put credentials in this file.
|
|
||||||
|
|
||||||
when:
|
when:
|
||||||
- event: manual
|
- event: manual
|
||||||
@@ -36,17 +28,7 @@ steps:
|
|||||||
- name: build
|
- name: build
|
||||||
image: bash
|
image: bash
|
||||||
commands:
|
commands:
|
||||||
# Reuses the toolchain pre-installed in the agent image; build.sh only
|
# Ephemeral toolchain per run — no shared venv, no /opt/docs-venv.
|
||||||
# creates/installs a venv if the one given is missing, which it is not.
|
- python3 -m venv .ci-venv
|
||||||
- publishing/build.sh /opt/docs-venv
|
- .ci-venv/bin/pip install -q -r publishing/requirements.txt
|
||||||
|
- publishing/build.sh .ci-venv
|
||||||
- name: deploy
|
|
||||||
image: bash
|
|
||||||
commands:
|
|
||||||
# deploy.sh drives the Cloudron `cloudron` CLI (a node program) via
|
|
||||||
# `cloudron exec`; node, the CLI, bash, git and tar are all in the agent
|
|
||||||
# image. The build it publishes is the shared workspace .site-build/.
|
|
||||||
- publishing/deploy.sh
|
|
||||||
environment:
|
|
||||||
CLOUDRON_TOKEN:
|
|
||||||
from_secret: cloudron_token
|
|
||||||
@@ -83,13 +83,31 @@ Our server software keeps standard operational logs (dates, error messages, and
|
|||||||
|
|
||||||
## 5. Search
|
## 5. Search
|
||||||
|
|
||||||
Web search runs through our self-hosted search instance. For chat searches we use DuckDuckGo and Brave; those services receive your query from our server, and may see it. This is inherent to how web search works. Search queries and results are part of the conversation record, so they follow that conversation's retention: deleted when you delete a saved chat, or about an hour after a Temporary Chat is created. Operational details are in [Infrastructure](../operations/infrastructure.md#chat-retention-and-web-search).
|
Our self-hosted **SearXNG** instance at
|
||||||
|
[search.inference.coop](https://search.inference.coop) handles web search. For
|
||||||
|
chat searches it forwards queries to **DuckDuckGo** and **Brave**; those
|
||||||
|
services receive the query from our server and may see it. Search queries and
|
||||||
|
results are part of the conversation record, so they follow that conversation's
|
||||||
|
retention: deleted when you delete a saved chat, or about an hour after a
|
||||||
|
Temporary Chat is created. Operational details are in
|
||||||
|
[Infrastructure](../operations/infrastructure.md#chat-retention-and-web-search).
|
||||||
|
|
||||||
|
To read the pages behind the results, our own page-fetch service fetches the
|
||||||
|
top result URLs. It runs on co-op infrastructure at fetch.inference.coop. The
|
||||||
|
service does not log the URLs or the page text and keeps no copy: the extracted
|
||||||
|
text goes to the model for that answer and is not stored by the fetcher. It
|
||||||
|
refuses private, loopback, and internal addresses, so it cannot be used to reach
|
||||||
|
our own network. Your chat messages and account identity stay with us.
|
||||||
|
|
||||||
|
Web search is optional. Leave the globe off for sensitive topics. Note that the
|
||||||
|
search engines in §7 still receive your query when you use it.
|
||||||
|
|
||||||
## 6. What we do NOT do
|
## 6. What we do NOT do
|
||||||
|
|
||||||
- We do **not** train models on your data.
|
- We do **not** train models on your data.
|
||||||
- We do **not** sell, rent, or share your data.
|
- We do **not** sell or rent your data.
|
||||||
- We do **not** use your data for advertising or profiling.
|
- We do **not** share data for advertising or profiling. The service providers
|
||||||
|
in §5 and §7 process data to run the service.
|
||||||
|
|
||||||
## 7. Third parties
|
## 7. Third parties
|
||||||
|
|
||||||
@@ -97,7 +115,8 @@ The models we serve are provided by third parties that change over time, each wi
|
|||||||
|
|
||||||
- **Open Collective** — handles billing and membership (their own privacy policy applies).
|
- **Open Collective** — handles billing and membership (their own privacy policy applies).
|
||||||
- **Cloudron** — our self-hosted platform; no third-party cloud provider.
|
- **Cloudron** — our self-hosted platform; no third-party cloud provider.
|
||||||
- **Search engines** — receive your search queries (see §5).
|
- **Search engines.** DuckDuckGo and Brave receive your search queries (see §5).
|
||||||
|
Page fetching runs on co-op infrastructure, not at a third party.
|
||||||
|
|
||||||
## 8. Retention and deletion
|
## 8. Retention and deletion
|
||||||
|
|
||||||
@@ -110,7 +129,8 @@ The models we serve are provided by third parties that change over time, each wi
|
|||||||
|
|
||||||
- Self-hosted on Cloudron (sandboxed apps, SSL, backups).
|
- Self-hosted on Cloudron (sandboxed apps, SSL, backups).
|
||||||
- Per-member API keys; access gated on live membership.
|
- Per-member API keys; access gated on live membership.
|
||||||
- No external dependencies for core infrastructure.
|
- Core infrastructure has no external dependencies. Web search sends queries
|
||||||
|
to the search engines named in §5; page fetching runs on co-op infrastructure.
|
||||||
|
|
||||||
## 10. Your rights
|
## 10. Your rights
|
||||||
|
|
||||||
|
|||||||
@@ -56,8 +56,10 @@ with the account you created in step 1.
|
|||||||
(GreenPT and Regolo, 100% renewable energy — Regolo adds a written
|
(GreenPT and Regolo, 100% renewable energy — Regolo adds a written
|
||||||
zero-data-retention policy). See the [model list](models.md) for the full
|
zero-data-retention policy). See the [model list](models.md) for the full
|
||||||
list.
|
list.
|
||||||
- **Web search** — click the **globe** next to the message box to ground
|
- **Web search.** Click the **globe** next to the message box to base answers
|
||||||
answers in current web results (self-hosted search, no external dependency).
|
on current web results. Searches use our self-hosted SearXNG instance, and
|
||||||
|
pages are read by our own fetcher. See [what happens during a
|
||||||
|
search](#what-happens-when-you-use-web-search).
|
||||||
- **File uploads** — attach a document with the **paperclip** and ask the
|
- **File uploads** — attach a document with the **paperclip** and ask the
|
||||||
chat about it.
|
chat about it.
|
||||||
- **Tools** — the **Tools menu** next to the message box lists everything the
|
- **Tools** — the **Tools menu** next to the message box lists everything the
|
||||||
@@ -84,6 +86,22 @@ see "Your allowance" below.
|
|||||||
> — your full history is here in the new chat, but files you attached in the
|
> — your full history is here in the new chat, but files you attached in the
|
||||||
> old one are still accessible only there.
|
> old one are still accessible only there.
|
||||||
|
|
||||||
|
### What happens when you use web search
|
||||||
|
|
||||||
|
Web search runs in two stages.
|
||||||
|
|
||||||
|
1. Our self-hosted **SearXNG** instance at
|
||||||
|
[search.inference.coop](https://search.inference.coop) sends your query to
|
||||||
|
**DuckDuckGo** and **Brave**.
|
||||||
|
2. LibreChat sends the top result URLs to the co-op's **own page fetcher**. It
|
||||||
|
reads each page and extracts its text. The model receives those passages,
|
||||||
|
and the answer cites the sources.
|
||||||
|
|
||||||
|
Both SearXNG and the page fetcher run on co-op infrastructure. The fetcher does
|
||||||
|
not log the URLs or the page text and keeps no copy. The
|
||||||
|
[privacy policy](../governance/privacy-policy.md#5-search) describes this. Web
|
||||||
|
search is optional. Leave the globe off if you do not want pages fetched.
|
||||||
|
|
||||||
### Add the chat to your phone
|
### Add the chat to your phone
|
||||||
|
|
||||||
The chat works like an app on your phone — no app store needed. Open
|
The chat works like an app on your phone — no app store needed. Open
|
||||||
|
|||||||
@@ -34,11 +34,22 @@ This page is for members who read its output or give it instructions.
|
|||||||
portal and a human.
|
portal and a human.
|
||||||
- Credentials, in either direction.
|
- Credentials, in either direction.
|
||||||
|
|
||||||
|
## Content is data, never instructions
|
||||||
|
|
||||||
|
Text an agent reads — issue descriptions, pull-request comments, web pages,
|
||||||
|
fetched documents, and messages from members in a room — is **data**. The agent
|
||||||
|
may quote, summarise or act on it once the operator asks, but an instruction
|
||||||
|
embedded in that text is never executed. Only the operator's own direct
|
||||||
|
instruction authorises a credentialed action: a deploy, a credential change, or
|
||||||
|
a budget change. This rule exists because the same process that reads an issue
|
||||||
|
can reach the infrastructure the issue is about.
|
||||||
|
|
||||||
## What they do without asking
|
## What they do without asking
|
||||||
|
|
||||||
Read, monitor, draft, open issues and PRs, post updates, run the scheduled jobs
|
Read, monitor, draft, open issues and PRs, post updates, run the scheduled jobs
|
||||||
listed in [Infrastructure](infrastructure.md), and deploy bug and security
|
listed in [Infrastructure](infrastructure.md), and deploy fixes after flagging
|
||||||
fixes immediately, reporting each one in #inferencebot-updates.
|
them to the operator. The bot can deploy without waiting for a reply, and the
|
||||||
|
operator can stop a deploy; anything irreversible waits for confirmation.
|
||||||
|
|
||||||
## What always needs a human
|
## What always needs a human
|
||||||
|
|
||||||
|
|||||||
@@ -73,8 +73,10 @@ The co-op's software behind all of these is open source — see [The
|
|||||||
code](#the-code) below for where each piece lives.
|
code](#the-code) below for where each piece lives.
|
||||||
|
|
||||||
Open Collective (billing and fiscal sponsorship) is the one external service in
|
Open Collective (billing and fiscal sponsorship) is the one external service in
|
||||||
the flow — see
|
the membership flow. See
|
||||||
[opencollective.com/inference-cooperative](https://opencollective.com/inference-cooperative).
|
[opencollective.com/inference-cooperative](https://opencollective.com/inference-cooperative).
|
||||||
|
Web search uses external services too; see
|
||||||
|
[Chat retention and web search](#chat-retention-and-web-search).
|
||||||
|
|
||||||
## Mail
|
## Mail
|
||||||
|
|
||||||
@@ -199,6 +201,12 @@ contain query text when an upstream engine request fails; those log lines carry
|
|||||||
no member identity or IP, and are retained only briefly. The reverse proxy does
|
no member identity or IP, and are retained only briefly. The reverse proxy does
|
||||||
not log search queries.
|
not log search queries.
|
||||||
|
|
||||||
|
LibreChat reads the pages behind the results through the co-op's **own
|
||||||
|
page-fetch service** (`fetch.inference.coop`), a small app on our Cloudron. It
|
||||||
|
runs with no access log and keeps no copy of URLs or page text; it refuses
|
||||||
|
private, loopback, and internal addresses. The
|
||||||
|
[privacy policy](../governance/privacy-policy.md#5-search) describes it.
|
||||||
|
|
||||||
## Security posture (plain language)
|
## Security posture (plain language)
|
||||||
|
|
||||||
- **Member isolation.** Each API key is scoped to its owner's team and budget; a
|
- **Member isolation.** Each API key is scoped to its owner's team and budget; a
|
||||||
|
|||||||
+42
-69
@@ -17,11 +17,11 @@ repository root.
|
|||||||
| `logo.svg` | Co-op logo (shared with the website repo) |
|
| `logo.svg` | Co-op logo (shared with the website repo) |
|
||||||
| `build.sh` | Stage the Markdown into `.site-src/`, render to `.site-build/` |
|
| `build.sh` | Stage the Markdown into `.site-src/`, render to `.site-build/` |
|
||||||
| `hooks.py` | MkDocs hooks: directory-link rewriting + content-hashed stylesheet URLs |
|
| `hooks.py` | MkDocs hooks: directory-link rewriting + content-hashed stylesheet URLs |
|
||||||
| `deploy.sh` | Push the build into the Surfer app container |
|
| `deploy.sh` | Manual publish of the build into the Surfer app (needs a Cloudron token) |
|
||||||
| `poll-watcher.sh` | Polls Gitea main every 60s; deploys on change (agent host) |
|
| `poll-watcher.sh` | Legacy poller; no longer installed — superseded by the host-owned poller |
|
||||||
| `docs-deploy-poll.service` | systemd unit for the poller |
|
| `docs-deploy-poll.service` | systemd unit for the poller (runs the host-owned script) |
|
||||||
| `webhook-receiver.py` | Gitea webhook → pull → build → deploy (agent host) |
|
| `webhook-receiver.py` | Webhook receiver; not installed (see below) |
|
||||||
| `webhook-receiver.service` | systemd unit for the receiver |
|
| `webhook-receiver.service` | systemd unit for the receiver; not installed |
|
||||||
| `requirements.txt` | Pinned Python build toolchain |
|
| `requirements.txt` | Pinned Python build toolchain |
|
||||||
|
|
||||||
Nothing external is loaded by the site: no CDN, no third-party font service.
|
Nothing external is loaded by the site: no CDN, no third-party font service.
|
||||||
@@ -71,79 +71,52 @@ Override the destination with `SURFER_APP` (the app's Cloudron location) and
|
|||||||
|
|
||||||
## Automatic rebuilds (push to main)
|
## Automatic rebuilds (push to main)
|
||||||
|
|
||||||
Two mechanisms keep the site in step with `main`; both run on the agent host
|
`docs-deploy-poll.service` polls Gitea every 60 seconds and deploys whenever
|
||||||
and deploy into the docs Cloudron app above.
|
`main` moves, so a push appears on the site within about a minute with no human
|
||||||
|
action. Edit, commit, push — that is the whole deployment story.
|
||||||
|
|
||||||
**Polling (running now).** `docs-deploy-poll.service` polls Gitea every 60
|
**The credential-bearing steps are host-owned, not repository code.** The
|
||||||
seconds and deploys whenever `main` moves. A push appears on the site within
|
poller runs a root-owned script (`/usr/local/sbin/docs-poll`) that does two
|
||||||
about a minute, with no human action. The Gitea webhook alone was not enough
|
separate jobs:
|
||||||
because the agent host's cloud firewall only admits inbound SSH — a webhook
|
|
||||||
POST is silently dropped — while outbound access to Gitea works.
|
|
||||||
|
|
||||||
The service builds from a **dedicated clean clone** at
|
1. **Build as `docsbuild`.** The repository's build logic (`build.sh` → MkDocs
|
||||||
`/home/ubuntu/.docs-publisher`, not from anyone's working copy, so uncommitted
|
→ `hooks.py`) runs as an unprivileged system user with a scrubbed
|
||||||
edits in a working clone can never block a deploy. Edit, commit, push — that
|
environment, from its own clean clone at `/var/lib/docs-publisher/repo`
|
||||||
is the whole deployment story.
|
with its own venv. That user cannot read `/home/ubuntu` (mode 750), so repo
|
||||||
|
code cannot see any co-op credential — the Cloudron token, the gateway
|
||||||
|
master key, the agent's env file.
|
||||||
|
2. **Publish with a root-owned script.** `/usr/local/sbin/docs-publish` runs
|
||||||
|
no repository code. It takes only the built directory, writes `meta.json`,
|
||||||
|
and pushes it into the Surfer app using `CLOUDRON_TOKEN` from
|
||||||
|
`/etc/docs-deploy.env` (root-only, mode 0600).
|
||||||
|
|
||||||
**Webhook (wired, waiting on one port).** A Gitea webhook is registered on
|
A commit that lands on `main` therefore cannot execute anything with the
|
||||||
`co-op/docs` (push events, branch `main`) pointing at the receiver below. The
|
Cloudron token. It can only influence the bytes of the site.
|
||||||
moment the Infomaniak panel allows inbound TCP to the agent host — port 8787
|
|
||||||
from the Cloudron box 179.237.86.116 is enough — start the receiver and pushes
|
|
||||||
deploy instantly instead of within a minute:
|
|
||||||
|
|
||||||
```sh
|
**The webhook receiver is installed but not running.** `docs-deploy-webhook`
|
||||||
sudo systemctl enable --now docs-deploy-webhook
|
is inactive and nothing listens on 8787. It predates this split, loads the
|
||||||
tail -f /home/ubuntu/docs-deploy.log # what both mechanisms are doing
|
agent's env file, and runs repo scripts with the Cloudron token; do not enable
|
||||||
```
|
it without porting it to the same host-owned build/publish split. The Gitea
|
||||||
|
webhook registration is harmless while the receiver is down.
|
||||||
The receiver authenticates webhooks with an HMAC-SHA256 shared secret
|
|
||||||
(`DEPLOY_WEBHOOK_SECRET` in the agent host's env file) and only accepts pushes
|
|
||||||
to `main` of `co-op/docs` from the Cloudron box. Woodpecker CI (Cloudron
|
|
||||||
catalog) could do the same job inside Cloudron, at the cost of running another
|
|
||||||
app; the agent-host mechanisms were chosen because they add no new Cloudron app.
|
|
||||||
|
|
||||||
Each deploy writes `meta.json` into the site with the commit it was built
|
Each deploy writes `meta.json` into the site with the commit it was built
|
||||||
from, so a deploy can be verified from the served site itself:
|
from, so a deploy can be verified from the served site itself:
|
||||||
https://docs.inference.coop/meta.json
|
https://docs.inference.coop/meta.json
|
||||||
|
|
||||||
## One build environment (2026-11-12)
|
If a deploy breaks, roll back with the saved unit
|
||||||
|
(`/root/docs-deploy-poll.service.before-split`) and the previous build in
|
||||||
|
`/var/lib/docs-publisher/repo/.site-build`; the poller retries every 60 seconds
|
||||||
|
and sends one Matrix alert after 3 consecutive failures.
|
||||||
|
|
||||||
The deploy used to have TWO build environments — this repo's `.venv-docs` and
|
## Build environment
|
||||||
a second private venv in the poller's checkout at
|
|
||||||
`/home/ubuntu/.docs-publisher/.venv-docs`. They diverged twice, each time
|
|
||||||
silently delaying a deploy (the brand.css cache-busting confusion, then a
|
|
||||||
missing `mkdocs-redirects` that failed every build for ~15 minutes while the
|
|
||||||
poller retried without telling anyone). Consolidated:
|
|
||||||
|
|
||||||
- **ONE venv.** Every trigger — the poller, the (dormant) webhook receiver, a
|
`publishing/requirements.txt` pins every package the build needs (`mkdocs`,
|
||||||
manual `publishing/build.sh`, CI — builds with the canonical checkout's
|
`mkdocs-material`, `mkdocs-redirects`). `build.sh` verifies the build venv
|
||||||
venv: `~/repos/docs/.venv-docs`. The poller's private venv was deleted.
|
against it before every build and installs anything missing or off-version
|
||||||
- **The dedicated checkout stays, by design.** The poller still builds from
|
(fast local no-op when current); it also fails loudly if `mkdocs.yml`
|
||||||
`/home/ubuntu/.docs-publisher`, its own clean clone: uncommitted edits in a
|
configures a plugin that `requirements.txt` does not pin.
|
||||||
working clone must never block a deploy or leak into the published site.
|
|
||||||
- **Drift check.** Before every build the poller compares `publishing/` and
|
|
||||||
`mkdocs.yml` between its checkout and the canonical one; any mismatch fails
|
|
||||||
the deploy loudly (with a diff and the fix — `git -C ~/repos/docs pull
|
|
||||||
--ff-only`), and the failure counts toward the alert below. A canonical
|
|
||||||
checkout that lags behind main trips this too, on purpose: a deploy of
|
|
||||||
logic the canonical source cannot reproduce is the failure mode this exists
|
|
||||||
to prevent. A missing canonical checkout is fatal as well.
|
|
||||||
- **Plugin gate + self-heal.** `publishing/requirements.txt` pins every
|
|
||||||
package the build needs (`mkdocs`, `mkdocs-material`, `mkdocs-redirects`).
|
|
||||||
`build.sh` verifies the venv against it before every build and installs
|
|
||||||
anything missing or off-version (fast local no-op when current); it also
|
|
||||||
fails loudly if `mkdocs.yml` configures a plugin that `requirements.txt`
|
|
||||||
does not pin. The poller runs this as its pre-deploy check via
|
|
||||||
`build.sh --check-only`.
|
|
||||||
- **Failure alerting.** After 3 consecutive deploy failures the poller writes
|
|
||||||
a marker (`~/.docs-deploy.alert`) and sends ONE message to the InferenceBot
|
|
||||||
HQ Matrix room naming the failing commit — never more than one message per
|
|
||||||
hour (`~/.docs-deploy.last-alert`). The counter (`~/.docs-deploy.failcount`)
|
|
||||||
resets on the next successful deploy. A deploy that succeeds silently
|
|
||||||
resets everything; nothing announces routine successes.
|
|
||||||
|
|
||||||
Files: `~/.docs-deploy.state` (last deployed commit), `~/.docs-deploy.lock`
|
The deployed poller keeps one build venv at
|
||||||
(deploy lock), `~/.docs-deploy.failcount`, `~/.docs-deploy.alert`,
|
`/var/lib/docs-publisher/repo/.venv-docs`, owned by `docsbuild`. A manual
|
||||||
`~/.docs-deploy.last-alert`. Manual deploys should respect the lock:
|
`publishing/build.sh` uses `.venv-docs` in whatever checkout you run it from;
|
||||||
`flock -n ~/.docs-deploy.lock bash publishing/build.sh && flock -n
|
that is fine for local previews and does not affect deploys.
|
||||||
~/.docs-deploy.lock bash publishing/deploy.sh`.
|
|
||||||
@@ -1,41 +1,42 @@
|
|||||||
# systemd unit for the docs auto-deploy poller (agent host).
|
# systemd unit for the docs auto-deploy poller (agent host).
|
||||||
#
|
#
|
||||||
# docs-deploy-poll.service ALWAYS ON. Polls Gitea every 60s; deploys on
|
# docs-deploy-poll.service ALWAYS ON. Polls Gitea every 60s; deploys on
|
||||||
# any change to main. Works with the agent
|
# any change to main.
|
||||||
# host's current firewall (outbound only).
|
|
||||||
#
|
#
|
||||||
# docs-deploy-webhook.service INSTALLED, INACTIVE UNTIL THE PORT IS OPEN.
|
# docs-deploy-webhook.service INSTALLED, INACTIVE. It predates the
|
||||||
# Instant push -> deploy once the Infomaniak
|
# build/publish split, loads the agent's env
|
||||||
# panel allows inbound TCP to the agent host
|
# file, and runs repo scripts with the Cloudron
|
||||||
# (the Gitea webhook is already registered).
|
# token. Do not enable it until it is ported to
|
||||||
|
# the same split.
|
||||||
#
|
#
|
||||||
# Install:
|
# Install:
|
||||||
# sudo cp publishing/docs-deploy-poll.service /etc/systemd/system/
|
# sudo install -o root -g root -m 0644 publishing/docs-deploy-poll.service \
|
||||||
|
# /etc/systemd/system/docs-deploy-poll.service
|
||||||
# sudo systemctl daemon-reload
|
# sudo systemctl daemon-reload
|
||||||
# sudo systemctl enable --now docs-deploy-poll
|
# sudo systemctl enable --now docs-deploy-poll
|
||||||
#
|
#
|
||||||
# poll-watcher.sh itself needs NO manual copy: the service runs the copy in
|
# The unit runs a HOST-OWNED script, /usr/local/sbin/docs-poll, which is not
|
||||||
# the dedicated checkout (/home/ubuntu/.docs-publisher), which git pull keeps
|
# copied from this repository. That script:
|
||||||
# at main on every deploy, and the watcher re-execs itself when a deploy
|
# * builds as the unprivileged `docsbuild` user from its own checkout at
|
||||||
# changed it.
|
# /var/lib/docs-publisher/repo (a scrubbed environment, no read access to
|
||||||
|
# /home/ubuntu, so repo code cannot see any co-op credential);
|
||||||
|
# * publishes with /usr/local/sbin/docs-publish, a root-owned script that
|
||||||
|
# runs no repository code and reads the Cloudron token from
|
||||||
|
# /etc/docs-deploy.env (root-only, mode 0600).
|
||||||
#
|
#
|
||||||
# ONE BUILD ENVIRONMENT: the poller builds from its own dedicated checkout
|
# Repo code (build.sh, hooks.py) therefore never executes with a credential.
|
||||||
# (uncommitted edits in a working clone must never block or leak into a
|
# See publishing/README.md.
|
||||||
# deploy) but with the ONE canonical venv, DOCS_CANONICAL_DIR/.venv-docs, and
|
|
||||||
# drift-checks its publishing/ tree against the canonical checkout before
|
|
||||||
# every build. See publishing/README.md.
|
|
||||||
|
|
||||||
[Unit]
|
[Unit]
|
||||||
Description=Inference docs: poll Gitea main and deploy to Surfer
|
Description=Inference docs: poll Gitea main, build unprivileged, publish without repo code
|
||||||
After=network-online.target
|
After=network-online.target
|
||||||
Wants=network-online.target
|
Wants=network-online.target
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
User=ubuntu
|
User=root
|
||||||
WorkingDirectory=/home/ubuntu/.docs-publisher
|
Environment=DOCS_REPO_DIR=/var/lib/docs-publisher/repo
|
||||||
Environment=DOCS_REPO_DIR=/home/ubuntu/.docs-publisher
|
Environment=DOCS_DEPLOY_LOG=/var/log/docs-deploy.log
|
||||||
Environment=DOCS_CANONICAL_DIR=/home/ubuntu/repos/docs
|
ExecStart=/usr/local/sbin/docs-poll
|
||||||
ExecStart=/bin/bash /home/ubuntu/.docs-publisher/publishing/poll-watcher.sh
|
|
||||||
Restart=on-failure
|
Restart=on-failure
|
||||||
RestartSec=10
|
RestartSec=10
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user