From rust to markdown
This commit is contained in:
Arun Prakash Jana
parent
279219db1f
commit
a481e9c055
64
bukuserver/README.md
Normal file
64
bukuserver/README.md
Normal file
@ -0,0 +1,64 @@
|
||||
## Bukuserver
|
||||
|
||||
### Table of Contents
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Installing dependencies](#installing-dependencies)
|
||||
- [Installing from PyPi](#installing-from-pypi)
|
||||
- [Webserver options](#webserver-options)
|
||||
- [Configuration](#configuration)
|
||||
|
||||
### Installation
|
||||
|
||||
You need to have some packages before you install `bukuserver` on your server.
|
||||
So be sure to have `python3`, `python3-pip` , `python3-dev`, `libffi-dev` packages from your distribution.
|
||||
|
||||
#### Installing dependencies
|
||||
|
||||
```
|
||||
$ python3 -m pip install --user --upgrade pip
|
||||
$ python3 -m pip install --user virtualenv
|
||||
$ python3 -m virtualenv env
|
||||
$ source env/bin/activate
|
||||
$ git clone https://github.com/jarun/Buku
|
||||
$ cd Buku
|
||||
$ pip3 install .[server]
|
||||
```
|
||||
|
||||
#### Installing from PyPi
|
||||
|
||||
$ pip3 install buku[server]
|
||||
|
||||
### Webserver options
|
||||
|
||||
To run the server on host 127.0.0.1, port 5001, run following command:
|
||||
|
||||
$ 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`
|
||||
|
||||
### Configuration
|
||||
|
||||
Following are available os env config available for bukuserver.
|
||||
|
||||
| Name (without prefix) and description | Value |
|
||||
| --- | --- |
|
||||
| PER_PAGE (bookmarks per page) | positive integer [default: 10] |
|
||||
| SECRET_KEY (server secret key) | string [default: os.urandom(24)] |
|
||||
| URL_RENDER_MODE (url render mode) | `full` or `netloc` [default: `full`] |
|
||||
|
||||
Note: `BUKUSERVER_` is the common prefix.
|
||||
|
||||
Note: if input is invalid, the default value will be used
|
||||
|
||||
e.g. to set bukuserver to show 100 item per page run the following command
|
||||
|
||||
```
|
||||
# on linux
|
||||
$ export BUKUSERVER_PER_PAGE=100
|
||||
|
||||
# on windows
|
||||
$ SET BUKUSERVER_PER_PAGE=100
|
||||
```
|
||||
@ -1,84 +0,0 @@
|
||||
Bukuserver
|
||||
==========
|
||||
|
||||
Install server
|
||||
--------------
|
||||
|
||||
You need to have some packages before you install `bukuserver` on your server.
|
||||
So be sure to have `python3`, `python3-pip` , `python3-dev`, `libffi-dev` packages from your distribution.
|
||||
|
||||
Installing PIP, virtualenv and dependencies
|
||||
-------------------------------------------
|
||||
|
||||
.. code:: shell
|
||||
|
||||
$ python3 -m pip install --user --upgrade pip
|
||||
$ python3 -m pip install --user virtualenv
|
||||
$ python3 -m virtualenv env
|
||||
$ source env/bin/activate
|
||||
$ git clone https://github.com/jarun/Buku
|
||||
$ cd Buku
|
||||
$ pip3 install .[server]
|
||||
|
||||
Installing buku and bukuserver from PIP
|
||||
---------------------------------------
|
||||
|
||||
.. code:: shell
|
||||
|
||||
$ pip3 install buku[server]
|
||||
|
||||
Webserver options
|
||||
-----------------
|
||||
|
||||
To run the server on host 127.0.0.1, port 5001, run following command:
|
||||
|
||||
.. code:: shell
|
||||
|
||||
$ 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`
|
||||
|
||||
Webserver Env config
|
||||
--------------------
|
||||
|
||||
Following are available os env config available for bukuserver.
|
||||
|
||||
+-----------------------+------------------------------------+
|
||||
| Name (without prefix) | Value and description |
|
||||
+-----------------------+------------------------------------+
|
||||
| PER_PAGE | v: [:code:`10`]/(positive integer) |
|
||||
| | |
|
||||
| | Bookmark entry per page. |
|
||||
+-----------------------+------------------------------------+
|
||||
| SECRET_KEY | v: [(os.urandom(24))]/(string) |
|
||||
| | |
|
||||
| | Server secret key. |
|
||||
+-----------------------+------------------------------------+
|
||||
| URL_RENDER_MODE | v: [:code:`full`]/:code:`netloc` |
|
||||
| | |
|
||||
| | Url render mode. |
|
||||
+-----------------------+------------------------------------+
|
||||
|
||||
Note: If any invalid input given, default value will be used
|
||||
|
||||
Note: to use it add `BUKUSERVER_` as prefix.
|
||||
|
||||
ie to set bukuserver to show 100 item per page run the following command
|
||||
|
||||
.. code::
|
||||
|
||||
# on linux
|
||||
$ export BUKUSERVER_PER_PAGE=100
|
||||
|
||||
# on windows
|
||||
$ SET BUKUSERVER_PER_PAGE=100
|
||||
|
||||
CAUTION
|
||||
-------
|
||||
|
||||
This snapshot of web APIs is indicative.
|
||||
The program APIs are bound to change and if you need these,
|
||||
you may have to adapt the APIs to the current signature/return type etc.
|
||||
We are NOT actively updating these whenever an API changes in the main program.
|
||||
Loading…
Reference in New Issue
Block a user