Last Updated: 3/9/2026

Quick Start

Get LinkAce running in minutes with this fast-track guide. This is perfect for testing LinkAce or evaluating it before committing to a full installation.

2-Minute Test Setup (SQLite)

The fastest way to try LinkAce is with a single Docker command using SQLite as the database. Note: This setup is for testing only and is not recommended for production use.

Prerequisites

• Docker 19+ installed
• Command-line access

Steps

1. Create an empty SQLite database file:

   touch database.sqlite
   chmod 0766 database.sqlite

2. Run LinkAce:

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

3. Open in your browser:
   Navigate to http://localhost:8080 and follow the setup wizard to create your admin account.

Troubleshooting

If the container doesn’t start due to OS-specific Docker permissions, try running on a different internal port:

docker run -p "8080:8080" -e "PORT=8080" -v "./database.sqlite:/app/database/database.sqlite" linkace/linkace

Docker Compose Quick Start (Recommended)

For a more robust test setup with MySQL and Redis, use Docker Compose. This setup is closer to production-ready and supports all features.

Prerequisites

• Docker 19+ and Docker Compose (supporting compose version 3)
• Command-line access to your server

Steps

1. Download the Docker setup package:
   Get the latest package from the LinkAce releases page :
   👉 linkace-docker.zip

2. Extract the files:
   You should have:

   linkace/
   ├╴ .env
   ├╴ docker-compose.yml
   ├╴ LICENSE.md
   └╴ README.md

3. Edit the .env file (optional but recommended):
   Open .env and change these values:

   DB_PASSWORD=YourSecurePasswordHere
   REDIS_PASSWORD=AnotherSecurePasswordHere

4. Start the containers:

   docker compose up -d

5. Open the setup wizard:
   Navigate to http://localhost (or your server’s IP/domain) and complete the web-based setup:

   • Configure database connection (pre-filled from .env)
   • Create your admin account
   • Set initial preferences

6. Enable automation (important):
   After setup, follow the Post-Installation guide to enable:

   • Link health checks
   • Wayback Machine archiving
   • Scheduled backups

What’s Next?

After your quick start:

1. Learn the basics: Read Core Concepts to understand Links, Lists, Tags, and Visibility settings.

2. Add your first links:

   • Use the “Quick Add” form on the dashboard
   • Install the bookmarklet for saving from your browser
   • Import existing bookmarks from HTML exports

3. Configure for production:

   • Set up HTTPS with Docker
   • Configure System Settings (guest access, automation, notifications)
   • Enable automated backups to S3-compatible storage

4. Invite users (optional):

   • Set up Single Sign-On for OAuth/OIDC
   • Configure User Management and invite team members

Full Installation Guides

For production deployments, see the complete installation guides:

• Installation with Docker - Recommended for most users
• Installation without Docker - For PHP/web server setups
• Installation with Kubernetes - Helm chart for K8s clusters
• Cloud Deployment - One-click deploy to cloud providers

Need Help?

If you encounter issues:

1. Check the Troubleshooting guide
2. Search GitHub Discussions 
3. Enable debug mode by adding APP_DEBUG=true to your .env file and check logs

For dedicated support, consider becoming a supporter on Open Collective , Patreon , or GitHub Sponsors .