Friendica/fediverse-archiving-tools
1
0
Fork 0
mirror of https://gitlab.com/mysocialportal/fediverse-archiving-tools.git synced 2024-10-18 08:53:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add binaries and dev setup instructions

Browse source
This commit is contained in:
Hank Grabowski 2022-01-15 10:35:30 -05:00
parent ff0c0cad72
commit b106445b3b
1 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -2,6 +2,23 @@
A simple command line tool for archiving your Friendica profile via the Friendica API.
## Installation
There are pre-compiled binaries for the tools for Linux, Mac, and Windows below. You can download
those and use them. Simply download for your respective platform, unzip, and then run.
* [Windows x64](https://mysocialportal-friendica-archiving.sfo3.digitaloceanspaces.com/releases/1.0.0/friendica_archiver_win_x64.zip)
* [macOS x64](https://mysocialportal-friendica-archiving.sfo3.digitaloceanspaces.com/releases/1.0.0/friendica_archiver_macos_x64.zip)
* [Linux x64](https://mysocialportal-friendica-archiving.sfo3.digitaloceanspaces.com/releases/1.0.0/friendica_archiver_linux_x64.zip)
Or you can run it directly from this directory using standard Dart commands:
```bash
git clone git@gitlab.com:mysocialportal/friendica-archiving-tools.git
cd friendica-archiving-tools
dart pub get
dart bin/friendica_archiver.dart
```
## Usage
The tool only supports username and password credentials workflow. The arguments to run are:
@ -36,7 +53,7 @@ from scratch.
Minimum arguments to start processing the archive from scratch:
```bash
dart bin/friendica_archiver.dart --username user1 --server-name myfriendicaserver.com --archive-folder ~/Downloads/FriendicaArchive
./friendica_archiver --username user1 --server-name myfriendicaserver.com --archive-folder ~/Downloads/FriendicaArchive
```
In this case the Password prompt will come up nad you type in your profile.
@ -46,7 +63,7 @@ be displayed on the screen.
Minimum arguments to start processing the archive with password in file:
```bash
dart bin/friendica_archiver.dart --username user1 --server-name myfriendicaserver.com --archive-folder ~/Downloads/FriendicaArchive < ~/friendica_password.txt
./friendica_archiver --username user1 --server-name myfriendicaserver.com --archive-folder ~/Downloads/FriendicaArchive < ~/friendica_password.txt
```
In this case if your password is `123456789` (and please change your password if that is your actual password),
@ -62,5 +79,5 @@ As the archival unfolds it lists which pages it outputs status about which page
It is therefore possible to restart archiving at a certain page:
```bash
dart bin/friendica_archiver.dart --username user1 --server-name myfriendicaserver.com --archive-folder ~/Downloads/FriendicaArchive --resume-page 2 --max-post-requests 3 --items-per-page 5 < ~/friendica_password.txt
./friendica_archiver --username user1 --server-name myfriendicaserver.com --archive-folder ~/Downloads/FriendicaArchive --resume-page 2 --max-post-requests 3 --items-per-page 5 < ~/friendica_password.txt
```