README.md 1.69 KB
Newer Older
1
2
3
4
5
6
WEnotes
====

WEnotes consists of several parts:

* harvesting tools for:
7
    * ASKBOT (special RSS feed) (defunct)
8
    * blogs (db table of RSS feeds)
9
10
    * g+ (defunct)
    * [GroupServer](http://groupserver.org/) mailing lists (special RSS feed) (defunct)
11
12
13
    * identica (defunct)
    * Moodle instances (special RSS feed)
    * Twitter
14
15
    * various Mastodon instances
    * various Discourse instances
16

17
* a Mediawiki extension
18
19
    * verifies user is logged in
    * saves local post
20
21
22
23
24

* Mediawiki Widget for collecting local microblog postings

* Mediawiki Widget for displaying an integrated display of all notes

25
26
27
28
29
30

WEnotes harvests posts from a variety of sources and aggregates them
in a [CouchDB](http://couchdb.apache.org/) instance. Some sources are
streamed in near real time and others are polled periodically.  A
[Faye](http://faye.jcoglan.com/) publish-subscribe messaging system
posts the messages to interested clients.
Jim Tittsler's avatar
Jim Tittsler committed
31

Dave Lane's avatar
Dave Lane committed
32
33
34
35
36
37
38
39
40
This repository includes the client side tools for displaying and
capturing notes. Check the
[WEnotes-tools](https://git.oeru.org/oeru/wenotes-tools/)
repository for the harvesting tools. Also see [WEnotes-server](https://git.oeru.org/oeru/wenotes-server)
for the stack of tools which manages the distribution of the aggregated feeds.
If you want to host your own instance of this, we encourage you to use our [Docker Compose
hosting configuration](https://git.oeru.org/oeru/wenotes-docker)


41
42
43
44
45
Notes:

* to clone this archive, you must (after the initial clone) run
    git submodule init
    git submodule update
46
* ensure you install the set of Node JS dependencies by running `npm install` in this directory, which will install the libraries (and their dependencies) listed in package.json