Skip to content

LucidSeal/lucidseal-assets

Repository files navigation

LucidSeal Assets (MVP)

Build Status Last Updated License: CC BY 4.0 Better Stack Badge

This repository is the source of truth for LucidSeal’s public assets.
Assets are automatically published to https://assets.lucidseal.org for community use.

⚠️ Note: Removing a file from this repo does not remove it from R2 storage. Clean-up must be done manually by maintainers.

This repo is intended for both community users (as a source of public assets) and maintainers (who publish them).


📂 Structure


public/              → Assets published to assets.lucidseal.org
privacy/           → Privacy by Default (templates, notices)
transparency/      → Transparency in Action (glossary, guides)
security/          → Secure Foundations (checklists, registers)
community/         → Community First (escalation docs, surveys)
cross-principle/   → Combined assets (Trust Page, maturity checklist)
brand/             → Badge, logos, brand guide
templates/           → Drafts or working copies
src/worker.js        → Cloudflare Worker serving assets
.github/workflows/   → CI pipeline for publishing
wrangler.toml        → Worker configuration
publish-allowlist.txt→ Optional: include extra files outside public/


🚀 Workflow

  1. Add or update a file under public/
  2. Commit & push to main
  3. GitHub Action runs:
    • Uploads all files under public/ to the R2 bucket
    • Generates/updates manifest.json
  4. Assets are live at:

[https://assets.lucidseal.org/](https://assets.lucidseal.org/)<category>/<filename>


📜 Manifest

A machine-readable index of all public assets is served at:


[https://assets.lucidseal.org/manifest.json](https://assets.lucidseal.org/manifest.json)

Each entry includes:
path, title, category, mime, size, updated_at.


🛡️ Security & Headers

The Cloudflare Worker ensures:

  • Correct MIME type for each file
  • Content-Disposition: inline for PDFs/images, attachment for Office docs
  • Cache: 10m browser / 1d edge (manifest fresher: 1m/10m)
  • Security headers: nosniff, no-referrer, limited CORS (lucidseal.org only)

🔧 Setup (for maintainers)

  • Cloudflare R2: bucket lucidseal-assets
  • Cloudflare Worker: src/worker.js, deploy with wrangler deploy
  • Route: assets.lucidseal.org/* → Worker
  • GitHub Secrets:
    • R2_ACCESS_KEY_ID
    • R2_SECRET_ACCESS_KEY
    • R2_ENDPOINT

🔮 Future Enhancements

  • Public UI for browsing assets
  • TBC

📖 License

All public assets in this repository are licensed under the
Creative Commons Attribution 4.0 International (CC BY 4.0).

You are free to:
✔️ Share — copy and redistribute in any medium or format
✔️ Adapt — remix, transform, and build upon the material
for any purpose, even commercially.

You must:
✏️ Give appropriate credit and indicate if changes were made.

About

Canonical LucidSeal docs (principles, guides, kits).

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •