Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/bukuserver readme update #657

Closed
wants to merge 10 commits into from
Closed

Feature/bukuserver readme update #657

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ce306c0
docs(bukuserver): add screenshot for slate theme
rachmadaniHaryono Dec 20, 2022
f8bd678
docs: bukuserver
rachmadaniHaryono Jan 6, 2023
427c177
docs: buku readme
rachmadaniHaryono Jan 6, 2023
79fc2b3
docs: use short url on bukuserver readme
rachmadaniHaryono Jan 6, 2023
84911d5
docs: bukuserver use new screenshot
rachmadaniHaryono Jan 6, 2023
b36632a
docs(bukuserver): fix heading on readme
rachmadaniHaryono Jan 7, 2023
3bac1a1
docs(bukuserver): explain default favicon setting
rachmadaniHaryono Jan 7, 2023
cf44f6d
docs(bukuserver): favicon
rachmadaniHaryono Jan 10, 2023
6b9c784
docs(buku): typo
rachmadaniHaryono Jan 10, 2023
4809129
docs: tutorial for developer
rachmadaniHaryono Jan 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

`buku` is a powerful bookmark manager and a personal textual mini-web.

For those who prefer the GUI, [bukuserver](https://github.com/jarun/buku/tree/master/bukuserver#readme) exposes a browsable front-end on a local web host server.
For those who prefer the GUI, `bukuserver` exposes a browsable front-end on a local web host server. See [bukuserver page](https://github.com/jarun/buku/tree/master/bukuserver#readme) for config and screenshot.
rachmadaniHaryono marked this conversation as resolved.
Show resolved Hide resolved

When I started writing it, I couldn't find a flexible command-line solution with a private, portable, merge-able database along with seamless GUI integration. Hence, `buku`.

Expand Down
25 changes: 23 additions & 2 deletions bukuserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- [Using Docker Compose](#using-docker-compose)
- [Webserver options](#webserver-options)
- [Configuration](#configuration)
- [Screenshots](#screenshots)
- [Screenshots](#screenshots) ([imgur album](https://imgur.com/a/nk9dPEk))

### Installation

Expand Down Expand Up @@ -149,8 +149,23 @@ Note: the value for BUKUSERVER_REVERSE_PROXY_PATH
is recommended to include preceding slash and not have trailing slash
(i.e. use `/foo` not `/foo/`)

Note: At Bukuserver, we have disabled favicon as a default setting in order to prevent any non-user triggered network activity.

Our favicon is generated with the assistance of Google.

It is important to be aware that favicon has the potential to be used for browser fingerprinting,
a technique used to identify and track a person's web browsing habits.

- Github repo example https://github.com/jonasstrehle/supercookie
- Paper by Scientists at University of Illinois, Chicago https://www.cs.uic.edu/~polakis/papers/solomos-ndss21.pdf
- Article https://heise.de/-5027814
rachmadaniHaryono marked this conversation as resolved.
Show resolved Hide resolved

It is important to note that favicon can potentially be exploited in this way, even though it is a small and seemingly insignificant feature.

LeXofLeviafan marked this conversation as resolved.
Show resolved Hide resolved
### Screenshots

([imgur album](https://imgur.com/a/nk9dPEk))

<p><br></p>
<p align="center">
<a href="https://i.imgur.com/LozEqsT.png"><img src="https://i.imgur.com/LozEqsT.png" alt="home page" width="650"/></a>
Expand All @@ -167,7 +182,13 @@ is recommended to include preceding slash and not have trailing slash
<p align="center">
<a href="https://i.imgur.com/1eMruZD.png"><img src="https://i.imgur.com/1eMruZD.png" alt="index page" width="650"/></a>
</p>
<p align="center"><i>bookmark page</i></a></p>
<p align="center"><i>bookmark page with favicon enabled</i></a></p>

<p><br><br></p>
<p align="center">
<a href="https://i.imgur.com/DtUcjIl.png"><img src="https://i.imgur.com/KaZIezk.png" alt="index page" width="650"/></a>
</p>
<p align="center"><i>bookmark page with 'slate' theme and favicon enabled</i></a></p>

<p><br><br></p>
<p align="center">
Expand Down