# Download and run installation script
curl -fsSL https://raw.githubusercontent.com/btouchard/ackify-ce/main/install/install.sh | bash

# Navigate to installation directory
cd ackify-ce

# Edit configuration with your OAuth2 credentials
nano .env

# Start services
docker compose up -d

# Access web interface
open http://localhost:8080

What the script does:

Downloads compose.yml and .env.example
Generates secure secrets automatically:
- ACKIFY_OAUTH_COOKIE_SECRET (AES-256 session encryption)
- POSTGRES_PASSWORD (database password)
Creates ready-to-use .env file
You only need to add your OAuth2 credentials

Option 2: Manual Installation

# Clone repository
git clone https://github.com/btouchard/ackify-ce.git
cd ackify-ce

# Configure
cp .env.example .env
nano .env  # Edit with your OAuth2 credentials and generate secrets

# Start services
docker compose up -d

# Verify
curl http://localhost:8080/api/v1/health
# Expected: {"status":"healthy","database":"connected"}

# Access web interface
open http://localhost:8080

Required Environment Variables

# Application
APP_DNS=sign.your-domain.com
ACKIFY_BASE_URL=https://sign.your-domain.com
ACKIFY_ORGANISATION="Your Organization"

# Database
POSTGRES_USER=ackifyr
POSTGRES_PASSWORD=your_secure_password
POSTGRES_DB=ackify

# OAuth2 (example with Google)
ACKIFY_OAUTH_PROVIDER=google
ACKIFY_OAUTH_CLIENT_ID=your_client_id
ACKIFY_OAUTH_CLIENT_SECRET=your_client_secret

# Security (generate with: openssl rand -base64 32)
ACKIFY_OAUTH_COOKIE_SECRET=your_base64_secret

See docs/en/configuration.md for all options.

📸 Screenshots

Home	Signing	Confirmed
Signatures	Outline	Google Docs

Videos: 1-initialize-sign.webm | 2-user-sign-flow.webm

📚 Documentation

Getting Started

Getting Started - Installation & first steps
Configuration - Environment variables
OAuth Providers - Google, GitHub, GitLab, Custom
Email Setup - SMTP configuration

Features

Signatures - Ed25519 cryptographic flow
Expected Signers - Tracking & reminders
Checksums - Document integrity verification
Embedding - oEmbed, iframes, integrations
i18n - Internationalization (5 languages)

Technical

Architecture - Tech stack & design principles
Database - PostgreSQL schema & migrations
API Reference - REST endpoints & examples
Deployment - Production with Docker Compose
Development - Contributing & setup

🚀 Usage

Request a Signature

https://your-domain.com/?doc=security_policy_2025

User authenticates via OAuth2 and signs with one click.

Embed in Your Tools

iFrame:

<iframe src="https://your-domain.com/?doc=policy_2025"
        width="600" height="200" frameborder="0"></iframe>

oEmbed (Notion, Outline, Confluence):

Just paste the URL - automatic embed via oEmbed discovery

Open Graph (Slack, Teams):

URL unfurls automatically with signature count

See docs/en/features/embedding.md for details.

🛡️ Security

Ed25519 - State-of-the-art elliptic curve signatures
SHA-256 - Payload hashing for tampering detection
PKCE - OAuth2 security (automatic)
AES-256-GCM - Encrypted refresh tokens
Immutable timestamps - PostgreSQL triggers
Rate limiting - 5 auth/min, 100 req/min
HTTPS enforced - Secure cookies only

See docs/en/architecture.md for full security details.

🔧 Tech Stack

Backend: Go 1.24.5, PostgreSQL 16, Chi Router, OAuth2, Ed25519

Frontend: Vue 3, TypeScript, Vite, Pinia, Tailwind CSS, shadcn/vue

DevOps: Docker, Multi-stage builds, Distroless image (< 30MB)

i18n: 5 languages (fr, en, es, de, it)

Coverage: 72.6% (180+ unit tests, 33 integration tests)

🤝 Support

Issues: GitHub Issues
Discussions: GitHub Discussions
Email: contact@ackify.eu

📄 License

AGPLv3 - See LICENSE for details.

Developed with ❤️ by Benjamin TOUCHARD

Languages

Go 67.6%

Vue 14.3%

TypeScript 10.8%

Shell 2.4%

PLpgSQL 2%

Other 2.9%