mirror of
https://github.com/btouchard/ackify.git
synced 2026-02-09 23:38:30 -06:00
fix: add ACKIFY_ prefix to all variables in .env.example files
Update both .env.example files to use correct variable names: Root .env.example: - Remove obsolete APP_NAME and APP_DNS variables - Add ACKIFY_DB_DSN example - Add ACKIFY_ADMIN_EMAILS section - Remove deprecated ACKIFY_TEMPLATES_DIR install/.env.example: - Fix all variable names to use ACKIFY_ prefix - Update OAuth variables (PROVIDER, CLIENT_ID, etc.) - Update Mail/SMTP variables (HOST, PORT, USERNAME, etc.) - Update Auth variables (AUTH_OAUTH_ENABLED, AUTH_MAGICLINK_ENABLED) - Update Admin variables (ADMIN_EMAILS) - Update all references in comments and instructions
This commit is contained in:
Benjamin
11
.env.example
11
.env.example
@@ -1,6 +1,4 @@
|
||||
# Application Configuration
|
||||
APP_NAME=ackify
|
||||
APP_DNS=sign.your-domain.com
|
||||
ACKIFY_BASE_URL=https://sign.your-domain.com
|
||||
ACKIFY_ORGANISATION="Your Organization Name"
|
||||
ACKIFY_LOG_LEVEL=info
|
||||
@@ -10,6 +8,7 @@ ACKIFY_LOG_FORMAT=classic
|
||||
POSTGRES_USER=ackifyr
|
||||
POSTGRES_PASSWORD=your_secure_password
|
||||
POSTGRES_DB=ackify
|
||||
ACKIFY_DB_DSN=postgres://ackifyr:your_secure_password@localhost:5432/ackify?sslmode=disable
|
||||
|
||||
# ============================================================================
|
||||
# Authentication Configuration
|
||||
@@ -63,8 +62,8 @@ ACKIFY_OAUTH_PROVIDER=google
|
||||
ACKIFY_OAUTH_COOKIE_SECRET=your_base64_encoded_secret_key
|
||||
ACKIFY_ED25519_PRIVATE_KEY=your_base64_encoded_ed25519_private_key
|
||||
|
||||
# Server Configuration
|
||||
ACKIFY_LISTEN_ADDR=:8080
|
||||
# Admin Configuration
|
||||
# ACKIFY_ADMIN_EMAILS=admin@your-domain.com,admin2@your-domain.com
|
||||
|
||||
# Template Configuration
|
||||
# ACKIFY_TEMPLATES_DIR=/custom/path/to/templates
|
||||
# Server Configuration
|
||||
ACKIFY_LISTEN_ADDR=:8080
|
||||
@@ -5,8 +5,8 @@
|
||||
# ==========================================
|
||||
# Application Configuration
|
||||
# ==========================================
|
||||
APP_BASE_URL=https://your-domain.com
|
||||
APP_ORGANISATION="Your Organization Name"
|
||||
ACKIFY_BASE_URL=https://your-domain.com
|
||||
ACKIFY_ORGANISATION="Your Organization Name"
|
||||
|
||||
# ==========================================
|
||||
# Database Configuration
|
||||
@@ -14,20 +14,22 @@ APP_ORGANISATION="Your Organization Name"
|
||||
POSTGRES_USER=ackifyr
|
||||
POSTGRES_PASSWORD=your_secure_password
|
||||
POSTGRES_DB=ackify
|
||||
ACKIFY_DB_DSN=postgres://ackifyr:your_secure_password@ackify-db:5432/ackify?sslmode=disable
|
||||
|
||||
# ==========================================
|
||||
# Security Configuration (Auto-generated)
|
||||
# ==========================================
|
||||
# Generate with: openssl rand -base64 32
|
||||
OAUTH_COOKIE_SECRET=your_base64_encoded_secret_key
|
||||
ACKIFY_OAUTH_COOKIE_SECRET=your_base64_encoded_secret_key
|
||||
|
||||
# Generate with: openssl rand 64 | base64 -w 0
|
||||
ED25519_PRIVATE_KEY_B64=your_base64_encoded_ed25519_private_key
|
||||
ACKIFY_ED25519_PRIVATE_KEY=your_base64_encoded_ed25519_private_key
|
||||
|
||||
# ==========================================
|
||||
# Server Configuration
|
||||
# ==========================================
|
||||
LISTEN_ADDR=:8080
|
||||
ACKIFY_LISTEN_ADDR=:8080
|
||||
ACKIFY_LOG_LEVEL=info
|
||||
|
||||
# ==========================================
|
||||
# OAuth2 Authentication Configuration
|
||||
@@ -35,32 +37,32 @@ LISTEN_ADDR=:8080
|
||||
# At least ONE authentication method (OAuth or MagicLink) must be enabled
|
||||
|
||||
# Provider: google, github, gitlab, or leave empty for custom
|
||||
OAUTH_PROVIDER=google
|
||||
ACKIFY_OAUTH_PROVIDER=google
|
||||
|
||||
# OAuth Client Credentials
|
||||
OAUTH_CLIENT_ID=your_oauth_client_id
|
||||
OAUTH_CLIENT_SECRET=your_oauth_client_secret
|
||||
ACKIFY_OAUTH_CLIENT_ID=your_oauth_client_id
|
||||
ACKIFY_OAUTH_CLIENT_SECRET=your_oauth_client_secret
|
||||
|
||||
# Optional: Restrict to specific email domain (e.g., @company.com)
|
||||
# OAUTH_ALLOWED_DOMAIN=@your-organization.com
|
||||
# ACKIFY_OAUTH_ALLOWED_DOMAIN=@your-organization.com
|
||||
|
||||
# Optional: Auto-login if OAuth session exists (default: false)
|
||||
# OAUTH_AUTO_LOGIN=true
|
||||
# ACKIFY_OAUTH_AUTO_LOGIN=true
|
||||
|
||||
# Optional: Custom OAuth provider configuration (only if OAUTH_PROVIDER is empty)
|
||||
# OAUTH_AUTH_URL=https://your-provider.com/oauth/authorize
|
||||
# OAUTH_TOKEN_URL=https://your-provider.com/oauth/token
|
||||
# OAUTH_USERINFO_URL=https://your-provider.com/api/user
|
||||
# OAUTH_SCOPES=openid,email,profile
|
||||
# Optional: Custom OAuth provider configuration (only if ACKIFY_OAUTH_PROVIDER is empty)
|
||||
# ACKIFY_OAUTH_AUTH_URL=https://your-provider.com/oauth/authorize
|
||||
# ACKIFY_OAUTH_TOKEN_URL=https://your-provider.com/oauth/token
|
||||
# ACKIFY_OAUTH_USERINFO_URL=https://your-provider.com/api/user
|
||||
# ACKIFY_OAUTH_SCOPES=openid,email,profile
|
||||
|
||||
# Optional: Self-hosted GitLab URL (only if OAUTH_PROVIDER=gitlab)
|
||||
# OAUTH_GITLAB_URL=https://gitlab.your-company.com
|
||||
# Optional: Self-hosted GitLab URL (only if ACKIFY_OAUTH_PROVIDER=gitlab)
|
||||
# ACKIFY_OAUTH_GITLAB_URL=https://gitlab.your-company.com
|
||||
|
||||
# Optional: Custom logout URL
|
||||
# OAUTH_LOGOUT_URL=https://your-provider.com/logout
|
||||
# ACKIFY_OAUTH_LOGOUT_URL=https://your-provider.com/logout
|
||||
|
||||
# Optional: Force enable/disable OAuth (auto-detected by default)
|
||||
# AUTH_OAUTH_ENABLED=true
|
||||
# ACKIFY_AUTH_OAUTH_ENABLED=true
|
||||
|
||||
# ==========================================
|
||||
# SMTP Configuration (Email Service)
|
||||
@@ -70,40 +72,40 @@ OAUTH_CLIENT_SECRET=your_oauth_client_secret
|
||||
# - MagicLink authentication (passwordless email login)
|
||||
|
||||
# SMTP Server Configuration
|
||||
# MAIL_HOST=smtp.gmail.com
|
||||
# MAIL_PORT=587
|
||||
# MAIL_USERNAME=your-smtp-username
|
||||
# MAIL_PASSWORD=your-smtp-password
|
||||
# ACKIFY_MAIL_HOST=smtp.gmail.com
|
||||
# ACKIFY_MAIL_PORT=587
|
||||
# ACKIFY_MAIL_USERNAME=your-smtp-username
|
||||
# ACKIFY_MAIL_PASSWORD=your-smtp-password
|
||||
|
||||
# Email Sender Configuration
|
||||
# MAIL_FROM=noreply@your-domain.com
|
||||
# MAIL_FROM_NAME=Your Organization Name
|
||||
# ACKIFY_MAIL_FROM=noreply@your-domain.com
|
||||
# ACKIFY_MAIL_FROM_NAME=Your Organization Name
|
||||
|
||||
# SMTP Security Settings
|
||||
# MAIL_TLS=true
|
||||
# MAIL_STARTTLS=true
|
||||
# MAIL_TIMEOUT=10s
|
||||
# ACKIFY_MAIL_TLS=true
|
||||
# ACKIFY_MAIL_STARTTLS=true
|
||||
# ACKIFY_MAIL_TIMEOUT=10s
|
||||
|
||||
# Email Template Configuration
|
||||
# MAIL_TEMPLATE_DIR=templates/emails
|
||||
# MAIL_DEFAULT_LOCALE=en
|
||||
# MAIL_SUBJECT_PREFIX=[Ackify]
|
||||
# ACKIFY_MAIL_TEMPLATE_DIR=templates/emails
|
||||
# ACKIFY_MAIL_DEFAULT_LOCALE=en
|
||||
# ACKIFY_MAIL_SUBJECT_PREFIX=[Ackify]
|
||||
|
||||
# ==========================================
|
||||
# MagicLink Authentication Configuration
|
||||
# ==========================================
|
||||
# MagicLink provides passwordless authentication via email
|
||||
# Auto-enabled when MAIL_HOST is configured
|
||||
# Auto-enabled when ACKIFY_MAIL_HOST is configured
|
||||
|
||||
# Optional: Force disable MagicLink even if SMTP is configured
|
||||
# AUTH_MAGICLINK_ENABLED=false
|
||||
# ACKIFY_AUTH_MAGICLINK_ENABLED=false
|
||||
|
||||
# ==========================================
|
||||
# Admin Configuration
|
||||
# ==========================================
|
||||
# Comma-separated list of admin email addresses
|
||||
# Admins have access to document management and reminder features
|
||||
# ADMIN_EMAILS=admin@your-domain.com,admin2@your-domain.com
|
||||
# ACKIFY_ADMIN_EMAILS=admin@your-domain.com,admin2@your-domain.com
|
||||
|
||||
# ==========================================
|
||||
# CONFIGURATION INSTRUCTIONS
|
||||
@@ -113,8 +115,8 @@ OAUTH_CLIENT_SECRET=your_oauth_client_secret
|
||||
# bash <(curl -fsSL https://raw.githubusercontent.com/btouchard/ackify-ce/main/install/install.sh)
|
||||
|
||||
# 2. Or manually generate secure secrets:
|
||||
# OAUTH_COOKIE_SECRET=$(openssl rand -base64 32)
|
||||
# ED25519_PRIVATE_KEY_B64=$(openssl rand 64 | base64 -w 0)
|
||||
# ACKIFY_OAUTH_COOKIE_SECRET=$(openssl rand -base64 32)
|
||||
# ACKIFY_ED25519_PRIVATE_KEY=$(openssl rand 64 | base64 -w 0)
|
||||
|
||||
# 3. OAuth2 Provider Setup:
|
||||
# GOOGLE: Create OAuth credentials at https://console.cloud.google.com/
|
||||
@@ -129,8 +131,8 @@ OAUTH_CLIENT_SECRET=your_oauth_client_secret
|
||||
# Mailgun: Get credentials from https://app.mailgun.com/
|
||||
|
||||
# 5. Authentication Methods:
|
||||
# - OAuth: Requires OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET
|
||||
# - MagicLink: Requires MAIL_HOST configuration
|
||||
# - OAuth: Requires ACKIFY_OAUTH_CLIENT_ID and ACKIFY_OAUTH_CLIENT_SECRET
|
||||
# - MagicLink: Requires ACKIFY_MAIL_HOST configuration
|
||||
# - At least ONE method must be enabled
|
||||
|
||||
# 6. Start Ackify:
|
||||
|
||||
Reference in New Issue
Block a user