Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.72 KB

README.md

File metadata and controls

70 lines (43 loc) · 2.72 KB
Raw

f2ap

f2ap (Feed to ActivityPub) is a web application that uses the RSS/Atom feed of your website to expose it on the Fediverse through ActivityPub.

Social platform compatibility

Even though ActivityPub is a generic protocol designed to be platform-agnostic, each social platform has its own particularities that f2ap has to comply with to be able to communicate with it.

Check the compatibility table on the wiki to see the progression.

How to use it

Prerequisite

The only prerequisite to use f2ap is that your website provides an RSS or Atom feed. If you don't have one yet, you might want to make it first, as it is a Web standard that allows your visitors to stay in touch with your content with any compatible application. Plus, it is very easy to implement.

Installation

With PyPI

Required: Python 3.9+

Install the f2ap package:

pip install f2ap

The application will be runnable with the f2ap command. You will need to use a runner like systemd to start it as a service.

Docker

Required: Docker

Grab the image from Docker Hub:

docker pull deuchnord/f2ap

You can get a specific version with the following syntax: deuchnord/f2ap:<tag>, where tag is one of the following (i, j and k being numbers):

  • latest: the last version (default)
  • i: the last version of the i major version
  • i.j: the last version of the i.j minor version
  • i.j.k: the version i.j.k
  • unstable: the last commit in the Git history. It is heavily discouraged to use it in production, as it can have bugs, crash, put fire in your house or, worse, kill your kitten.
Docker-Compose

If you want to use f2ap through Docker-Compose, check the docker-compose.dist.yml for an example of configuration.

Configuration

To make f2ap work, you will need to write a configuration file that will define its behavior. It is a boring simple TOML file. You can find a self-documented file in config.dist.toml. If you run f2ap with Docker, make sure to name it config.toml and to place it in the /data folder.

Configuring the server

See the dedicated page on the wiki.

Limitations

Because f2ap uses your RSS/Atom feed to connect your website to ActivityPub, the time before a new entry pops on the Fediverse will depend on the refresh frequency. You might want to choose a frequency that matches your update regularity.

If this behavior is a problem, f2ap is probably not the right solution for you, and you might need to integrate ActivityPub to your application on your own.