More updates
This commit is contained in:
parent
b76c3de021
commit
73c766b7e2
5 changed files with 7 additions and 7 deletions
|
|
@ -56,7 +56,7 @@ Regardless of how you want to run FediFetcher, you must first get an access toke
|
||||||
|
|
||||||
### 2) Configure and run FediFetcher
|
### 2) Configure and run FediFetcher
|
||||||
|
|
||||||
Once you have to your access token, there are multiple ways of running FediFetcher. These include, but aren't limited to:
|
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. These include, but aren't limited to:
|
||||||
|
|
||||||
1. [Running FediFetcher as a GitHub Action](./docs/github-actions.md)<br>
|
1. [Running FediFetcher as a GitHub Action](./docs/github-actions.md)<br>
|
||||||
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.
|
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.
|
||||||
|
|
@ -75,7 +75,7 @@ FediFetcher has quite a few configuration options, so here is my quick configura
|
||||||
|
|
||||||
> [!CAUTION]
|
> [!CAUTION]
|
||||||
>
|
>
|
||||||
> **Remove the `access-token` from the `config.json`** when running FediFetcher as GitHub Action. When running FediFetcher as GitHub Action **ALWAYS** [set the Access Token as an Action Secret](#to-run-fedifetcher-as-a-github-action).
|
> **Remove the `access-token` from the `config.json`** when running FediFetcher as GitHub Action. When running FediFetcher as GitHub Action **ALWAYS** [set the Access Token as an Action Secret](./docs/github-actions.md).
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,7 @@ If you configure FediFetcher this way, it'll fetch missing remote replies to the
|
||||||
|
|
||||||
## Providing configuration options
|
## Providing configuration options
|
||||||
|
|
||||||
Unless you are running FediFetcher as GitHub Action (please see above for instructions on configuring FediFetcher with GitHub Actions), there are a three ways in which you provide configuration options:
|
Unless you are running FediFetcher as [GitHub Action](../docs/github-actions.md), there are a three ways in which you provide configuration options:
|
||||||
|
|
||||||
1. Configuration File: <br>
|
1. Configuration File: <br>
|
||||||
You can provide a `json` file with configuration options. Then run the script like so: <br>`python find_posts.py -c=/path/to/config.json`
|
You can provide a `json` file with configuration options. Then run the script like so: <br>`python find_posts.py -c=/path/to/config.json`
|
||||||
|
|
@ -30,7 +30,6 @@ Unless you are running FediFetcher as GitHub Action (please see above for instru
|
||||||
You can supply your options as environment variables. To do so take the option name from the table below, replace `-` with `_` and prefix with `FF_`. For example `max-favourites` can be set via `FF_MAX_FAVOURITES`. (Environment variables are not case sensitive.)
|
You can supply your options as environment variables. To do so take the option name from the table below, replace `-` with `_` and prefix with `FF_`. For example `max-favourites` can be set via `FF_MAX_FAVOURITES`. (Environment variables are not case sensitive.)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Advanced Options
|
## Advanced Options
|
||||||
|
|
||||||
Below is a list of all configuration options, including their descriptions.
|
Below is a list of all configuration options, including their descriptions.
|
||||||
|
|
@ -69,7 +68,7 @@ Option | Required? | Notes |
|
||||||
|
|
||||||
If you wish to [run FediFetcher for multiple users on your instance](https://blog.thms.uk/2023/04/muli-user-support-for-fedifetcher?utm_source=github), you can supply the `access-token` as an array, with different access tokens for different users. That will allow you to fetch replies and/or backfill profiles for multiple users on your account.
|
If you wish to [run FediFetcher for multiple users on your instance](https://blog.thms.uk/2023/04/muli-user-support-for-fedifetcher?utm_source=github), you can supply the `access-token` as an array, with different access tokens for different users. That will allow you to fetch replies and/or backfill profiles for multiple users on your account.
|
||||||
|
|
||||||
This is only supported when running FediFetcher as cron job, or container. Multi-user support is not available when running FediFetcher as GitHub Action.
|
Multi-user support is not available when running FediFetcher as GitHub Action.
|
||||||
|
|
||||||
## Required Access Token Scopes
|
## Required Access Token Scopes
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Running FediFetcher as a cron job
|
# Running FediFetcher as a cron job
|
||||||
|
|
||||||
Running FediFetcher as a cron job is in many ways the best way of running FediFetcher if you already have a linux device somewhere. This could (but doesn't need to!) be a your mastodon server, or another device (such as a Raspberry Pi).
|
Running FediFetcher as a cron job is in many ways the best way of running FediFetcher if you already have a linux device somewhere. This could be a your mastodon server, or another device (such as a Raspberry Pi).
|
||||||
|
|
||||||
Tu run FediFetcher as a cron job:
|
Tu run FediFetcher as a cron job:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,8 +8,9 @@ To run FediFetcher as a GitHub ActionL
|
||||||
|
|
||||||
1. [Fork this repository](https://github.com/nanos/FediFetcher/fork)
|
1. [Fork this repository](https://github.com/nanos/FediFetcher/fork)
|
||||||
2. Add your [access token](../README.md#1-get-the-required-access-token) as a Secret:
|
2. Add your [access token](../README.md#1-get-the-required-access-token) as a Secret:
|
||||||
1. Go to Settings > Secrets and Variables > Actions
|
1. Within your newly created fork, go to Settings > Secrets and Variables > Actions
|
||||||
2. Click New Repository Secret
|
2. Click New Repository Secret
|
||||||
|

|
||||||
3. Supply the Name `ACCESS_TOKEN` and provide the Token generated above as Secret
|
3. Supply the Name `ACCESS_TOKEN` and provide the Token generated above as Secret
|
||||||
3. Create a file called `config.json` with your [configuration options](./config.md) in the repository root. **Do NOT include the Access Token in your `config.json`!**
|
3. Create a file called `config.json` with your [configuration options](./config.md) in the repository root. **Do NOT include the Access Token in your `config.json`!**
|
||||||
4. Finally go to the Actions tab and enable the action. The action should now automatically run approximately once every 10 min.
|
4. Finally go to the Actions tab and enable the action. The action should now automatically run approximately once every 10 min.
|
||||||
|
|
|
||||||
BIN
docs/image.png
Normal file
BIN
docs/image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 349 KiB |
Loading…
Reference in a new issue