Skip to content

Commit c0aed33

Browse files
jarunjarun
authored
Merge pull request #833 from LeXofLeviafan/screenshots-v4.9
[Bukuserver] updating screenshots in README
2 parents 0e96513 + 9740796 commit c0aed33

2 files changed

Lines changed: 65 additions & 38 deletions

File tree

‎bukuserver-runner/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,24 @@ In GUI mode, the prompt is implemented as 2 dialogs; a list of databases to choo
1616

1717
Running `buku-server.py --stop` will kill the currently running Bukuserver process (thus allowing to restart it in the background, like a daemon). `buku-server.py --stop-if-running` will either start the script or kill Bukuserver if it's running already.
1818

19+
<details><summary><h3>Screenshots</h3></summary>
20+
21+
![DB selection dialog](https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/runner-script/db-selection.png "DB selection dialog")
22+
_DB selection dialog – shown on startup (unless no DB files were found); initially the previous DB is selected_
23+
24+
![DB creation dialog](https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/runner-script/db-creation.png "DB creation dialog")
25+
_DB creation dialog – shown if no DB was selected (or none found)_
26+
27+
![DB exists](https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/runner-script/existing-db-confirmation.png "DB exists")
28+
_A confirmation dialog is shown if new DB name is taken already_
29+
30+
![DB naming error](https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/runner-script/invalid-db-error.png "DB naming error")
31+
_DB name must be a valid filename, sans the `.db` extension (invalid chars: `/` on Linux, or any of `<>:"/\|?*` on Windows)_
32+
33+
![no-GUI mode](https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/runner-script/non-gui.png "no-GUI mode")
34+
_DB selection prompt in console shell/no-GUI mode (`BUKU_NOGUI=y`)_
35+
</details>
36+
1937
## Environment variables
2038

2139
The script behaviour can be configured by setting the following environment variables:

‎bukuserver/README.md‎

Lines changed: 47 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -108,34 +108,38 @@ See more option on `bukuserver run --help` and `bukuserver --help`
108108

109109
### Configuration
110110

