Skip to content

Bukuserver (WebUI)

LeXofLeviafan edited this page Oct 2, 2024 · 1 revision

Buku includes a companion Web-application, Bukuserver (it requires additional dependencies; the package should be installed with server extra, i.e. pip install buku[server]).

Check out Bukuserver README file for more information.

Screenshots (from the same README file)

home page
home page

bookmarks page (with favicons enabled)
bookmarks page (with favicons enabled)

bookmarks page with 'slate' theme and favicon enabled
bookmarks page with 'slate' theme and favicon enabled

stats page
stats page

tags page
tags page

Runner script

Since configuring Bukuserver requires setting up environment variables, and it has no builtin support for switching databases, a runner script was made. (It's quite convenient for managing multiple databases, both for normal use and during development.)

As explained in the README file, you can install it in your PATH to run from command line, or in a shortcut to run from your desktop/applications menu; and settings (both for Bukuserver and the script itself) can be defined in bukuserver.env file within your buku settings folder (incidentally, DB files will be placed there as well):

# ~/.local/share/buku/bukuserver.env or %APPDATA%\Roaming\buku\bukuserver.env
BUKUSERVER='~/Sources/buku/'  # when running from sources (nightly/developer option)
BUKUSERVER_THEME=slate
BUKUSERVER_DISABLE_FAVICON=false
BUKUSERVER_OPEN_IN_NEW_TAB=true

Screenshots

DB selection dialog
DB selection dialog – shown on startup (unless no DB files were found); initially the previous DB is selected

DB creation dialog
DB creation dialog – shown if no DB was selected (or none found)

DB exists
A confirmation dialog is shown if new DB name is taken already

DB naming error
DB name must be a valid filename, sans the .db extension (invalid chars: / on Linux, or any of <>:"/\|?* on Windows)

no-GUI mode
DB selection prompt in console shell/no-GUI mode (BUKU_NOGUI=y)

Clone this wiki locally