feedlynx 0.1.0-pre.2

TODO
Documentation

Feedlynx manages an Atom feed on disk. Each time a request to add a link is received the page at the URL is fetched to determine a title and description. This information is then used to add a new entry to the feed. If the link is from YouTube then an embed for the video is generated.

Install

From Source

See Build From Source below.

Usage

feedlynx path/to/feed.xml

Feedlynx requires two environment variables to be set:

  • FEEDLYNX_PRIVATE_TOKEN used to authenticate requests to add a new link.
  • FEEDLYNX_FEED_TOKEN used in the path to the generated feed.

Both of these tokens must be at least 32 characters long and hard to guess. Suitable values can be generated with feedlynx gen-token, which will print a randomly generated token.

The following environment variables may optionally be set:

  • FEEDLYNX_ADDRESS —- the address to serve on, default 127.0.0.1.
  • FEEDLYNX_PORT —- the port to serve on, default 8001.
  • FEEDLYNX_LOG — controls the log level and filtering.

Run feedlynx with the path to the feed file to start the server. If the file does not exist it will be created. When the server starts the path on the server for the feed is printed. This is what you would use to subscribe to the feed in your feed reader.

Example

FEEDLYNX_PRIVATE_TOKEN=ExampleExampleExampleExample1234 \
FEEDLYNX_FEED_TOKEN=FeedFeedFeedFeedFeedFeedFeedFeed \
feedlynx feed.xml
[2024-06-24T08:52:11Z INFO  feedlynx] HTTP server running on: http://127.0.0.1:8001
[2024-06-24T08:52:11Z INFO  feedlynx::server] feed available at /feed/FeedFeedFeedFeedFeedFeedFeedFeed

If this instance of Feedlynx was hosted at example.com the URL of the feed would be https://example.com/feed/FeedFeedFeedFeedFeedFeedFeedFeed.

In a Windows PowerShell terminal the above example would look something like this:

powershell -Command { $env:FEEDLYNX_PRIVATE_TOKEN="ExampleExampleExampleExample1234"; $env:FEEDLYNX_FEED_TOKEN="FeedFeedFeedFeedFeedFeedFeedFeed"; feedlynx.exe feed.xml }

Logging

Logging is controlled with the FEEDLYNX_LOG environment variable. The log levels from least verbose to most verbose are:

  • off (no logs)
  • error
  • warn
  • info
  • debug
  • trace

The default log level is info. To change the log level to debug use FEEDLYNX_LOG=debug. The FEEDLYNX_LOG variable also supports filtering. For example to only show trace messages from feedlynx (and not some of the libraries it uses) you would specify: FEEDLYNX_LOG=trace=feedlynx. For more details refer to the env_logger documentation.

At the debug level Feedlynx will print a web-server styled line for each request received.

[2024-06-24T07:48:39Z DEBUG feedlynx::server] 127.0.0.1:50202 "GET /feed/FeedFeedFeedFeedFeedFeedFeedFeed" 200 "curl/8.8.0"

This includes the remote address, request method and path, response status code, and client user agent.

API

The server exposes three end-points:

  • GET / — shows a brief page about the Feedlynx server.
  • POST /add — add a new link. Requires a body in application/x-www-form-urlencoded (web form) format. Fields:
    • url (required) — the link to add.
    • token (required) — the value of FEEDLYNX_PRIVATE_TOKEN.
    • title (optional) — the title of the link.
  • GET /feed/<FEEDLYNX_FEED_TOKEN> — the generated feed. Use this to subscribe to the feed in your feed reader.

cURL Example

The following cURL command will add https://github.com/wezm/feedlynx to the Feedlynx feed:

curl -d 'url=https://github.com/wezm/feedlynx' \
     -d 'token=ExampleExampleExampleExample1234' \
     http://localhost:8001/add

Build from Source

Minimum Supported Rust Version: 1.72.1

Feedlynx is implemented in Rust. See the Rust website for instructions on installing the toolchain.

From Git Checkout or Release Tarball

Build the binary with:

cargo build --release --locked

The binary will be in target/release/feedlynx.

From crates.io

cargo install feedlynx

Compile-time Options (Cargo Features)

Feedlynx supports the following compile-time options:

  • rust-tls (default): use the rust-tls crate for handling TLS connections.
  • native-tls: use the native-tls crate for handling TLS connections. This might be a better option when building on Windows.

To build with native-tls invoke Cargo as follows:

cargo build --release --locked --no-default-features --features native-tls

If packaging Feedlynx for an operating system registry it might make sense to use native-tls. On Linux and BSD systems that adds a dependency on OpenSSL.

Credits

Feedlynx incorporates code from the following projects under the terms of the Apache 2.0 licence:

The adorable Feedlynx logo was drawn by @DiDoesDigital.

Licence

This project is dual licenced under either of:

at your option.