https://github.com/piger/qstode
A web based bookmarks archive [UNMAINTAINED]
https://github.com/piger/qstode
bookmarks-manager python self-hosted webapp
Last synced: about 1 year ago
JSON representation
A web based bookmarks archive [UNMAINTAINED]
- Host: GitHub
- URL: https://github.com/piger/qstode
- Owner: piger
- License: other
- Created: 2013-10-27T16:23:41.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2021-11-15T21:29:37.000Z (over 4 years ago)
- Last Synced: 2025-04-14T21:24:48.867Z (about 1 year ago)
- Topics: bookmarks-manager, python, self-hosted, webapp
- Language: Python
- Homepage:
- Size: 767 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# QStode
[](https://travis-ci.org/piger/qstode)
QStode is a web application that allows registered users to store bookmarks
(like the good old del.icio.us) categorized by tags.
At the moment social functions (for example the subscription to other users
bookmark feed) are missing.
## Project status
**THIS PROJECT IS UNMAINTAINED**
QStode is mostly usable (read: it's **beta**) even if it still lacks
some features and many things could be improved.
Things to note:
- the search engine feature is still experimental mostly because it
should really use a task queue (i.e. Celery) to handle all the write
operations on the index; at the moment I'm using Whoosh
`AsyncWriter` that relies on threads and is not suitable for high
work loads.
- a MySQL database is suggested; PostgreSQL support is experimental/incomplete.
## Documentation
Documentation is available on [ReadTheDocs][rtd].
[rtd]: http://qstode.readthedocs.org/en/latest/index.html
## Requirements
- Python 3.x
- a WSGI server: gunicorn, uwsgi, etc.
- a web server with reverse proxy support
The suggested setup involves the use of a *virtual environment* created with
`virtualenv`.
NOTE: You can also run QStode with the built in http server, but it's not suitable for the open internet!
## Docker
A sample `docker-compose.yml` file is provided as a starting point to run your own instance in
development mode.
To start QStode run:
``` shell
docker-compose up --build
```
To setup the database and create the _admin_ user, run:
``` shell
docker-compose run qstode setup
```
To shutdown the containers run:
``` powershell
docker-compose down
```
Or run `docker-compose down -v` to also delete the MySQL data container.
## Author(s)
QStode is written and maintained by Daniel Kertesz .
## License
- all (python, js) code is BSD licensed, see LICENSE file.
- all HTML and CSS code is licensed under cc-by-nc, see:
http://creativecommons.org/licenses/by-nc/3.0/