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

chg: doc: bukuserver readme to rst

Browse Source
This commit is contained in:
rachmadaniHaryono 2018-05-01 18:08:50 +08:00
parent b659a8bd02
commit eac5e81c07
2 changed files with 49 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
bukuserver/README.md
View File

@ -1,34 +0,0 @@
#### 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
```
$ 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
```
$ 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`
#### 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.

49
bukuserver/README.rst Normal file
View File

@ -0,0 +1,49 @@
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`
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.