rivendell

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #machine-learning #macos #java #windows #awesome #cli #awesome-list #vue #ios #openai

(★ 12)

:train2: Personal bookmarks database built on top of PocketBase.

rivendell 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rivendell

Personal bookmarking, media collection, and archiving database powered by [PocketBase](https://pocketbase.io/). On record creation, external APIs automatically enrich entries (cover art, metadata, and archive URLs) depending on the collection type.

## Docs

- [ARCHITECTURE.md](docs/ARCHITECTURE.md) — system overview, design decisions, diagrams, and implementation guide
- [SCHEMA.md](docs/SCHEMA.md) — collection definitions, field types, and constraints
- [API.md](docs/API.md) — how to create and query records; which fields are manual vs. auto-filled
- [MIGRATIONS.md](docs/MIGRATIONS.md) — how schema migrations work and how to write new ones
- [CRON.md](docs/CRON.md) — how scheduled jobs work, existing jobs, and how to add a new one
- [TESTING.md](docs/TESTING.md) — what's tested, how to run tests, and bugs found during testing
- [DATASETTE.md](docs/DATASETTE.md) — read-only analytics layer: dashboards, canned queries, snapshot sync, Tailscale URL

---

## Requirements

- Go ≥ 1.26.2
- Docker + Docker Compose (for containerized runs)
- Tailscale (for production networking)
- Access to the external APIs used by the helpers:
  - Backblaze B2: `B2_APP_KEY_ID`, `B2_APP_KEY`, `B2_BUCKET_ID`, `B2_BUCKET_NAME`
  - GitHub GraphQL: `GH_TOKEN`, `GH_USERNAME`
  - The Movie Database (movies, shows): `TMDB_KEY` (v3 API Key — Settings → API → API Key)
  - IGDB via Twitch OAuth (games): `TWITCH_CLIENT_ID`, `TWITCH_CLIENT_SECRET`
  - Discogs (CDs, vinyls): `DISCOGS_TOKEN`
  - YouTube Data API v3: `YOUTUBE_KEY`
  - PocketBase meta collection ID: `META_ID`
  - Tailscale auth keys: `TS_AUTHKEY` (app node), `TS_AUTHKEY_DATASETTE` (datasette analytics node)

## Setup

1. Clone the repository and move into it.
2. Create a `.env` file in the project root with all required variables:

```sh
cat <<'EOF' > .env
B2_APP_KEY_ID=
B2_APP_KEY=
B2_BUCKET_ID=
B2_BUCKET_NAME=
GH_TOKEN=
GH_USERNAME=
TMDB_KEY=
TWITCH_CLIENT_ID=
TWITCH_CLIENT_SECRET=
DISCOGS_TOKEN=
YOUTUBE_KEY=
META_ID=
TS_AUTHKEY=
TS_AUTHKEY_DATASETTE=
EOF
```

`META_ID` must be a valid 15-character PocketBase ID. Generate one:
```sh
cat /dev/urandom | LC_ALL=C tr -dc 'a-z0-9' | head -c 15
```

See [SCHEMA.md](SCHEMA.md) for why this value is required.

3. Pull Go dependencies:

```sh
go mod download
```

## Source layout

```
main.go          — app init, hook wiring, cron registration, app.Start()
enrichers.go     — record enrichment (external API calls, B2 uploads)
preparers.go     — relation name resolution, field defaults
schema/          — collection definitions (used by migrations)
helpers/         — external API clients (B2, YouTube, TMDB, IGDB, Discogs, Scryfall, OpenLibrary, GitHub)
linkcheck/       — dead-link checker (used by link_check cron job)
backup/          — collection → JSON export to B2 (used by backup cron job)
utils/           — pure string/file utilities
datetime/        — date arithmetic helpers
migrations/      — versioned schema migration files
datasette/       — read-only analytics layer (Dockerfile, sync, queries, dashboards)
```

## Local development

Run the PocketBase app directly:

```sh
go run . serve
```

- HTTP API listens on `http://127.0.0.1:8090` by default.
- Schema migrations run automatically on startup.
- Data stored in `pb_data/` directory.

See [API.md](API.md) for request examples.

## Docker workflow

Build and start the stack (PocketBase + Tailscale):

```sh
docker compose up --build
```

- PocketBase binds to port `8090` on the internal Docker network.
- Tailscale proxies HTTPS traffic from your tailnet to the app — no public ports exposed.
- Persistent data lives in the `pb_data` bind mount.

Stop and remove the containers:

```sh
docker compose down
```

## Migrations

Schema is managed via versioned migration files in `migrations/`. They run automatically on `serve` startup — no manual steps needed. See [MIGRATIONS.md](MIGRATIONS.md) for how to write new ones.

## Deployment

The repo ships with a convenience script that pulls the latest code and rebuilds the Docker services:

```sh
./deploy.sh
```

Run it from the server where the stack should stay up-to-date.

rivendell

rivendell 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

rivendell

rivendell 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README