111-
The following are os env config variables available for bukuserver.
111+
The following are [os env config variables](#how-to-specify-environment-variables) available for bukuserver.
112112

113-
| Name (_without prefix_) | Description | Value |
113+
_**Important:** all of them have a shared prefix_ **`BUKUSERVER_`**.
114+
115+
| Name (_without prefix_) | Description | Value _²_ |
114116
| --- | --- | --- |
115117
| PER_PAGE | bookmarks per page | positive integer [default: 10] |
116-
| SECRET_KEY | [flask secret key](https://flask.palletsprojects.com/config/#SECRET_KEY) | string [default: os.urandom(24)] |
118+
| SECRET_KEY | [flask secret key](https://flask.palletsprojects.com/config/#SECRET_KEY) | string [default: random value] |
117119
| URL_RENDER_MODE | url render mode | `full`, `netloc` or `netloc-tag` [default: `full`] |
118-
| DB_FILE | full path to db file | path string [default: standard path for buku] |
119-
| READONLY | read-only mode | boolean [default: `false`] |
120-
| DISABLE_FAVICON | disable bookmark [favicons](https://wikipedia.org/wiki/Favicon) | boolean [default: `true`] ([here's why](#why-favicons-are-disabled-by-default))|
121-
| OPEN_IN_NEW_TAB | url link open in new tab | boolean [default: `false`] |
122-
| REVERSE_PROXY_PATH | reverse proxy path | string |
120+
| DB_FILE | full path to db file<em>³</em> | path string [default: standard path for buku] |
121+
| READONLY | read-only mode | boolean<em>¹</em> [default: `false`] |
122+
| DISABLE_FAVICON | disable bookmark [favicons](https://wikipedia.org/wiki/Favicon) | boolean<em>¹</em> [default: `true`] ([here's why](#why-favicons-are-disabled-by-default))|
123+
| OPEN_IN_NEW_TAB | url link open in new tab | boolean<em>¹</em> [default: `false`] |
124+
| REVERSE_PROXY_PATH | reverse proxy path<em>⁵</em> | string |
123125
| THEME | [GUI theme](https://bootswatch.com/3) | string [default: `default`] (`slate` is a good pick for dark mode) |
124-
| LOCALE | GUI language (partial support) | string [default: `en`] |
125-
| DEBUG | debug mode (verbose logging etc.) | boolean [default: `false`] |
126+
| LOCALE | GUI language<em>⁴</em> (partial support) | string [default: `en`] |
127+
| DEBUG | debug mode (verbose logging etc.) | boolean<em>¹</em> [default: `false`] |
128+
129+
_**¹**_ valid boolean values are `true`, `false`, `1`, `0` (case-insensitive).
126130

127-
Note: `BUKUSERVER_` is the common prefix (_every variable starts with it_).
131+
_**²**_ if input is invalid, the default value will be used if defined
128132

129-
Note: Valid boolean values are `true`, `false`, `1`, `0` (case-insensitive).
133+
_**³**_ `BUKUSERVER_DB_FILE` can be a DB name (plain filename without extension; cannot contain `.`). The specified DB with `.db` extension is located in default DB directory (which you can override with `BUKU_DEFAULT_DBDIR`).
130134

131-
Note: if input is invalid, the default value will be used if defined
135+
_**⁴**_ `BUKUSERVER_LOCALE` requires either `flask_babel` or `flask_babelex` installed
132136

133-
Note: `BUKUSERVER_DB_FILE` can be a DB name (plain filename without extension; cannot contain `.`). The specified DB with `.db` extension is located in default DB directory (which you can override with `BUKU_DEFAULT_DBDIR`).
137+
_**⁵**_ the value for `BUKUSERVER_REVERSE_PROXY_PATH` is recommended to include preceding slash and not have trailing slash (i.e. use `/foo` not `/foo/`)
134138

135-
Note: `BUKUSERVER_LOCALE` requires either `flask_babel` or `flask_babelex` installed
136139

137-
e.g. to set bukuserver to show 100 item per page run the following command
140+
#### How to specify environment variables
138141

142+
E.g. to set bukuserver to show 100 items per page run the following command:
139143
```
140144
# on linux
141145
$ export BUKUSERVER_PER_PAGE=100
@@ -145,11 +149,14 @@ $ SET BUKUSERVER_PER_PAGE=100
145149
146150
# in dockerfile
147151
ENV BUKUSERVER_PER_PAGE=100
152+
153+
# in env file
154+
BUKUSERVER_PER_PAGE=100
148155
```
149156

150-
Note: the value for BUKUSERVER_REVERSE_PROXY_PATH
151-
is recommended to include preceding slash and not have trailing slash
152-
(i.e. use `/foo` not `/foo/`)
157+
Note: an env file can be supplied either [by providing `--env-file` CLI argument](https://flask.palletsprojects.com/en/stable/cli/#environment-variables-from-dotenv) (requires `python-dotenv` installed),
158+
or as config for [the runner script](https://github.com/jarun/buku/wiki/Bukuserver-%28WebUI%29#runner-script).
159+
153160

154161
#### Why favicons are disabled by default
155162

@@ -169,68 +176,70 @@ It is important to note that favicon can potentially be exploited in this way.
169176

170177
### Screenshots
171178

179+
_**Note: more screenshots (to show off `default` & `slate` themes) can be found [on the respective project wiki page](https://github.com/jarun/buku/wiki/Bukuserver-%28WebUI%29)**_
180+
172181
<p><br></p>
173182
<p align="center">
174-
<a href="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/home-page.png?raw=true">
175-
<img src="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/home-page.png" alt="home page" width="650"/>
183+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/home-page.png?raw=true">
184+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/home-page.png" alt="home page" width="650"/>
176185
</a>
177186
</p>
178187
<p align="center"><i>home page</i></a></p>
179188

180189
<p><br><br></p>
181190
<p align="center">
182-
<a href="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/bookmark-stats.png?raw=true">
183-
<img src="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/bookmark-stats.png" alt="bookmark stats" width="650"/>
191+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/bookmark-stats.png?raw=true">
192+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/bookmark-stats.png" alt="bookmark stats" width="650"/>
184193
</a>
185194
</p>
186195
<p align="center"><i>bookmark stats</i></a></p>
187196

188197
<p><br><br></p>
189198
<p align="center">
190-
<a href="https://github.com/Buku-dev/docs/blob/v4.8/bukuserver/bookmark-page-with-favicon-enabled.png?raw=true">
191-
<img src="https://github.com/Buku-dev/docs/blob/v4.8/bukuserver/bookmark-page-with-favicon-enabled.png"
192-
alt="bookmark page with favicon enabled" width="650"/>
199+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/bookmark-page-with-favicon-enabled.png?raw=true">
200+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/bookmark-page-with-favicon-enabled.png"
201+
alt="bookmark page with favicon enabled and 'netloc-tag' URL render mode" width="650"/>
193202
</a>
194203
</p>
195-
<p align="center"><i>bookmark page <a href="#configuration">with favicon enabled</a></i></p>
204+
<p align="center"><i>bookmark page <a href="#configuration">with favicon enabled and 'netloc-tag' URL render mode</a></i></p>
196205

197206
<p><br><br></p>
198207
<p align="center">
199-
<a href="https://github.com/Buku-dev/docs/blob/v4.8a/bukuserver/bookmark-page-with-slate-theme-and-favicon-enabled.png">
200-
<img src="https://github.com/Buku-dev/docs/blob/v4.8a/bukuserver/bookmark-page-with-slate-theme-and-favicon-enabled.png"
208+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/bookmark-page-with-slate-theme-and-favicon-enabled.png?raw=true">
209+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/bookmark-page-with-slate-theme-and-favicon-enabled.png"
201210
alt="bookmark page with 'slate' theme and favicon enabled" width="650"/>
202211
</a>
203212
</p>
204-
<p align="center"><i>bookmark page with 'slate' theme and favicon enabled</i></a></p>
213+
<p align="center"><i>bookmark page with 'slate' theme, favicon enabled and 'netloc-tag' URL render mode</i></a></p>
205214

206215
<p><br><br></p>
207216
<p align="center">
208-
<a href="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/create-bookmark.png?raw=true">
209-
<img src="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/create-bookmark.png" alt="create bookmark" width="650"/>
217+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/create-bookmark.png?raw=true">
218+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/create-bookmark.png" alt="create bookmark" width="650"/>
210219
</a>
211220
</p>
212221
<p align="center"><i>create bookmark</i></a></p>
213222

214223
<p><br><br></p>
215224
<p align="center">
216-
<a href="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/edit-bookmark.png?raw=true">
217-
<img src="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/edit-bookmark.png" alt="edit bookmark" width="650"/>
225+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/edit-bookmark.png?raw=true">
226+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/edit-bookmark.png" alt="edit bookmark" width="650"/>
218227
</a>
219228
</p>
220229
<p align="center"><i>edit bookmark</i></a></p>
221230

222231
<p><br><br></p>
223232
<p align="center">
224-
<a href="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/view-bookmark-details.png?raw=true">
225-
<img src="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/view-bookmark-details.png" alt="view bookmark details" width="650"/>
233+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/view-bookmark-details.png?raw=true">
234+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/view-bookmark-details.png" alt="view bookmark details" width="650"/>
226235
</a>
227236
</p>
228237
<p align="center"><i>view bookmark details</i></a></p>
229238

230239
<p><br><br></p>
231240
<p align="center">
232-
<a href="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/tag-page.png?raw=true">
233-
<img src="https://github.com/Buku-dev/docs/blob/v4.7/bukuserver/tag-page.png" alt="tag page" width="650"/>
241+
<a href="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/tag-page.png?raw=true">
242+
<img src="https://github.com/Buku-dev/docs/blob/v4.9-bootstrap3/bukuserver/tag-page.png" alt="tag page" width="650"/>
234243
</a>
235244
</p>
236245
<p align="center"><i>tag page</i></a></p>

0 commit comments

Comments
 (0)