diff options
| author | 2025-01-04 18:55:48 +0100 | |
|---|---|---|
| committer | 2025-01-04 18:55:48 +0100 | |
| commit | d1a850acdd75c190df2aae9552882ef06b04e70a (patch) | |
| tree | 13290c250a88ce1a013d94cfd2dd680480f076b5 | |
| parent | The 'export_csv' operation exports into the user subdirectory. (diff) | |
| download | penes-snac2-d1a850acdd75c190df2aae9552882ef06b04e70a.tar.gz penes-snac2-d1a850acdd75c190df2aae9552882ef06b04e70a.tar.xz penes-snac2-d1a850acdd75c190df2aae9552882ef06b04e70a.zip | |
Updated documentation.
| -rw-r--r-- | doc/snac.1 | 4 | ||||
| -rw-r--r-- | doc/snac.5 | 3 | ||||
| -rw-r--r-- | doc/snac.8 | 12 |
3 files changed, 9 insertions, 10 deletions
| @@ -270,7 +270,9 @@ user url that also contains a rel="me" attribute. These links are specially | |||
| 270 | marked as verified in the user's public timeline and also via the Mastodon API. | 270 | marked as verified in the user's public timeline and also via the Mastodon API. |
| 271 | .It Cm export_csv Ar basedir Ar uid | 271 | .It Cm export_csv Ar basedir Ar uid |
| 272 | Exports some account data as Mastodon-compatible CSV files. After executing | 272 | Exports some account data as Mastodon-compatible CSV files. After executing |
| 273 | this command, the following files will be written to the current directory: | 273 | this command, the following files will be written to the |
| 274 | .Pa export/ | ||
| 275 | subdirectory inside the user directory: | ||
| 274 | .Pa bookmarks.csv , | 276 | .Pa bookmarks.csv , |
| 275 | .Pa blocked_accounts.csv , | 277 | .Pa blocked_accounts.csv , |
| 276 | .Pa lists.csv , and | 278 | .Pa lists.csv , and |
| @@ -209,6 +209,9 @@ web interface. | |||
| 209 | .It Pa history/ | 209 | .It Pa history/ |
| 210 | This directory contains generated HTML files. They may be snapshots of the | 210 | This directory contains generated HTML files. They may be snapshots of the |
| 211 | local timeline in previous months or other cached data. | 211 | local timeline in previous months or other cached data. |
| 212 | .It Pa export/ | ||
| 213 | This directory will contain exported data in Mastodon-compatible CSV format | ||
| 214 | after executing the 'export_csv' command-line operation. | ||
| 212 | .It Pa server.pid | 215 | .It Pa server.pid |
| 213 | This file stores the server PID in a single text line. | 216 | This file stores the server PID in a single text line. |
| 214 | .El | 217 | .El |
| @@ -421,7 +421,9 @@ server, first export your data to CSV by running: | |||
| 421 | snac export_csv $SNAC_BASEDIR origin | 421 | snac export_csv $SNAC_BASEDIR origin |
| 422 | .Ed | 422 | .Ed |
| 423 | .Pp | 423 | .Pp |
| 424 | You'll find the following CSV files in the current directory: | 424 | You'll find the following CSV files in the |
| 425 | .Pa export/ | ||
| 426 | subdirectory inside the user directory: | ||
| 425 | .Pa bookmarks.csv , | 427 | .Pa bookmarks.csv , |
| 426 | .Pa blocked_accounts.csv , | 428 | .Pa blocked_accounts.csv , |
| 427 | .Pa lists.csv , and | 429 | .Pa lists.csv , and |
| @@ -481,14 +483,6 @@ account you migrated from is not disabled nor changed in any way, so can still | |||
| 481 | use it as it no migration was done. This behaviour may or may not match what other | 483 | use it as it no migration was done. This behaviour may or may not match what other |
| 482 | ActivityPub implementations do. | 484 | ActivityPub implementations do. |
| 483 | .Pp | 485 | .Pp |
| 484 | NOTE: If you run | ||
| 485 | .Nm | ||
| 486 | on OpenBSD, please take note that the pledge()/unveil() security system disallows | ||
| 487 | opening or creating files in the current directory; to do this operation, please | ||
| 488 | temporarily set the disable_openbsd_security option to true in the | ||
| 489 | .Pa server.json | ||
| 490 | file and restart before migrating. You can restore the option back to the default false | ||
| 491 | value afterwards. | ||
| 492 | .Ss Migrating from Mastodon to snac | 486 | .Ss Migrating from Mastodon to snac |
| 493 | Since version 2.61, you can migrate accounts on other ActivityPub instances to your | 487 | Since version 2.61, you can migrate accounts on other ActivityPub instances to your |
| 494 | .Nm | 488 | .Nm |