pjht/buku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document webserver

Browse Source
This commit is contained in:
Arun Prakash Jana 2018-04-21 11:32:28 +05:30
parent d9b2fac365
commit c0789e97dc
No known key found for this signature in database
GPG Key ID: A75979F35C080412
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -29,6 +29,8 @@
`buku` fetches the title of a bookmarked url and stores it along with any user-provided comments and tags. You can use your favourite editor to compose and update bookmarks. With multiple search options, including regex and a deep scan mode (particularly for URLs), it can find any bookmark instantly. Multiple search results can be opened in the browser at once. There's an Easter egg to revisit random forgotten bookmarks too! `buku` fetches the title of a bookmarked url and stores it along with any user-provided comments and tags. You can use your favourite editor to compose and update bookmarks. With multiple search options, including regex and a deep scan mode (particularly for URLs), it can find any bookmark instantly. Multiple search results can be opened in the browser at once. There's an Easter egg to revisit random forgotten bookmarks too!
Deployment on a server is also possible, thanks to [bukuserver](https://github.com/jarun/Buku/tree/master/bukuserver), the webserver interface that exposes several features.
For GUI and browser integration (or to sync bookmarks with your favourite bookmark management service), refer to the wiki page on [System integration](https://github.com/jarun/Buku/wiki/System-integration). If you prefer the terminal, the [shell completion](#shell-completion) scripts can be handy. For GUI and browser integration (or to sync bookmarks with your favourite bookmark management service), refer to the wiki page on [System integration](https://github.com/jarun/Buku/wiki/System-integration). If you prefer the terminal, the [shell completion](#shell-completion) scripts can be handy.
We have one of the best documentation around. You can start with the [Examples](#examples). *Buku* is too busy to track you - no hidden history, obsolete records, usage analytics or homing. For more details, please refer to the wiki page on [operational notes](https://github.com/jarun/Buku/wiki/Operational-notes). We have one of the best documentation around. You can start with the [Examples](#examples). *Buku* is too busy to track you - no hidden history, obsolete records, usage analytics or homing. For more details, please refer to the wiki page on [operational notes](https://github.com/jarun/Buku/wiki/Operational-notes).

10
bukuserver/README.md
View File

@ -6,18 +6,20 @@ $ python3 -m pip install --user --upgrade pip
$ python3 -m pip install --user virtualenv $ python3 -m pip install --user virtualenv
$ python3 -m virtualenv env $ python3 -m virtualenv env
$ source env/bin/activate $ source env/bin/activate
$ pip install -e .[server] $ pip3 install -e .[server]
``` ```
#### Installing buku and bukuserver from PIP #### Installing buku and bukuserver from PIP
``` ```
$ pip install -e buku[server] $ pip3 install -e buku
$ pip3 install -e bukuserver
``` ```
#### Webserver options #### Webserver options
Your bookmark on buku can be accesed through browser. To run the server on host 0.0.0.1 on port 5001, run following command: To run the server on host 127.0.0.1, port 5001, run following command:
$ bukuserver run --host 0.0.0.1 --port 5001 $ bukuserver run --host 127.0.0.1 --port 5001
Visit `127.0.0.1:5001` in your browser to access your bookmarks.
See more option on `bukuserver run --help` and `bukuserver --help` See more option on `bukuserver run --help` and `bukuserver --help`