Skip to content

Haskell Implementation of the Freenet Client Protocol (FCP)

License

Notifications You must be signed in to change notification settings

waldheinz/h-fcp

Repository files navigation

H - FCP

This is a Haskell library allowing to talk to Freenet nodes using the Freenet Client Protocol (FCP), version 2. It contains the library itself, exporting the Network.FCP module, and some command line utilities using the library.

Munin Plugin

A Munin plugin is provided, which allows to monitor the status of a running node. The plugin is capable of generating multiple graphs. As it's quite common for Munin plugins, the name of the executable decides which graph it generates. Currently, the following names are available:

fn_bandwidth        -> Bandwidth Usage
fn_bw_limit_delay   -> Bandwidth Limit Delays
fn_cache_access_chk -> CHK Cache Access Rates
fn_fetch_count      -> Fetch Count
fn_fetch_success    -> Fetch Success
fn_opennet_size     -> Opennet Size Estimate
fn_remotes          -> Remote Transfers
fn_store_access_chk -> CHK Store Access Rates
fn_store_success    -> Store Lookup Success
fn_threads          -> Thread Count

To generate a graph, just symlink the executable under the desired name to your Munin plugins directory (usually /etc/munin/plugins).

By default, the plugin tries to talk to the Freenet host at localhost, port 9481. If you want to talk to another Node, this can be configured by specifying a section like

[fn_*]
env.host = example.com
env.port = 1234

in your Munin node config file (usually under /etc/munin/plugin-conf.d/).

HSite

Allows to insert and maintain Freesites. There is a separate readme in the subdirectory for that program.

Installation

If you don't already have a Haskell development environment set up, I'd remommend just installing the Haskell Platform. Then just clone the repository and do a cabal configure && cabal build. If all goes well, the executable(s) will be located under the newly created dist directory.

About

Haskell Implementation of the Freenet Client Protocol (FCP)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published