koala73 / koala73/worldmonitor

chore(docs): answer the self-hosting question explicitly

Open
#6,647 1 comment 0 reactions 0 assignees View on GitHub
P3 positioning
Dominant language
TypeScript
Stars
86.6k
Forks
13.1k
Avg merge
8h 4m
Merged PRs (30d)
825

Description

## Problem
`docs/license.mdx` says the source licence is *"separate from the Personal, Pro
Business, API Starter, API Business, and Enterprise licenses that govern use of
the hosted Service and its outputs"* — but **never states whether self-hosting
requires a subscription**, or what is gated server-side.

`SELF_HOSTING.md` gives a full docker/podman-compose quick start,
secret generation and `./scripts/run-seeders.sh`, so self-hosting clearly works.

## Why it matters
Kal asked, almost verbatim: *"could we modify and add it as a modular so we can
add our own modules to it?"* — and was told "theoretically you can rebuild it
from scratch, it's open source." A technical evaluator at an AGPL project **will**
ask "what stops me self-hosting this instead of paying?"

The answer is presumably that self-hosting gets the code but not our data
pipeline, API keys, or seeded caches — but that is nowhere stated, so the
question hangs.

## Fix
A clear docs page: what self-hosting gives you, what it does not, what requires
a commercial licence, what AGPL obligations attach if you modify and serve it,
and the honest cost comparison (running 500+ seeders is not free).

Being straightforward here **increases** conversion. The gap between "you can
self-host" and "here is exactly what that costs you" is where an evaluator
invents a worse answer than the truth.

## Acceptance
- [ ] Self-hosting scope documented — what is and is not included
- [ ] AGPL obligations explained plainly
- [ ] Commercial licence trigger stated
- [ ] Honest operational cost comparison

Related: #5415 — self-hosted Docker returns HTTP 401 on
`/api/intelligence/v1/get-country-intel-brief` before the handler runs. That is
the concrete version of this question and should be answered in the same doc.
Effort: M (~2d).

Contributor guide

Open the contributing guide

Research direction

Start with docs/license.mdx and SELF_HOSTING.md, then review related issue #5415 for the self-hosted API behavior. Confirm the self-hosting scope, AGPL obligations, commercial-license trigger, and operational cost with maintainers before documenting them. Done means the page answers each acceptance item plainly and links to the relevant setup or licensing guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.