Skip to Content
getting-startedQuick Start Guide

Last Updated: 3/9/2026

Quick Start Guide

Get LinkAce up and running in under 10 minutes. This guide will walk you through the fastest path to a working LinkAce installation.

What You’ll Need

  • A server with Docker installed (recommended), or
  • A PHP 8.1+ environment with a database
  • 5-10 minutes of your time

Choose Your Installation Method

Option 1: Quick Test with SQLite (2 minutes)

Perfect for trying out LinkAce before committing to a full installation.

touch database.sqlite
chmod 0766 database.sqlite
docker run -p "8080:80" -v "./database.sqlite:/app/database/database.sqlite" linkace/linkace

Then open http://localhost:8080 in your browser and follow the setup wizard.

Note: This SQLite setup is for testing only. For production use, follow Option 2 below.

Option 2: Production Setup with Docker (10 minutes)

This is the recommended method for actual use.

Step 1: Download the setup package

Get the latest Docker setup from the LinkAce releases page  - look for linkace-docker.zip.

Step 2: Configure your environment

Extract the files and edit the .env file:

# Set secure passwords (required!)
DB_PASSWORD=your_secure_database_password_here
REDIS_PASSWORD=your_secure_redis_password_here

Step 3: Start LinkAce

docker compose up -d

Step 4: Complete the setup

Open http://localhost (or your domain) in your browser. The setup wizard will guide you through:

  1. Database configuration (already set from .env)
  2. Creating your admin account
  3. Basic application settings

That’s it! LinkAce is now running.

Essential Post-Setup Steps

To unlock LinkAce’s full potential, complete these quick configurations:

1. Set Up the Cron Job (5 minutes)

The cron enables automated backups to the Internet Archive and regular link health checks.

For Docker:

# Add this to your system crontab (crontab -e)
* * * * * docker exec linkace-app-1 php artisan schedule:run > /dev/null

For PHP installations:

# Add this to your system crontab
* * * * * cd /path/to/linkace && php artisan schedule:run > /dev/null

2. Install the Bookmarklet (1 minute)

The bookmarklet lets you save links from any website with one click.

  1. Log into LinkAce
  2. Click your username → User Settings
  3. Drag the “Bookmarklet” button to your browser’s bookmarks bar

Now you can save any webpage by clicking the bookmarklet while browsing!

3. Configure Email (Optional)

Email enables link check notifications and user invitations.

Add to your .env file:

MAIL_FROM_ADDRESS=linkace@yourdomain.com
MAIL_FROM_NAME=LinkAce
MAIL_MAILER=smtp
MAIL_HOST=smtp.gmail.com
MAIL_PORT=587
MAIL_USERNAME=your_email@gmail.com
MAIL_PASSWORD=your_app_password
MAIL_ENCRYPTION=tls

Restart the container: docker compose restart

Start Using LinkAce

  1. Click “Add Link” in the menu
  2. Paste a URL
  3. Add tags (like “tutorial”, “reference”)
  4. Optionally add to a list (like “Web Dev Resources”)
  5. Click Save

LinkAce will automatically:

  • Fetch the page title and description
  • Send it to the Internet Archive for backup
  • Schedule regular availability checks

Understanding Tags vs Lists

  • Tags are labels you can add freely to any link (like “javascript”, “tutorial”, “favorite”)
  • Lists are collections that group related links together (like “Learning Resources” or “Project Ideas”)

Use tags for flexible categorization, lists for curated collections.

Next Steps

  • Organize your bookmarks: Import existing bookmarks from your browser (Configuration → Import)
  • Share with others: Invite team members or family (User Management)
  • Enable backups: Set up automated backups to S3-compatible storage
  • Explore the API: Generate API tokens for integrations with other tools

Need Help?

If you run into issues:

  1. Check the Troubleshooting Guide
  2. Visit the LinkAce Community Discussions 
  3. Review the detailed Installation Documentation

What’s Next?

Now that LinkAce is running, explore:

What Is Linkace