++ubookmark infos

This commit is contained in:
Nico Schottelius 2020-04-25 21:25:00 +02:00
parent 1ad03e2f78
commit 0feaaf5a01

View file

@ -5,9 +5,25 @@ ubookmark is a simple link collecting website.
---
content:
ubookmark uses LDAP authentication. It was written and designed for
## Introduction
ubookmark is based on Django, Bootstrap 4
and uses LDAP authentication. It was written and designed for
running [IPv6.blog](https://IPv6.blog), but should be re-usable in
other situations.
ubookmark is FOSS and its source code can be found on
[code.ungleich.ch](https://code.ungleich.ch/ungleich-public/ubookmark/).
## How to install
* git clone above repository
* Setup a local postgresql database named "ubookmark"
* Copy ubookmark/sample_settings.py to ubookmark/local_settings.py
* Modify settings as needed
* Install requirements using `pip install -r requirements.txt`
## How to run
It is a standard Django app, so you can use uwsgi
or the included server for testing: `python manage.py runserver`.