Firehose for the federated social web
You'll need four things to get started:
You need clone the git repository:
git clone https://github.com/e14n/ofirehose.git
And install the dependencies using npm
:
cd ofirehose
npm install
OFirehose uses databank. Any databank driver should work.
couchbase
, mongodb
and redis
are probably the best
bets for production servers, but the disk
or even memory
drivers
can work for testing.
If you're confused, just use the MongoDB one, databank-mongodb.
You can find other drivers like so:
npm search databank
You can install in the ofirehose
directory as a normal dependency.
For example, the databank driver for MongoDB:
npm install databank-mongodb
Note that you also need to install and configure your database server. For example, in Debian derivatives:
apt-get install mongodb
OFirehose requires a configuration file located in /etc/ofirehose.json
or ~/.ofirehose.json
; either of the two options are fine. You can also specify a different config file with -c
.
In addition to JSON configuration files, you can also pass these options directly on the commandline, as well as via environment variables prefixed with OFIREHOSE_
.
memory
; not recommended for production.null
.null
.443
when key is set or 80
otherwise. Change this if you've got some kind of load-balancer.Copyright 2012-2014 E14N https://e14n.com/
Copyright 2017 AJ Jordan alex@strugee.net, Camilo QS vxcamiloxv@disroot.org
OFirehose is licensed under the Apache License Version 2.0. See the LICENSE file for the full license text.