this post was submitted on 25 Nov 2023
12 points (100.0% liked)

Self-Hosted Main

504 readers
1 users here now

A place to share alternatives to popular online services that can be self-hosted without giving up privacy or locking you into a service you don't control.

For Example

We welcome posts that include suggestions for good self-hosted alternatives to popular online services, how they are better, or how they give back control of your data. Also include hints and tips for less technical readers.

Useful Lists

founded 1 year ago
MODERATORS
 

The time has come to unveil Grimoire, a bookmark manager designed specifically for everyone who is missing a little bit of magic touch when it comes to organizing their bookmarks.

Its mission is simple: to help you add, process, and organize your bookmarks in a way that makes sense.

Reasoning behind the project​

I've always struggled with organizing my bookmarks. Even though I tried many options, none of them really appealed to me. The built-in bookmark managers in browsers were too basic and didn't allow me to organize my bookmarks in a way that made sense to me. The most popular external bookmark managers have been too simple, too complicated, or too expensive for what they offer.

What I liked the most was the idea of having a bookmark manager with a relational database I had access to. This would let me retrieve my bookmarks in any way I wanted, and I could easily add new features in the future. I've searched for a solution that would allow me to do that, but I couldn't find anything that would fit my needs.

And that's how the idea of the Grimoire was born. I wanted to create a bookmark manager that would be simple to use, but also powerful enough to let me organize my bookmarks in a way that made sense to me. Moreover, I wanted to take SvelteKit and PocketBase for a spin, and this seemed like a perfect opportunity to do so.

How it looks now​

Starting with v0.1.0, Grimoire has most of the basic features you would expect from a bookmark manager:

  • bookmarks:
    • can be added, viewed, edited, and deleted
    • can be organized into categories and tagged
    • metadata, like title, description, HTML content, favicon, and image, is fetched from the website and stored locally
    • can have notes added to them
  • bookmark list:
    • display in a grid or list view
    • can be searched by title, description, URL, and tags
    • filtering by category, tag, and and more
    • sort by date added, domain, and more
  • users:
    • can sign up and sign in
    • all bookmarks, categories, and tags are private to the user
  • admin panel:
    • is used to manage users and see their bookmark, category, and tag counts
    • can be used to preview most of PocketBase settings
  • other:
    • it's dockerized, so it's easy to run it locally or deploy it to your server
    • all the benefits of a self-hosted PocketBase installation, like scheduled backups (local and to S3), high performance, and data security
    • dark mode, because dark wizardry requires darkness
    • responsive design as magic should be accessible to everyone, everywhere
    • early and experimental support for AI-powered features (more on that in the future), like automatic tag suggestions
  • and that's just the beginning!

What's next​

It's still a work in progress, but I'm happy with the functionality provided so far. You can expect more useful features, like a way to import bookmarks from other services and export them to most popular file formats, public profiles, better admin panel, AI-powered features - just to name a few. For more details, check out the roadmap.

How to get it up and running​

If you want to try it out, you can run it locally!

Contributors are more than welcome​

To make Grimoire even better, I need your help! Don't be a stranger and check out the contributing guidelines today!

top 50 comments
sorted by: hot top controversial new old
[–] KoppleForce@alien.top 2 points 11 months ago (1 children)

"Cross-site POST form submissions are forbidden"

​

Every time I try to log in with the info i put into the .env file. Doing "sign up" from the app does not do anything.

[–] DearBrotherJon@alien.top 2 points 11 months ago

I've been poking around trying to deploy this as well.

You'll want to edit the Dockerfile and make sure your origin is set to whatever url you'll be accessing grimoire from.

​

However, even doing this, I'm not able to login even when I manual inject a user into pocketbase.

[–] sirzoyisp@alien.top 2 points 11 months ago

Thanks for sharing your project with us, but did you know that adding a screen shot somewhere won't kill your projectβ‰πŸ—Ώ

[–] Baconspl1t@alien.top 2 points 11 months ago

I try to test this out but having problems setting it up properly?

I set an Email and Password in all of the .env files and started the container with docker-compose up. But neither the admin panel or the normal login accept the credentials.

Any help please?

[–] TheFumingatzor@alien.top 1 points 11 months ago (1 children)

I'll wait until there's pre-made container to use.

[–] panjadotme@alien.top 1 points 11 months ago (1 children)

+1, I'd love something posted to docker hub

[–] goniszewski@alien.top 1 points 11 months ago (1 children)

Images from Docker Hub or GitHub Container Registry will be available soon :)

[–] Omkar_K45@alien.top 1 points 11 months ago (1 children)

The code quality is so nice OP Very well done and thanks a lot!!

[–] goniszewski@alien.top 1 points 11 months ago

Thank you! I hope it will allow for smooth contributions for anyone willing to help make Grimoire better πŸ™‚

[–] RedditSlayer2020@alien.top 1 points 11 months ago (1 children)

Love it but it's absolutely overkill. What stack are you using? I saw svelte and tailwindcss.

Growing up with the Internet seeing today's 'modern' approaches when it comes to Web development the requirements grow exponentially and that's frustrating because the barrier of entrance gets ridiculously high.

Even though a lot of concepts have been invented, none feel 'natural' to me, it's almost as if the clunkyness of language design (c, c++ etc) has been carried over to the modern webapp era

[–] ProbablePenguin@alien.top 1 points 11 months ago

