Skip to Content
⚙️ ConfigurationSystem Settings

Last Updated: 3/13/2026


System Settings

System settings control the global configuration of your LinkAce instance. These settings require administrator privileges and affect all users.

Accessing System Settings

  1. Log in as an administrator
  2. Navigate to Settings → System Settings
  3. Make changes in the appropriate section
  4. Click “Save Changes”

General Settings

Site Information

Configure basic site details:

  1. Go to System Settings → General
  2. Set:
    • Site Name: Display name for your instance
    • Site Description: Brief description
    • Admin Email: Contact email for system notifications
    • Timezone: Default timezone for the instance
  3. Click “Save Changes”

Guest Access

Control public access to your instance:

  1. Go to System Settings → General
  2. Toggle “Enable Guest Access”
  3. Configure guest permissions:
    • View Public Links: Allow viewing public links
    • View Public Lists: Allow viewing public lists
    • View Public Tags: Allow viewing public tags
    • Search: Allow searching public content
  4. Click “Save Changes”

Note: Guest access does not allow creating or modifying content.

User Registration

Control who can create accounts:

  1. Go to System Settings → General
  2. Choose registration mode:
    • Open: Anyone can register
    • Invite Only: Require invitation codes
    • Closed: No new registrations
  3. Configure options:
    • Email Verification: Require email confirmation
    • Admin Approval: Require admin approval for new accounts
    • Default Role: Role assigned to new users
  4. Click “Save Changes”

Language & Localization

Set system-wide language preferences:

  1. Go to System Settings → General
  2. Set:
    • Default Language: Language for new users
    • Available Languages: Languages users can choose
    • Date Format: Default date format
    • Time Format: Default time format
  3. Click “Save Changes”

Configure default behavior for links:

  1. Go to System Settings → Links
  2. Set:
    • Default Privacy: Private, Internal, or Public
    • Check Links: Enable automatic link checking
    • Check Frequency: How often to check links
    • Archive Links: Auto-save to Internet Archive
    • Fetch Metadata: Auto-fetch titles and descriptions
  3. Click “Save Changes”

Configure link availability monitoring:

  1. Go to System Settings → Links
  2. Enable “Link Checking”
  3. Configure:
    • Check Frequency: Daily, weekly, or monthly
    • Timeout: Seconds to wait for response (default: 10)
    • Retry Count: Number of retries before marking broken
    • User Agent: Custom user agent string
  4. Set notification options:
    • Notify Users: Email users about broken links
    • Notification Threshold: Number of broken links before notifying
  5. Click “Save Changes”

Internet Archive

Configure automatic archiving:

  1. Go to System Settings → Links
  2. Enable “Internet Archive Integration”
  3. Configure:
    • Auto-Archive: Automatically archive new links
    • Archive Delay: Delay before archiving (minutes)
    • Retry Failed: Retry failed archive attempts
  4. Click “Save Changes”

Note: Archiving is subject to Internet Archive rate limits.

Configure automatic metadata fetching:

  1. Go to System Settings → Links
  2. Enable “Fetch Metadata”
  3. Configure:
    • Fetch Title: Auto-fetch page titles
    • Fetch Description: Auto-fetch meta descriptions
    • Fetch Favicon: Auto-fetch site icons
    • Timeout: Seconds to wait (default: 5)
  4. Click “Save Changes”

Search Settings

Search Configuration

Configure search behavior:

  1. Go to System Settings → Search
  2. Set:
    • Search Engine: Internal or external search
    • Results Per Page: Default pagination (10-100)
    • Minimum Query Length: Minimum characters for search
    • Fuzzy Matching: Enable approximate matching
  3. Click “Save Changes”

Search Indexing

Configure search index maintenance:

  1. Go to System Settings → Search
  2. Enable “Automatic Indexing”
  3. Configure:
    • Index Frequency: How often to rebuild index
    • Index Fields: Which fields to index
    • Index Privacy: Include private links in index
  4. Click “Rebuild Index” to manually rebuild

