pjht/buku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
554f86ea4c
buku/bukuserver
History
tom-i 64972a9ed3 Added install paragraph (#264) 
* Added install paragraph

* Removed enviroment

* chg: doc: installation
2018-04-20 21:33:03 +05:30
..
templates/bukuserver new: dev: editing bookmark 2018-04-06 15:07:34 +08:00
__init__.py chg: dev: rename api folder to bukuserver 2018-04-06 15:07:33 +08:00
__main__.py chg: dev: review request 2018-04-06 15:07:34 +08:00
forms.py chg: dev: remove unused EditBookmarksForm 2018-04-06 15:07:34 +08:00
README.md Added install paragraph (#264) 2018-04-20 21:33:03 +05:30
requirements.txt chg: dev: rename api folder to bukuserver 2018-04-06 15:07:33 +08:00
response.py chg: dev: rename api folder to bukuserver 2018-04-06 15:07:33 +08:00
server.py chg: dev: pass travis 2018-04-06 15:07:34 +08:00

README.md

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.