mirror of
https://github.com/btouchard/ackify-ce.git
synced 2026-02-09 15:28:50 -06:00
44431dabf4
BREAKING CHANGE: ACKIFY_APP_PASSWORD environment variable is now required for RLS support. The migrate tool creates the ackify_app role before running migrations, ensuring compatibility with existing deployments. Changes: - Add ensureAppRole() in cmd/migrate to create/update ackify_app role - Remove docker/init-scripts/01-create-app-user.sh (no longer needed) - Update compose.yml: add ACKIFY_APP_PASSWORD, backend connects as ackify_app - Update migration 0016: remove conditional role creation - Add RLS documentation (docs/en/configuration/rls.md, docs/fr/configuration/rls.md) - Update configuration docs with RLS section and security checklist Migration path for existing deployments: 1. Set ACKIFY_APP_PASSWORD in .env 2. Run docker compose up (migrate will create the role automatically)
Ackify Documentation (English)
Complete documentation for Ackify - Proof of Read with cryptographic signatures.
Quick Start
- Getting Started - Installation and first steps with Docker Compose
- Configuration - Environment variables and settings
Features
- Cryptographic Signatures - Ed25519 signature flow
- Expected Signers - Tracking and email reminders
- Checksums - Document integrity verification
- Embedding - oEmbed, iframes, third-party integrations
- Internationalization - Multi-language support (fr, en, es, de, it)
Advanced Configuration
- OAuth Providers - Google, GitHub, GitLab, Custom
- Email Setup - SMTP configuration for reminders
Architecture & Development
- Architecture - Tech stack, project structure, Clean Architecture principles
- Database - PostgreSQL schema, migrations, constraints
- API Reference - REST endpoints, examples, OpenAPI
- Deployment - Production, security, monitoring
- Development - Dev setup, tests, contributing
Integrations
- Google Docs - Google Workspace integration
- More integrations coming...
Support
- GitHub Issues - Bugs and feature requests
- GitHub Discussions - Questions and discussions