Email Settings

SMTP Configuration

Configure email delivery:

  1. Go to System Settings → Email
  2. Set SMTP details:
    • Host: SMTP server address
    • Port: SMTP port (usually 587 or 465)
    • Username: SMTP username
    • Password: SMTP password
    • Encryption: TLS or SSL
  3. Set sender details:
    • From Address: Email address for outgoing mail
    • From Name: Display name for emails
  4. Click “Save Changes”

Email Templates

Customize email templates:

  1. Go to System Settings → Email
  2. Select a template:
    • Welcome Email
    • Password Reset
    • Broken Link Notification
    • Weekly Summary
  3. Edit the template:
    • Subject line
    • Body content (supports variables)
    • Footer
  4. Click “Save Template”

Test Email

Verify email configuration:

  1. Go to System Settings → Email
  2. Enter a test email address
  3. Click “Send Test Email”
  4. Check the inbox for the test message

Backup Settings

Automatic Backups

Configure automated backups:

  1. Go to System Settings → Backups
  2. Enable “Automatic Backups”
  3. Configure:
    • Frequency: Daily, weekly, or monthly
    • Time: When to run backups
    • Retention: How many backups to keep
  4. Click “Save Changes”

Backup Destination

Configure where backups are stored:

  1. Go to System Settings → Backups
  2. Choose destination:
    • Local: Store on server
    • S3: Amazon S3 or compatible
    • FTP: Remote FTP server
    • Dropbox: Dropbox account
  3. Enter credentials for chosen destination
  4. Click “Test Connection”
  5. Click “Save Changes”

S3 Configuration

For S3-compatible storage:

# Add to .env file BACKUP_ENABLED=true BACKUP_DISK=s3 AWS_ACCESS_KEY_ID=your-access-key AWS_SECRET_ACCESS_KEY=your-secret-key AWS_DEFAULT_REGION=us-east-1 AWS_BUCKET=your-bucket-name AWS_ENDPOINT=https://s3.amazonaws.com

Manual Backup

Create a backup immediately:

  1. Go to System Settings → Backups
  2. Click “Create Backup Now”
  3. Wait for completion
  4. Download or verify in storage

Restore from Backup

Restore a previous backup:

  1. Go to System Settings → Backups
  2. View available backups
  3. Select a backup
  4. Click “Restore”
  5. Confirm restoration

Warning: Restoring will overwrite current data.

Security Settings

Password Policy

Set password requirements:

  1. Go to System Settings → Security
  2. Configure:
    • Minimum Length: Minimum characters (default: 10)
    • Require Uppercase: Require uppercase letters
    • Require Numbers: Require numbers
    • Require Special Characters: Require symbols
    • Password Expiry: Days before password expires (0 = never)
  3. Click “Save Changes”

Session Management

Configure session behavior:

  1. Go to System Settings → Security
  2. Set:
    • Session Lifetime: Minutes before auto-logout
    • Concurrent Sessions: Allow multiple sessions per user
    • Secure Cookies: Require HTTPS for cookies
    • Same-Site Cookies: Cookie same-site policy
  3. Click “Save Changes”

Two-Factor Authentication

Enforce 2FA for users:

  1. Go to System Settings → Security
  2. Configure:
    • Require 2FA: Make 2FA mandatory
    • Grace Period: Days before 2FA is required
    • Allowed Methods: TOTP, SMS, email
  3. Click “Save Changes”

Rate Limiting

Protect against abuse:

  1. Go to System Settings → Security
  2. Configure rate limits:
    • API Requests: Requests per minute (default: 60)
    • Login Attempts: Failed attempts before lockout (default: 5)
    • Lockout Duration: Minutes to lock account (default: 15)
  3. Click “Save Changes”

IP Whitelist/Blacklist

Control access by IP address:

  1. Go to System Settings → Security
  2. Add IP addresses or ranges:
    • Whitelist: Only allow these IPs
    • Blacklist: Block these IPs
  3. Click “Save Changes”

