📮 Briefkasten with scrape

📕 Intro

More Intro: briefkasten and briefkasten-scrape

🎩 Features

Easy to self-host briefkasten with scrape using Docker

🧺 Prerequisites

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

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

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 briefkastenhq.com is using Supabase Storage, but any other similar provider like Cloudinary or a simple S3 Bucket would also do the job. I chose Supabase, because they have an easy to use SDK, a decent free tier, and I was already using their Postgres service.

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.

🐳 Docker

Thanks to how to install briefkasten using docker | blog .

You can also self-host Briefkasten with Docker. To do so, you must:

Install docker and docker-compose.
Clone this repository and copy the .env.example to .env file in briefkasten.

$ git clone https://github.com/Tuscan-blue/briefkasten.git
$ cd briefkasten
$ cp .env.example .env
$ vim .env

Here you also need to fill out the DATABASE_URL, NEXTAUTH_* and SUPABASE_* environment variables at minimum.
The DATABASE_URL for the postgres container should be DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable

Clone the briefkasten-scrape repository in a new directory

$ cd ..
$ git clone https://github.com/Tuscan-blue/briefkasten-scrape.git
$ cd briefkasten-scrape

Copy .env.example to .env in brefkasten-scrape and edit the file .env accordingly

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

Build Docker container

$ docker build . -t briefkasten-scrape:latest

start the application

$ cd ../briefkasten
$ docker compose up

After the initial start, you still have to manually seed the database. This is most easily done through the app container (bk-app).
1. Run docker exec -it bk-app /bin/bash to enter a terminal session inside the container.
2. Then run pnpm db:push inside the container. This will push the database schema from prisma to the configured database.
Now your application and database should be up and running at the default http://localhost:3000

🕸 Related

📲 Save from Android Share Menu

With this open-source application HTTP Shortcuts, you can create a "Share Menu" item which executes a POST request with dynamic input, i.e. a web page's URL and title. This makes it super easy to share items from your phone to Briefkasten! More information in the docs.

🌍 Browser Extension

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 and in the Chrome Extension Store. More details in that repository.

👷 Contributing

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 😀

📝 License

MIT