Automate installation process;
Update document README; Thank you to LeXofLeviafan from the project jarun/buku.
This commit is contained in:
parent
30b3426dc7
commit
b5e28c8d11
3 changed files with 35 additions and 33 deletions
68
README.md
68
README.md
|
@ -1,33 +1,44 @@
|
|||
# Blasta - The agreeable and cordial civic bookmarking system.
|
||||
# Blasta - The agreeable and cordial civic annotation system.
|
||||
|
||||
Blasta is a collaborative bookmarks manager for organizing online content. It
|
||||
allows you to add links to your personal collection of links, to categorize them
|
||||
with keywords, and to share your collection not only among your own software,
|
||||
devices and machines, but also with others.
|
||||
Blasta is a collaborative bookmarks manager for organizing online content.
|
||||
|
||||
What makes Blasta a collaborative system is its ability to display to you the
|
||||
links that other people have collected, as well as showing you who else has
|
||||
bookmarked a specific link. You can also view the links collected by others, and
|
||||
subscribe to the links of people whose lists you deem to be interesting.
|
||||
It allows you to add links to your personal collection of links, to categorize
|
||||
them with keywords, and to share and synchronize your collection among your own
|
||||
software, devices, machines, and also with others.
|
||||
|
||||
The ability of Blasta to display to you the links that other people have
|
||||
collected and shared, as well as showing you who else has bookmarked a specific
|
||||
link is what makes Blasta a collaborative system.
|
||||
|
||||
You can also view the links collected by others, and subscribe to the links of
|
||||
people whose lists you deem to be interesting.
|
||||
|
||||
Blasta does not limit you to save links of certain types; you can save links of
|
||||
types adc, dweb, ed2k, feed, ftp, gemini, geo, gopher, http, ipfs, irc, magnet,
|
||||
mailto, monero, mms, news, sip, udp, xmpp and any scheme and type that you
|
||||
desire.
|
||||
|
||||
## Instances
|
||||
|
||||
* https://blasta.woodpeckersnest.eu
|
||||
|
||||
## Screenshots
|
||||
|
||||
[<img alt="browse view" src="blasta/screenshot/browse.png" width="200px"/>](blasta/screenshot/browse.png)
|
||||
[<img alt="tags view" src="blasta/screenshot/tag.png" width="200px"/>](blasta/screenshot/tag.png)
|
||||
|
||||
## Videos
|
||||
|
||||
* [Blasta - An XMPP PubSub Annotation Management System](https://video.xmpp-it.net/w/cfozoUeVLFbBFMCCSCJ1Dn) [06:38]
|
||||
|
||||
## Technicalities
|
||||
|
||||
Blasta is a federated bookmarking system which is based on XMPP and stores
|
||||
bookmarks on your own XMPP account; to achieve this task, Blasta utilizes the
|
||||
following XMPP specifications:
|
||||
|
||||
- [XEP-0163: Personal Eventing Protocol](https://xmpp.org/extensions/xep-0163.html)
|
||||
- [XEP-0060: Publish-Subscribe](https://xmpp.org/extensions/xep-0060.html)
|
||||
* [XEP-0163: Personal Eventing Protocol](https://xmpp.org/extensions/xep-0163.html)
|
||||
* [XEP-0060: Publish-Subscribe](https://xmpp.org/extensions/xep-0060.html)
|
||||
|
||||
Blasta operates as an XMPP client, and therefore, does not have a bookmarks
|
||||
system nor an account system, of its own.
|
||||
|
@ -40,21 +51,21 @@ The connection to the Blasta system is made with XMPP accounts.
|
|||
|
||||
## Features
|
||||
|
||||
- Private bookmarks;
|
||||
- Public bookmarks;
|
||||
- Read list;
|
||||
- Search;
|
||||
- Syndication;
|
||||
- Tags.
|
||||
* Private bookmarks;
|
||||
* Public bookmarks;
|
||||
* Read list;
|
||||
* Search;
|
||||
* Syndication;
|
||||
* Tags.
|
||||
|
||||
## Future features
|
||||
|
||||
- ActivityPub;
|
||||
- Federation;
|
||||
- Filters;
|
||||
- Pin;
|
||||
- Publish-Subscribe;
|
||||
- Report.
|
||||
* ActivityPub;
|
||||
* Federation;
|
||||
* Filters;
|
||||
* Pin;
|
||||
* Publish-Subscribe;
|
||||
* Report.
|
||||
|
||||
## Requirements
|
||||
|
||||
|
@ -103,22 +114,13 @@ $ pipx uninstall blasta
|
|||
$ pipx install git+https://git.xmpp-it.net/sch/Blasta
|
||||
```
|
||||
|
||||
### Configure
|
||||
|
||||
Copy files `blasta.sql` and `settings.toml` to `~/.config/blasta/`.
|
||||
|
||||
Copy directories `stylesheet`, `graphic`, `template`, and `script` to
|
||||
`~/.local/share/blasta/`.
|
||||
|
||||
Create directories `data`, `export`, `items` under `~/.cache/blasta/`.
|
||||
|
||||
### Start
|
||||
|
||||
```
|
||||
$ blasta
|
||||
```
|
||||
|
||||
Open URL http://localhost:8000 and connect with your Jabber ID.
|
||||
Open URL http://localhost:8000
|
||||
|
||||
## License
|
||||
|
||||
|
|
Loading…
Reference in a new issue