mirror of
https://github.com/btouchard/ackify-ce.git
synced 2026-02-07 14:29:02 -06:00
d3e7c9911c
ClearURLs and similar privacy extensions block the 'ref' parameter as it's commonly used for referrer tracking. Renamed to 'doc' which is not targeted by these extensions. Closes #19
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
- Document Storage - Upload and store documents (local or S3)
- 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