Skip to content

joonfjp/linkboard

Repository files navigation

LinkBoard

LinkBoard demo

LinkBoard is an open-source, local-first personal link bin. Paste a URL to save it with its title and description, search saved links, and copy or open them later.

Quick start

With Docker and Docker Compose installed:

docker compose up --build -d

Open http://127.0.0.1:3000. Links are stored in the persistent linkboard-data Docker volume.

Run from source

git clone https://github.com/joonfjp/linkboard.git
cd linkboard
npm ci
npm start

Open http://127.0.0.1:3000. Saved links are written to data/links.json. Back up that file if the collection matters to you.

For development with automatic server restarts:

npm run dev

Configuration

Variable Default Purpose
HOST 0.0.0.0 Listen address
PORT 3000 Listen port
DATA_DIR ./data Persistent data directory
SHOW_IMAGES true Load preview images and icons
METADATA_TIMEOUT_MS 8000 Metadata request timeout
METADATA_MAX_BYTES 2000000 Maximum metadata response size
LINKBOARD_USERNAME unset Basic Auth username
LINKBOARD_PASSWORD unset Basic Auth password

Note: Enabling images causes browsers to request third-party thumbnails and favicons, which reveals the browser's IP address to those hosts.

Currently designed and tested for macOS only.

License

MIT

About

a local link bin

Resources

License

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors