Self-hosted bookmarking application!

Works with any Prisma compatible database (MySQL, Postgres, SQLite, etc.)

Give it a try at briefkasten.vercel.app 🎉

• Save by Browser Extension
• Save links with automatic title and description generation
• Keyboard Shortcuts
• Organise by categories and tags
• Import and Export Bookmarks from standard HTML format
• Multiple Views
• Fulltext Search
• API
• OAuth Login
• Bookmark Image Background Job

To self-host this application, you'll need the following thins:

1. Server / hosting platform for a Next.js application (i.e. Vercel / Netlify)
2. For OAuth login, a developer account at any one of the providers supported by NextAuth.js
3. Database that works with Prisma (i.e. MySQL, Postgres, SQLite, etc.)
4. Image hosting space (i.e. ImageKit / Cloudinary) (optional)

These are all relatively straight forward, other than the image hoster. This was chosen to avoid putting the images in the database. The example application at briefkasten.vercel.app is using ImageKit, but any other similar provider like Cloudinary would also do the job. I chose ImageKit, because they have an easy to use SDK and a generous free tier - 20GB of storage, a CDN, image transformations, and more. I wanted to avoid using AWS, but a simple S3 Bucket would also work here. If you want to change the image hosting mechanism, it only takes a few lines of code in the /src/pages/api/bookmarks/uploadImage.js file.

After you've got an account setup at all of the above providers, or have your own infrastructure ready to go, you can continue on to the next steps below.

1. Clone the repository

$ git clone git@github.com:ndom91/briefkasten.git && cd briefkasten

2. Install dependencies

$ npm install

3. Copy the .env.example file, and fill in your copy of the environment variables.

$ cp .env.example .env
$ vim .env

In this environment variables file, make sure to fill in any of the keys / secrets needed for the cloud providers you selected for the components above.

4. Start the server!

// dev
$ npm run dev

// prod
$ npm run build
$ npm start

There is a companion browser extension in the works which you can use to add websites to your vault while browsing the web. It can be found at ndom91/briefkasten-extension. It is currently not published on any of the Browser Extension Stores, but can be built locally and loaded as a development extension in any Chromium based browser. More details in that repository.

There is also a background job to fill in bookmarks which do not have a valid image. It can be found in the ndom91/briefkasten-scrape repository. This job runs every 2 hours in a Github Action and processes 10 bookmarks at a time.

This project is open to any and all contributions! Please stick to the ESLint / Prettier settings and I'll be happy to take a look at your issue / PR 😀

MIT