Close OSS self-host gaps: in-repo API docs, legal notes, and packaging.

Add MIT license and docs/api, strip SaaS status/admin remnants from robots and footer, align env/compose/README with payment-free product truth.
This commit is contained in:
Atakan Doğan Özban
2026-08-03 07:36:08 +02:00
parent 1fcae33ca3
commit 54bbf8b574
21 changed files with 594 additions and 38 deletions
+24 -4
View File
@@ -7,6 +7,8 @@ plans, credits, purchases, subscriptions, paywalls, or Stripe.
Sign in with Google, open the dashboard, and create videos. Settings cover account,
YouTube connection, and API keys only.
**License:** [MIT](./LICENSE)
## Quick start (Docker)
Published image: [`atakanozban/songs2vid:latest`](https://hub.docker.com/r/atakanozban/songs2vid)
@@ -23,15 +25,16 @@ Published image: [`atakanozban/songs2vid:latest`](https://hub.docker.com/r/ataka
4. Start the stack (web + worker + Postgres + Redis):
```bash
docker compose up -d --build
docker compose up -d
```
Or pull the published image and run Compose after pointing services at
`atakanozban/songs2vid:latest` (same env and volumes).
Compose uses the published image by default (`atakanozban/songs2vid:latest`) and can also
build from this repo (`docker compose up -d --build`).
Open http://localhost:3000 → sign in → dashboard.
No Stripe keys or billing env vars are required.
No Stripe keys, billing env vars, or edition flags are required. Watermarks are optional;
OSS does not force a free-tier SaaS badge paywall.
## Features
@@ -42,6 +45,12 @@ No Stripe keys or billing env vars are required.
- REST API for automation (keys under **Dashboard → Settings → API key**)
- Always-on self-hosted entitlements (no quota paywall)
## API documentation
- In-repo: [docs/api/overview.md](./docs/api/overview.md) and [docs/api/endpoints.md](./docs/api/endpoints.md)
- Live site: [docs.songs2vid.com/docs/api/overview](https://docs.songs2vid.com/docs/api/overview)
- Machine-readable discovery: `GET /api/v1` (no auth; no billing routes)
## Local development
```bash
@@ -55,6 +64,17 @@ npm run dev:all
- App: http://localhost:3000
- `dev:all` runs Next.js and the BullMQ worker
## Environment
See [`.env.example`](./.env.example) for the required and optional variables. Matching guide:
[docs.songs2vid.com/docs/environment](https://docs.songs2vid.com/docs/environment).
## Legal (self-hosted)
In-app **Privacy** and **Terms** pages describe self-hosted responsibility: the operator of
each instance controls data and access; this software does not process payments. They are not
the paid cloud terms for [songs2vid.com](https://songs2vid.com).
## Stack
- Next.js 15, TypeScript, Tailwind