Skip to content

ahmadfarhan1981/linkstash

Repository files navigation

🔖 LinkStash

LinkStash Logo

Latest Release License Stars Docker Pulls Self-Hosted

"Stash Your Links, Revisit Anytime - LinkStash: Your Self-Hosted Bookmark Manager"

LinkStash is a self-hosted, backend-driven bookmarking and "read it later" solution, empowering you to take full control of your saved links and offline content.

LinkStash Demo GIF

Features

  • 📁 Privacy & Ownership: Full control over your data, self-hosted for maximum privacy.
  • 🌐 Offline Access: Save and read content offline, even without internet.
  • 🗄️ Simple Deployment: Get started quickly with Docker Compose.
  • 🔧 REST API Integration: Easily connect and automate with full REST API support.

Why LinkStash?

LinkStash is designed to give you complete control over your bookmarking needs. Unlike cloud-based alternatives, LinkStash offers:

  • Privacy & Ownership: Self-hosted, so your data stays with you.
  • Offline Reading: Save articles for later, even when you're offline.
  • REST API Access: Full access to all features via REST endpoints, making it easy to integrate with other tools.
  • Easy Deployment: Get started quickly with Docker Compose, making setup painless.

LinkStash is built for users who value control, privacy, and flexibility in organizing their web content.

Quickstart

Docker Compose

To get up and running with default settings using Docker Compose:

mkdir config
mkdir archive

wget https://raw.githubusercontent.com/ahmadfarhan1981/linkstash/develop/docker/docker-compose.yaml

docker compose up -d

Access LinkStash at: http://localhost:3000

Default credentials:

username: admin
password: password

Persistent Data

Persistent data created by LinkStash is located in a few places:

  • MySQL data files are stored in the linkstash-data Docker volume.
  • The ./archive folder contains downloaded assets for offline use.
  • the ./config folder contains files to track the status of the db migration.

More info

Visit the website for the user guide

Community, Contribution & Development

Thanks for taking the time to contribute!

All types of contributions are encouraged and valued. 🎉

If you like the project, but just don't have time to contribute, that's fine. You can support the project by:

  • Star the project
  • Mention the project on social media
  • Participate in in discussions.

For detailed contribution guidelines, see CONTRIBUTING.md.

Similar Projects / Services

Status

MVP release

With the addition of the bulk management features in V1.1 I consider this as MVP complete.

For the Future

There is a blog post on the future of LinkStash on my blog.

Development will be slow and steady.

These are the focus.

  • Archive formatting
  • mobile
  • other selfhosted tools integration.

About

Stash Your Links, Revisit Anytime - LinkStash: Your Self-Hosted Bookmark Manager

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published