Home

This documentation outlines how to run and configure FediFetcher:

1. Regardless of how you want to run FediFetcher, you must first get an access token:
   Getting an Access Token for FediFetcher

2. Once you have to your access token, there are multiple ways of running FediFetcher. None of these require you to have CLI/SSH access to your mastodon server. Pick one of the following options:
   

   • Running FediFetcher as a GitHub Action
     Ideal if you don't have your own hardware, and/or have little experience running servers. This is all point and click within GitHub's interface.
   • Running FediFetcher as a cron job
     Ideal if you already have a linux device, and want to simply run FediFetcher on there.
   • Running FediFetcher from a container
     Ideal if you are familiar with containers.
   • Running FediFetcher as a systemd timer
     Ideal if you have a linux device somewhere, but don't like cron jobs.
   • Running FediFetcher as a Scheduled Task in Windows
     Ideal if you are a Windows User and your main device is (almost) always running.

3. Configure FediFetcher:
   FediFetcher has quite a few configuration options, so here is my quick configuration advice, that should probably work for most people:
   

   {
     "access-token": "Your access token. REMOVE THIS IF YOU ARE RUNNING FEDIFETCHER AS GITHUB ACTION!",
     "server": "your.mastodon.server",
     "home-timeline-length": 200,
     "max-followings": 80,
     "from-notifications": 1
   }

   To find all available configuration options, read FediFetcher configuration options

4. It's really important you keep FediFetcher up to date. Please check the Updating FediFetcher documentation, for details on how to be notified of new releases, and how to install updates.

5. Want to contribute? Amazing! Have a look at Contribute To FediFetcher