sebcode / b

Minimalistic bookmark manager for your own server written in PHP. Bookmarks are stored in a sqlite database.

b - Bookmark manager

b is a minimalistic bookmark manager for your own server. Written in PHP. Bookmarks are stored in a sqlite database. Features:

• filtering
• tagging
• automatic fetching of page title
• infinite scrolling (optional)
• bookmarklet
• multiple users

Requirements

• make
• docker + docker compose

Tested on Ubuntu 21.04 and macOS Big Sur.

Setup

This web app uses HTTP basic auth password protection. Create a htusers file and specify username/password like this:

mkdir db
./htpasswd -c db/htusers peter

The bookmark manager can host multiple databases. To initialize a new database, simply create a subdirectory:

mkdir db/peter

This will make bookmarks accessible via http://localhost:9090/peter.

Use make to start the webserver container and make down to stop it.

To prevent forking the container into the background, use make up instead of make (useful for debugging).

How to use

• To add a new bookmark, simply paste it into the input field and press return. the url may be followed by hash tags, e.g. http://example.com #example #bla #wurst
• The website's title is automatically fetched and the bookmark is added to the database.
• Edit title by double clicking it. This opens a prompt-dialog where you can edit the title. Enter '-' (minus sign) to remove an entry.
• To edit the URL, double click beside the link.
• The input field can also be used to filter bookmarks. Filtering is done with a full-text search on all titles. Search terms are separated by spaces and joined with AND.

Infinite scrolling

If you have a massive amount of bookmarks and you don't want to load them all at once, you can activate infinite scrolling. This will load a limited amount of bookmarks initially and load more when you scroll to the bottom of the page. Activate infinite scrolling by adding INFINITE_SCROLLING=200 to .env. Replace 200 with the number of bookmarks you want to load each time you hit the bottom.

Bookmarklet

Visit /[user]/bookmarklet to access the user's bookmarklet, e.g. http://bookmarks.example.com/peter/bookmarklet. (Thanks to nibreh for the suggestion!)

Credits

Copyright (c) 2011-2021 Sebastian Volland http://github.com/sebcode

The source code is licensed under the terms of the MIT license (see LICENSE file).

b's Issues

Tag github repository with "bookmarks-manager" and "self-hosted"

.. so it is easier to find via github's search.

getConfig() cannot return false

b/htdocs/index.php

Line 55 in 2958419

if ($count !== false) {

as it is currently defined, getConfig() will return a string or a null value.

J

Bookmarklet feature

HI! Very nice app, I like the minimalism !

A bookmarklet will be nice, what do you think about ?

For now I use this trick: http://codepen.io/Realto619/pen/RPGaVd

Juh

File not found

I'm trying to setup B on a remote server through ftp. The site should run in a subdomain.
http://testing.meplaza.nl/index.php?configtest gives an 'OK', but going trying to access the site results in 'Page not found.' How to fix this?

returning mixed crashes in (at least) php 7.4.26

b/src/BookmarkManager.php

Line 85 in 2958419

public function getConfig(string $key): mixed

returning mixed crashes for me in (at least) php 7.4.26

i guess that if you want to use types, you should rather use:

public function getConfig(string $key): ?string

this will work as long as -- i think to understand -- the configs are done by putenv, which will always return a string (or false... but you're catching that branch in putenv())

bookmarklet.php reads a config.php which is supposed to be in htdocs

b/htdocs/bookmarklet.php

Line 3 in 2958419

$config = require(__DIR__.'/config.php');

bookmarklet.php reads a config.php which is supposed to be in htdocs:

• i would avoid to require a config.php to be in htdocs. i would read it from __DIR__/../conf/, instead
• i could not find in the documentation how config.php should look like...

Pagination

How about to add a pagination system ?

For example, in config.php, we can choose how much link we want to display. Maybe this can be useful when there are many links to display. But I don't know if it's necessary or possible and simple to do.

I don't think it's a good idea to define the namespace in index.php

b/htdocs/index.php

Line 3 in 2958419

namespace B;

technically it probably works.

but up to now, I've only seen the namespace used where the functions and classes are defined, not where they are used.

not a big issue, but that did let me wonder what was going on...

this will probably be my last ticket for now.
b now works on my computer and i will upload it to my server and start using it.
thanks for sharing your code!

no need to cast getenv to string

b/src/BookmarkManager.php

Line 17 in 2958419

return getenv($key) !== false ? (string)getenv($key) : null;

getenv() alway returns a string or false.

since you're checking for false, there is no use for the cast.

BookManager says "baseDir not defined in config.php" but no config.php is read before the object is created

b/src/BookmarkManager.php

Line 27 in 2958419

throw new \Exception('baseDir not defined in config.php');

but index.php doe not read config.php.