Format:

  • Single IP: 192.168.1.1
  • Range: 192.168.1.0/24
  • Multiple: One per line

OAuth & OIDC

OAuth Configuration

Enable OAuth authentication:

  1. Go to System Settings → Authentication
  2. Enable “OAuth Authentication”
  3. Configure:
    • Client ID: OAuth client ID
    • Client Secret: OAuth client secret
    • Authorize URL: OAuth authorization endpoint
    • Token URL: OAuth token endpoint
    • User URL: OAuth user info endpoint
    • Scopes: Required OAuth scopes
  4. Click “Save Changes”

OIDC Configuration

Enable OpenID Connect:

  1. Go to System Settings → Authentication
  2. Enable “OIDC Authentication”
  3. Configure:
    • Discovery URL: OIDC discovery endpoint
    • Client ID: OIDC client ID
    • Client Secret: OIDC client secret
    • Scopes: Required scopes (default: openid profile email)
  4. Click “Save Changes”

Provider-Specific Settings

Keycloak

OIDC_ENABLED=true OIDC_DISCOVERY_URL=https://keycloak.example.com/realms/myrealm/.well-known/openid-configuration OIDC_CLIENT_ID=linkace OIDC_CLIENT_SECRET=your-secret

Authentik

OIDC_ENABLED=true OIDC_DISCOVERY_URL=https://authentik.example.com/application/o/linkace/.well-known/openid-configuration OIDC_CLIENT_ID=linkace OIDC_CLIENT_SECRET=your-secret

Auth0

OIDC_ENABLED=true OIDC_DISCOVERY_URL=https://your-tenant.auth0.com/.well-known/openid-configuration OIDC_CLIENT_ID=your-client-id OIDC_CLIENT_SECRET=your-secret

API Settings

API Configuration

Configure API behavior:

  1. Go to System Settings → API
  2. Enable “API Access”
  3. Configure:
    • Rate Limit: Requests per minute
    • Token Expiry: Days before tokens expire (0 = never)
    • Require Authentication: Require API tokens
    • CORS Origins: Allowed origins for CORS
  4. Click “Save Changes”

API Documentation

Enable API documentation:

  1. Go to System Settings → API
  2. Enable “API Documentation”
  3. Choose documentation style:
    • Swagger UI: Interactive API explorer
    • ReDoc: Clean documentation
    • Both: Enable both interfaces
  4. Click “Save Changes”

Access documentation at:

  • Swagger UI: /api/documentation
  • ReDoc: /api/docs

Integration Settings

Zapier

Enable Zapier integration:

  1. Go to System Settings → Integrations
  2. Enable “Zapier Integration”
  3. Copy the webhook URL
  4. Configure in Zapier

Webhooks

Configure custom webhooks:

  1. Go to System Settings → Integrations
  2. Click “Add Webhook”
  3. Configure:
    • URL: Webhook endpoint
    • Events: Which events trigger the webhook
    • Secret: Webhook signing secret
  4. Click “Save Webhook”

Available Events:

  • Link created
  • Link updated
  • Link deleted
  • Tag created
  • List created
  • User registered

RSS Feeds

Configure RSS feed behavior:

  1. Go to System Settings → Integrations
  2. Enable “RSS Feeds”
  3. Configure:
    • Items Per Feed: Number of items (max 100)
    • Include Descriptions: Include full descriptions
    • Cache Duration: Minutes to cache feeds
  4. Click “Save Changes”

Maintenance

System Maintenance Mode

Enable maintenance mode:

  1. Go to System Settings → Maintenance
  2. Enable “Maintenance Mode”
  3. Set:
    • Message: Display message to users
    • Allowed IPs: IPs that can still access
    • Retry After: Seconds until retry (for HTTP header)
  4. Click “Save Changes”

Cache Management

