mirror of
https://github.com/bellingcat/auto-archiver.git
synced 2026-06-12 21:28:29 +03:00
Finish how to on authentication
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# Upgrading to 0.13 Configuration Format
|
||||
# Upgrading to v0.13
|
||||
|
||||
```{note} This how-to is only relevant for people who used Auto Archiver before February 2025 (versions prior to 0.13).
|
||||
|
||||
@@ -11,13 +11,16 @@ Version 0.13 of Auto Archiver has breaking changes in the configuration format,
|
||||
|
||||
There are two simple ways to check if you need to update your format:
|
||||
|
||||
1. When you try and run auto-archiver using your existing configuration file, you get an error like the following:
|
||||
1. When you try and run auto-archiver using your existing configuration file, you get an error about no feeders or formatters being configured, like:
|
||||
|
||||
```AssertionError: No feeders were configured. Make sure to set at least one feeder in your configuration file or on the command line (using --feeders)
|
||||
```{code} console
|
||||
AssertionError: No feeders were configured. Make sure to set at least one feeder in
|
||||
your configuration file or on the command line (using --feeders)
|
||||
```
|
||||
|
||||
2. Within your configuration file, you have a `feeder:` option. This is the old format. An example old format:
|
||||
```{yaml}
|
||||
```{code} yaml
|
||||
|
||||
steps:
|
||||
feeder: gsheet_feeder
|
||||
...
|
||||
@@ -31,12 +34,12 @@ To update your configuration file, you can either:
|
||||
|
||||
This is recommended if you want to keep all your old settings. Follow the steps below to change the relevant settings:
|
||||
|
||||
1. Feeder & Formatter Steps Settings
|
||||
#### a) Feeder & Formatter Steps Settings
|
||||
|
||||
The feeder and formatter settings have been changed from a single string to a list.
|
||||
|
||||
`steps.feeder (string)` → `steps.feeders (list)`
|
||||
`steps.formatter (string)` → `steps.formatters (list)`
|
||||
- `steps.feeder (string)` → `steps.feeders (list)`
|
||||
- `steps.formatter (string)` → `steps.formatters (list)`
|
||||
|
||||
Example:
|
||||
```{yaml}
|
||||
@@ -58,17 +61,18 @@ steps:
|
||||
```{note} Auto Archiver still only supports one feeder and formatter, but from v0.13 onwards they must be added to the configuration file as a list.
|
||||
```
|
||||
|
||||
2. Extractor (formerly Archiver) Steps Settings
|
||||
#### b) Extractor (formerly Archiver) Steps Settings
|
||||
|
||||
With v0.13 of Auto Archiver, the `archivers` have been renamed to `extractors` to reflect the work they actually do - extract information from a URL. Change the configuration by renaming:
|
||||
|
||||
`steps.archivers` → `steps.extractors`
|
||||
- `steps.archivers` → `steps.extractors`
|
||||
|
||||
The names of the actual modules have also changed, so for any extractor modules you have enabled, you will need to rename the `archiver` part to `extractor`. Some examples:
|
||||
|
||||
`telethon_archiver` → `telethon_extractor`
|
||||
`wacz_archiver_enricher` → `wacz_extractor_enricher`
|
||||
`vk_archiver` → `vk_extractor`
|
||||
- `telethon_archiver` → `telethon_extractor`
|
||||
- `wacz_archiver_enricher` → `wacz_extractor_enricher`
|
||||
- `wayback_archiver_enricher` → `wayback_extractor_enricher`
|
||||
- `vk_archiver` → `vk_extractor`
|
||||
|
||||
Additionally, the `youtube_archiver` has been renamed to `generic_extractor` and should be considere the default/fallback extractor. Read more about the [generic extractor](../modules/autogen/extractor/generic_extractor.md).
|
||||
|
||||
@@ -91,16 +95,13 @@ steps:
|
||||
|
||||
```
|
||||
|
||||
3. Redundant / Obsolete Modules
|
||||
#### c) Redundant / Obsolete Modules
|
||||
|
||||
With v0.13 of Auto Archiver, the following modules have been removed and their features have been built in to the generic_extractor:
|
||||
With v0.13 of Auto Archiver, the following modules have been removed and their features have been built in to the generic_extractor. You should remove them from the 'steps' section of your configuration file:
|
||||
|
||||
* `twitter_archiver` - use the `generic_extractor` for general extraction, or the `twitter_api_extractor` for API access.
|
||||
* `tiktok_archiver` - use the `generic_extractor` to extract TikTok videos.
|
||||
|
||||
If you have either of these set in your configuration under `steps:` you should remove them.
|
||||
|
||||
|
||||
|
||||
### 2. Auto-generate a new config, then copy over your settings.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user