diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/snac.1 | 19 | ||||
| -rw-r--r-- | doc/snac.5 | 6 | ||||
| -rw-r--r-- | doc/snac.8 | 13 |
3 files changed, 30 insertions, 8 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 |
| @@ -286,7 +288,9 @@ Starts a migration from this account to the one set as an alias (see | |||
| 286 | section 'Migrating from snac to Mastodon'). | 288 | section 'Migrating from snac to Mastodon'). |
| 287 | .It Cm import_csv Ar basedir Ar uid | 289 | .It Cm import_csv Ar basedir Ar uid |
| 288 | Imports CSV data files from a Mastodon export. This command expects the | 290 | Imports CSV data files from a Mastodon export. This command expects the |
| 289 | following files to be in the current directory: | 291 | following files to be inside the |
| 292 | .Pa import/ | ||
| 293 | subdirectory of a user's directory inside the server base directory: | ||
| 290 | .Pa bookmarks.csv , | 294 | .Pa bookmarks.csv , |
| 291 | .Pa blocked_accounts.csv , | 295 | .Pa blocked_accounts.csv , |
| 292 | .Pa lists.csv , and | 296 | .Pa lists.csv , and |
| @@ -314,10 +318,15 @@ for a job to be assigned), input or output (processing I/O packets) | |||
| 314 | or stopped (not running, only to be seen while starting or stopping | 318 | or stopped (not running, only to be seen while starting or stopping |
| 315 | the server). | 319 | the server). |
| 316 | .It Cm import_list Ar basedir Ar uid Ar file | 320 | .It Cm import_list Ar basedir Ar uid Ar file |
| 317 | Imports a Mastodon list in CSV format. This option can be used to | 321 | Imports a Mastodon list in CSV format. The file must be stored inside the |
| 318 | import "Mastodon Follow Packs". | 322 | .Pa import/ |
| 323 | subdirectory of a user's directory inside the server base directory. | ||
| 324 | This option can be used to import "Mastodon Follow Packs". | ||
| 319 | .It Cm import_block_list Ar basedir Ar uid Ar file | 325 | .It Cm import_block_list Ar basedir Ar uid Ar file |
| 320 | Imports a Mastodon list of accounts to be blocked in CSV format. | 326 | Imports a Mastodon list of accounts to be blocked in CSV format. The |
| 327 | file must be stored inside the | ||
| 328 | .Pa import/ | ||
| 329 | subdirectory of a user's directory inside the server base directory. | ||
| 321 | .El | 330 | .El |
| 322 | .Ss Migrating an account to/from Mastodon | 331 | .Ss Migrating an account to/from Mastodon |
| 323 | See | 332 | See |
| @@ -209,6 +209,12 @@ 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. | ||
| 215 | .It Pa import/ | ||
| 216 | Mastodon-compatible CSV files must be copied into this directory to use | ||
| 217 | any of the importing functions. | ||
| 212 | .It Pa server.pid | 218 | .It Pa server.pid |
| 213 | This file stores the server PID in a single text line. | 219 | This file stores the server PID in a single text line. |
| 214 | .El | 220 | .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 |
| @@ -480,6 +482,7 @@ Also, please take note that the | |||
| 480 | account you migrated from is not disabled nor changed in any way, so can still | 482 | 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. |
| 485 | .Pp | ||
| 483 | .Ss Migrating from Mastodon to snac | 486 | .Ss Migrating from Mastodon to snac |
| 484 | 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 |
| 485 | .Nm | 488 | .Nm |
| @@ -508,7 +511,9 @@ directory: | |||
| 508 | .Pa lists.csv , and | 511 | .Pa lists.csv , and |
| 509 | .Pa following_accounts.csv . | 512 | .Pa following_accounts.csv . |
| 510 | .Pp | 513 | .Pp |
| 511 | 2. From the directory where those files are stored, run | 514 | 2. Copy all those files to the |
| 515 | .Pa import/ | ||
| 516 | subdirectory of the user's directory inside the server base directory, and run | ||
| 512 | .Bd -literal -offset indent | 517 | .Bd -literal -offset indent |
| 513 | snac import_csv $SNAC_BASEDIR destination | 518 | snac import_csv $SNAC_BASEDIR destination |
| 514 | .Ed | 519 | .Ed |
| @@ -518,7 +523,9 @@ of all the ActivityPub servers involved (webfinger, accounts, posts, etc.). Some | |||
| 518 | may be transient and retried later. Also, if | 523 | may be transient and retried later. Also, if |
| 519 | .Nm | 524 | .Nm |
| 520 | complains that it can't find any of these files, please check that they are really | 525 | complains that it can't find any of these files, please check that they are really |
| 521 | stored in the current directory and that their names match exactly. Some of them may be | 526 | stored in the |
| 527 | .Pa import/ | ||
| 528 | subdirectory and that their names match exactly. Some of them may be | ||
| 522 | empty (for example, if you didn't create any list) and that's fine. | 529 | empty (for example, if you didn't create any list) and that's fine. |
| 523 | .Pp | 530 | .Pp |
| 524 | 3. Again on your | 531 | 3. Again on your |