Manage system caches:

  1. Go to System Settings → Maintenance
  2. Clear caches:
    • Application Cache: Clear app cache
    • Configuration Cache: Clear config cache
    • Route Cache: Clear route cache
    • View Cache: Clear compiled views
  3. Click “Clear All Caches”

Queue Management

Monitor and manage queues:

  1. Go to System Settings → Maintenance
  2. View queue statistics:
    • Pending jobs
    • Failed jobs
    • Processed jobs
  3. Actions:
    • Retry Failed: Retry all failed jobs
    • Clear Failed: Delete failed jobs
    • Pause Queue: Temporarily stop processing

Database Maintenance

Optimize database performance:

  1. Go to System Settings → Maintenance
  2. Run maintenance tasks:
    • Optimize Tables: Optimize database tables
    • Rebuild Indexes: Rebuild search indexes
    • Clean Old Data: Remove old sessions and logs
  3. Click “Run Maintenance”

System Information

Version Information

View system details:

  1. Go to System Settings → System Info
  2. See:
    • LinkAce version
    • PHP version
    • Database version
    • Laravel version
    • Server information

System Health

Check system health:

  1. Go to System Settings → System Info
  2. View health checks:
    • Database connection
    • Redis connection
    • Queue worker status
    • Disk space
    • Memory usage
  3. Address any warnings or errors

Update Check

Check for updates:

  1. Go to System Settings → System Info
  2. Click “Check for Updates”
  3. View available updates
  4. Follow update instructions

Logs

View Logs

Access system logs:

  1. Go to System Settings → Logs
  2. Select log type:
    • Application: General application logs
    • Error: Error logs
    • Access: Access logs
    • Queue: Queue job logs
  3. Filter by:
    • Date range
    • Log level
    • Search term
  4. Download logs if needed

Log Configuration

Configure logging behavior:

  1. Go to System Settings → Logs
  2. Set:
    • Log Level: Debug, info, warning, error
    • Log Channel: File, database, syslog
    • Retention: Days to keep logs
    • Max File Size: Maximum log file size
  3. Click “Save Changes”

Advanced Settings

Performance Optimization

Optimize system performance:

  1. Go to System Settings → Advanced
  2. Enable optimizations:
    • OPcache: PHP opcode caching
    • Query Caching: Database query cache
    • View Caching: Compile and cache views
    • Route Caching: Cache route definitions
  3. Click “Save Changes”

Debug Mode

Enable debug mode (development only):

  1. Go to System Settings → Advanced
  2. Enable “Debug Mode”
  3. Configure:
    • Debug Bar: Show debug toolbar
    • Query Logging: Log all database queries
    • Error Display: Display detailed errors
  4. Click “Save Changes”

Warning: Never enable debug mode in production.

Custom CSS/JS

Add custom styling or scripts:

  1. Go to System Settings → Advanced
  2. Enter custom CSS in the CSS field
  3. Enter custom JavaScript in the JS field
  4. Click “Save Changes”

Example Custom CSS:

/* Custom branding */ .navbar { background-color: #your-color; }

Troubleshooting

Settings Not Applying

  • Clear application cache
  • Restart queue workers
  • Check file permissions
  • Review error logs

Email Not Sending

  • Test SMTP connection
  • Check firewall rules
  • Verify credentials
  • Review email logs

Backups Failing

  • Check storage permissions
  • Verify credentials
  • Check disk space
  • Review backup logs

Performance Issues

  • Enable caching
  • Optimize database
  • Check server resources
  • Review slow query log

Best Practices

  1. Regular Backups: Schedule daily backups
  2. Monitor Logs: Review logs weekly
  3. Update Regularly: Keep LinkAce up to date
  4. Secure Configuration: Use strong passwords and 2FA
  5. Test Changes: Test in staging before production
  6. Document Settings: Keep track of custom configurations
  7. Monitor Performance: Watch resource usage
  8. Review Security: Regular security audits

Next Steps

  • User Settings: Configure personal preferences
  • Managing Links: Learn about link management
  • Post-Setup Steps: Complete initial configuration