Don't forget that the modern approaches also make it much quicker and easier for someone to make something.

[–] memeree@alien.top 1 points 11 months ago

Remindme! 4days

[–] shortorbluff@alien.top 1 points 11 months ago

Great! Thanks for sharing! Definitely trying it out :)

[–] Plausibility_Migrain@alien.top 1 points 11 months ago

A new tool to try out on Monday. Thank you for this

[–] atreides4242@alien.top 1 points 11 months ago

I have yet to find β€œthe answer” to bookmarks so I am interested in checking this out.

[–] darkcloud784@alien.top 1 points 11 months ago (1 children)

Is there a browser extension we can use with this or a plan for one? Currently I use wallabag but I think this may be a good replacement as long as it has some sort of browser implementation

[–] goniszewski@alien.top 1 points 11 months ago (2 children)

Most definitely there will be an official browser extension. Grimoire is just meant to be accompanied by one! πŸͺ„

[–] Medium_Skirt@alien.top 1 points 11 months ago

A browser extension will be useful for me if it caches the bookmarks for offline use, as I don't keep a constant connection to my self hosted server from my mobile (I use tailscale to connect to my home server and it's not constantly kept on).

[–] kring1@alien.top 1 points 11 months ago (1 children)
[–] goniszewski@alien.top 1 points 11 months ago

Firefox can use the same extension under the right conditions. I’m using it myself, so it’s one of my goals to make this happen!

[–] forwardslashroot@alien.top 1 points 11 months ago (1 children)

Are you planning to add ldap authentication?

[–] goniszewski@alien.top 1 points 11 months ago (2 children)

The project relies heavily on PocketBase, a conscious decision. Although it could, and maybe even should, be abstracted later, the app will be limited in the authentication department by it.

In short: I can’t guarantee LDAP support in foreseeable future :(

[–] forwardslashroot@alien.top 1 points 11 months ago

I don't know why i got downvoted. I asked because it is hard to keep up with users' credentials with local user db, especially with other selfhosted services.

[–] emprahsFury@alien.top 1 points 11 months ago

Pocketbase supports oauth, do you expose adding custom providers (possibly in the .env.docker)? In line with the other guy, all my users are already setup elsewhere. It's increasingly a nonstarter to have a) a wasted identity provider and b) redo all this work for every new app.

Although it is a nice step up to have multi-user support at all.

[–] MalcolmY@alien.top 1 points 11 months ago (1 children)

I have quesion for you. Why do you use:

git clone git@github.com:goniszewski/grimoire.git

instead of:

git clone https://github.com/goniszewski/grimoire.git
[–] goniszewski@alien.top 1 points 11 months ago

It has many advantages over the HTTPS one. And also was always the preferred way of interacting with remote repositories by teams I worked with in my professional career.

I think this comment sums it up nicely: https://www.reddit.com/r/webdev/s/Ecg3lm5sfV

[–] tfm@alien.top 1 points 11 months ago

What a coincidence! I know someone that's working in a very similar solution: a bookmarks organizer with a rdbms backend.

Good luck!

[–] iiiiiiiiiiip@alien.top 1 points 11 months ago

Looks great, I literally installed Shiori 2 days ago but can see myself moving to this. The one feature I'd love to see that's broken on Shiori is a browser extension to make adding bookmarks faster and easier.

[–] HammyHavoc@alien.top 1 points 11 months ago

Looks cool!

[–] bolanoid@alien.top 1 points 11 months ago

Remindme! 90days

[–] ShivamKumar2002@alien.top 1 points 11 months ago

This is exactly what I needed

[–] sirquack0@alien.top 1 points 11 months ago

This is what I was looking for! one thing I would like is having the ability of having the bookmarks in the regular bookmark tab to easily access them as if I was using the browser. Is that possible?

[–] a_normal_game_dev@alien.top 1 points 11 months ago (1 children)

Damn! Looks very impressive! I like the design so much!

[–] goniszewski@alien.top 1 points 11 months ago

It’s the magic of awesome DaisyUI we’re using! 🌼

[–] ikukuru@alien.top 1 points 11 months ago (1 children)

Looks great, does it really β€œrequire” docker? Will it be difficult to run it from an lxc container?

[–] goniszewski@alien.top 1 points 11 months ago

A great question! Frankly, it can be launched via any JS package manager + PocketBase executable, so it shouldn’t be that hard.

That being said, at the beginning I would like to keep it simple and stick with Docker.

[–] omfgitsasalmon@alien.top 1 points 11 months ago

Remindme! 30days

[–] Ziritione85@alien.top 1 points 11 months ago (1 children)

It has not been possible to install it on a raspi4 (2GB) it stays installing forever.. To be more specific, at this point:

=> [grimoire build 1/2] RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --frozen-lockfile 429.3s

[–] goniszewski@alien.top 1 points 11 months ago

I know that making your own image can be a real challenge when the output has almost 1GB. In next 24h I will try to put some images on Docker Hub.

[–] Acrobatic-Constant-3@alien.top 1 points 11 months ago

!remindMe 4h

[–] Jacksaur@alien.top 1 points 11 months ago

Any advantages to this over Wallabag?

I don't mean that in a confrontational way, this looks great! But I'd rather force myself to find a good reason before I replace Wallabag with it so soon after spending the effort getting it set up :P

load more comments
view more: next β€Ί