buku/bukuserver/README.md
tom-i 64972a9ed3 Added install paragraph (#264)
* Added install paragraph

* Removed enviroment

* chg: doc: installation
2018-04-20 21:33:03 +05:30

28 lines
1.0 KiB
Markdown

#### 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
$ pip install -e .[server]
```
#### Installing buku and bukuserver from PIP
```
$ pip install -e buku[server]
```
#### 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:
$ bukuserver run --host 0.0.0.1 --port 5001
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.