pesky/tbcom repository overview

⁠TB-COM — TOUGHBLUE INTERNAL COMMUNICATIONS

⁠WHAT THIS IS

TB-Com is a single Docker image that runs the full web app: a React user interface and a Spring Boot API together. Teams use it to publish official decisions and announcements inside the organisation, with an audit trail, in-app notifications, and reading confirmation when staff leave a short comment on each item they must read. Administrators configure email (SMTP), schedules, and most behaviour from the admin Settings page after the first boot.

⁠WHO IT IS FOR

• Members — Read the timeline, open decisions, comment to confirm they read items (the person who wrote the post is exempt). • Authors — Publish and edit their own decisions (with visibility rules). • Administrators — Users, groups, all content, Settings, audit log, and removing comments (removal is broadcast by email with a mandatory reason).

⁠QUICK START (PRODUCTION IMAGE)

1. Keep a copy of this repository on the server (for versioned deploy files).
2. Copy .env.example to .env at the repository root and edit: • JWT_SECRET — use a strong random value (see .env.example). • APP_PUBLIC_BASE_URL — the URL users use in the browser (e.g. https://tbcom.example.com⁠). • BOOTSTRAP_ADMIN_EMAIL / BOOTSTRAP_ADMIN_PASSWORD — first sign-in; change password immediately after first login.
3. From the deploy/ folder: docker compose pull docker compose up -d
4. Open APP_PUBLIC_BASE_URL, sign in as the bootstrap admin, set SMTP under Admin → Settings, then invite users.

Production image tag: lts (not latest). Data: mount /data in the container (SQLite by default at /data/tbcom.db). Branding images: repo branding/ folder mounted to /data/branding.

⁠DATA AND BACKUPS

Back up the database file (SQLite under /data) or use PostgreSQL with normal DB backups. Store .env securely; it contains secrets and bootstrap options.

⁠REVERSE PROXY

Run behind nginx, Traefik, or similar TLS termination. Set APP_PUBLIC_BASE_URL to the public HTTPS URL. Health check path: /actuator/health

⁠MORE DOCUMENTATION

Full setup and usage overview and CI/CD notes live in the project repository under Documentation/ (AsciiDoc).