LinkAce is a self-hosted tool for archiving, organizing, and sharing your favorite web links. If you are new to LinkAce, start with the setup guide, finish the post-setup checklist, then save your first links or import bookmarks from your browser.
New to LinkAce
- Follow the Getting Started guide for the shortest path from a fresh installation to daily use.
- Choose an installation method if you are setting up LinkAce for the first time.
- Install with Docker for the recommended self-hosted setup.
- Follow the post-setup checklist to enable email, cron, automated checks, and backups.
- Complete the first steps after setup to verify adding, importing, searching, and defaults.
- Add and manage links once your instance is running.
- Import browser bookmarks if you already have a bookmark collection.
- Install the Bookmarklet to save pages from your browser quickly.
Install or Upgrade
- Setup overview explains the available installation options.
- Setup with Docker is the recommended setup path for most users.
- Setup with Helm is available for Kubernetes environments.
- One-click cloud deployment is available through Deploystack.
- Setup without Docker is available for manual PHP installations.
- Upgrade LinkAce if you already run LinkAce v2.
- Upgrade from LinkAce v1 if you still use the old major version.
Use LinkAce
- Dashboard explains the start page after login.
- Links covers adding, editing, organizing, checking, and archiving links.
- Lists and Tags explain the two ways to organize links.
- Advanced Search helps you find links with filters.
- Bookmarklet lets you save pages without leaving the site you are reading.
- Trash explains restore and permanent deletion behavior.
- RSS Feeds provide public and private feed URLs.
Configure and Administer
- User Settings control personal defaults, privacy, display, sharing, and Wayback Machine behavior.
- System Settings control update checks, cron, guest access, and site-wide options.
- User Management explains users, roles, invitations, and visibility.
- Application Backups explains local and S3-compatible backups.
- User API Tokens and System API Tokens explain API access.
- SSO with OAuth or OIDC explains single sign-on setup.
- Advanced Settings lists
.envconfiguration options. - CLI Commands covers maintenance commands.
Fix a Problem
- Troubleshooting explains how to collect logs, debug setup issues, and ask for help.
- Post-Setup Steps is useful if cron, email, backups, or link checks do not work yet.
- System Settings explains cron and guest access settings.
- Link Checks explains automated checks for dead or moved links.
Integrate with Other Tools
- API Documentation documents the REST API.
- Third-Party Tools and Libraries lists community tools and integrations.
- RSS Feeds can expose LinkAce data to feed readers.
Core Concepts
This is a quick introduction to LinkAce and its core concepts.
Links
LinkAce is a bookmark archive. You may store any URI inside the app, for example https://cloudhiker.net,
ftp://homer:[email protected]/employee-handbook.pdf or ms-excel:ofv|u|<https://contoso/Q4/budget.xls>.
Link-specific Features
- While saving a link, title and description is automatically generated if you leave either of those blank.
- Links are monitored on a regular basis and checked if they are still available.
- Website links are sent to the Internet Archive to be archived by their Wayback Machine.
Available features for different Link protocols
| Feature | HTTP(S) | HTTP(S) for private IP ranges | other URIs |
|---|---|---|---|
| Store in LinkAce | ✅ | ✅ | ✅ |
| Meta generation | ✅ | ⚠️ (Details) | ❌ |
| Backup to the Internet Archive | ✅ | ❌ | ❌ |
| Automated uptime checks | ✅ | ✅ | ❌ |
Lists and Tags
Lists and Tags are two different ways to categorize your links.
- Lists may be used to group links into few broader or very specific categories, e.g. “Web Development Tools”.
- Tags in contrast may be added to links en masse and usually categorize links for various aspects of it. E.g. “internet”, “programming” or “farming”
However, you may use both Lists and Tags however you like.
Users
In LinkAce v2, you may use the application with other people, like your family, friends, sports club or even at work with your coworkers.
The first user created for LinkAce becomes an administrator and can invite others from the user overview.
When saving Links, lists or tags, they can be Public, Internal or Private. This means:
Publiclinks can be viewed by anyone with access to your LinkAce, including Guests if the Guest Mode is enabled.Internallinks can only be viewed by logged-in users. They are not visible to Guests.Privatelinks are only every visible to you.
Sharing of Lists and Tags between users
Lists and Tags which are either Public or Internal may be used by all users. There might be two Lists with the same name, because multiple users may create a List with the same name.
