summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar default2025-01-04 19:31:44 +0100
committerGravatar default2025-01-04 19:31:44 +0100
commitfec602970f574fb9cbaeab1866c8e6388ba52d81 (patch)
tree16ec46c5ffa56c542117e1d2cc0c5dc58f3323d6 /doc
parentMerge branch 'master' of comam.es:git/snac2 (diff)
downloadpenes-snac2-fec602970f574fb9cbaeab1866c8e6388ba52d81.tar.gz
penes-snac2-fec602970f574fb9cbaeab1866c8e6388ba52d81.tar.xz
penes-snac2-fec602970f574fb9cbaeab1866c8e6388ba52d81.zip
Updated documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.115
-rw-r--r--doc/snac.53
-rw-r--r--doc/snac.816
3 files changed, 20 insertions, 14 deletions
diff --git a/doc/snac.1 b/doc/snac.1
index 6ce0912..999c594 100644
--- a/doc/snac.1
+++ b/doc/snac.1
@@ -288,7 +288,9 @@ Starts a migration from this account to the one set as an alias (see
288section 'Migrating from snac to Mastodon'). 288section 'Migrating from snac to Mastodon').
289.It Cm import_csv Ar basedir Ar uid 289.It Cm import_csv Ar basedir Ar uid
290Imports CSV data files from a Mastodon export. This command expects the 290Imports CSV data files from a Mastodon export. This command expects the
291following files to be in the current directory: 291following files to be inside the
292.Pa import/
293subdirectory of a user's directory inside the server base directory:
292.Pa bookmarks.csv , 294.Pa bookmarks.csv ,
293.Pa blocked_accounts.csv , 295.Pa blocked_accounts.csv ,
294.Pa lists.csv , and 296.Pa lists.csv , and
@@ -316,10 +318,15 @@ for a job to be assigned), input or output (processing I/O packets)
316or stopped (not running, only to be seen while starting or stopping 318or stopped (not running, only to be seen while starting or stopping
317the server). 319the server).
318.It Cm import_list Ar basedir Ar uid Ar file 320.It Cm import_list Ar basedir Ar uid Ar file
319Imports a Mastodon list in CSV format. This option can be used to 321Imports a Mastodon list in CSV format. The file must be stored inside the
320import "Mastodon Follow Packs". 322.Pa import/
323subdirectory of a user's directory inside the server base directory.
324This option can be used to import "Mastodon Follow Packs".
321.It Cm import_block_list Ar basedir Ar uid Ar file 325.It Cm import_block_list Ar basedir Ar uid Ar file
322Imports a Mastodon list of accounts to be blocked in CSV format. 326Imports a Mastodon list of accounts to be blocked in CSV format. The
327file must be stored inside the
328.Pa import/
329subdirectory of a user's directory inside the server base directory.
323.El 330.El
324.Ss Migrating an account to/from Mastodon 331.Ss Migrating an account to/from Mastodon
325See 332See
diff --git a/doc/snac.5 b/doc/snac.5
index 41e86b8..be7bfd7 100644
--- a/doc/snac.5
+++ b/doc/snac.5
@@ -212,6 +212,9 @@ local timeline in previous months or other cached data.
212.It Pa export/ 212.It Pa export/
213This directory will contain exported data in Mastodon-compatible CSV format 213This directory will contain exported data in Mastodon-compatible CSV format
214after executing the 'export_csv' command-line operation. 214after executing the 'export_csv' command-line operation.
215.It Pa import/
216Mastodon-compatible CSV files must be copied into this directory to use
217any of the importing functions.
215.It Pa server.pid 218.It Pa server.pid
216This file stores the server PID in a single text line. 219This file stores the server PID in a single text line.
217.El 220.El
diff --git a/doc/snac.8 b/doc/snac.8
index d4bf23b..f94d53f 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -511,7 +511,9 @@ directory:
511.Pa lists.csv , and 511.Pa lists.csv , and
512.Pa following_accounts.csv . 512.Pa following_accounts.csv .
513.Pp 513.Pp
5142. From the directory where those files are stored, run 5142. Copy all those files to the
515.Pa import/
516subdirectory of the user's directory inside the server base directory, and run
515.Bd -literal -offset indent 517.Bd -literal -offset indent
516snac import_csv $SNAC_BASEDIR destination 518snac import_csv $SNAC_BASEDIR destination
517.Ed 519.Ed
@@ -521,7 +523,9 @@ of all the ActivityPub servers involved (webfinger, accounts, posts, etc.). Some
521may be transient and retried later. Also, if 523may be transient and retried later. Also, if
522.Nm 524.Nm
523complains that it can't find any of these files, please check that they are really 525complains that it can't find any of these files, please check that they are really
524stored in the current directory and that their names match exactly. Some of them may be 526stored in the
527.Pa import/
528subdirectory and that their names match exactly. Some of them may be
525empty (for example, if you didn't create any list) and that's fine. 529empty (for example, if you didn't create any list) and that's fine.
526.Pp 530.Pp
5273. Again on your 5313. Again on your
@@ -551,14 +555,6 @@ account from all accounts that followed the Mastodon one. According to the great
551I linked above, this process may or may not start immediately, and its success may depend 555I linked above, this process may or may not start immediately, and its success may depend
552heavily on how all the servers involved behave. Just cross your fingers and hope for the best. 556heavily on how all the servers involved behave. Just cross your fingers and hope for the best.
553.Pp 557.Pp
554NOTE: If you run
555.Nm
556on OpenBSD, please take note that the pledge()/unveil() security system disallows
557opening or creating files in the current directory; to do this operation, please
558temporarily set the disable_openbsd_security option to true in the
559.Pa server.json
560file and restart before migrating. You can restore the option back to the default false
561value afterwards.
562.Ss Instance blocking 558.Ss Instance blocking
563Full instances can be blocked. This operation must be done from 559Full instances can be blocked. This operation must be done from
564the command-line tool. See 560the command-line tool. See