Browse Source

Updated documentation.

default 3 months ago
parent
commit
fec602970f
3 changed files with 20 additions and 14 deletions
  1. 11 4
      doc/snac.1
  2. 3 0
      doc/snac.5
  3. 6 10
      doc/snac.8

+ 11 - 4
doc/snac.1

@@ -288,7 +288,9 @@ Starts a migration from this account to the one set as an alias (see
 section 'Migrating from snac to Mastodon').
 .It Cm import_csv Ar basedir Ar uid
 Imports CSV data files from a Mastodon export. This command expects the
-following files to be in the current directory:
+following files to be inside the
+.Pa import/
+subdirectory of a user's directory inside the server base directory:
 .Pa bookmarks.csv ,
 .Pa blocked_accounts.csv ,
 .Pa lists.csv , and
@@ -316,10 +318,15 @@ for a job to be assigned), input or output (processing I/O packets)
 or stopped (not running, only to be seen while starting or stopping
 the server).
 .It Cm import_list Ar basedir Ar uid Ar file
-Imports a Mastodon list in CSV format. This option can be used to
-import "Mastodon Follow Packs".
+Imports a Mastodon list in CSV format. The file must be stored inside the
+.Pa import/
+subdirectory of a user's directory inside the server base directory.
+This option can be used to import "Mastodon Follow Packs".
 .It Cm import_block_list Ar basedir Ar uid Ar file
-Imports a Mastodon list of accounts to be blocked in CSV format.
+Imports a Mastodon list of accounts to be blocked in CSV format. The
+file must be stored inside the
+.Pa import/
+subdirectory of a user's directory inside the server base directory.
 .El
 .Ss Migrating an account to/from Mastodon
 See 

+ 3 - 0
doc/snac.5

@@ -212,6 +212,9 @@ local timeline in previous months or other cached data.
 .It Pa export/
 This directory will contain exported data in Mastodon-compatible CSV format
 after executing the 'export_csv' command-line operation.
+.It Pa import/
+Mastodon-compatible CSV files must be copied into this directory to use
+any of the importing functions.
 .It Pa server.pid
 This file stores the server PID in a single text line.
 .El

+ 6 - 10
doc/snac.8

@@ -511,7 +511,9 @@ directory:
 .Pa lists.csv , and
 .Pa following_accounts.csv .
 .Pp
-2. From the directory where those files are stored, run
+2. Copy all those files to the
+.Pa import/
+subdirectory of the user's directory inside the server base directory, and run
 .Bd -literal -offset indent
 snac import_csv $SNAC_BASEDIR destination
 .Ed
@@ -521,7 +523,9 @@ of all the ActivityPub servers involved (webfinger, accounts, posts, etc.). Some
 may be transient and retried later. Also, if
 .Nm
 complains that it can't find any of these files, please check that they are really
-stored in the current directory and that their names match exactly. Some of them may be
+stored in the
+.Pa import/
+subdirectory and that their names match exactly. Some of them may be
 empty (for example, if you didn't create any list) and that's fine.
 .Pp
 3. Again on your
@@ -551,14 +555,6 @@ account from all accounts that followed the Mastodon one. According to the great
 I linked above, this process may or may not start immediately, and its success may depend
 heavily on how all the servers involved behave. Just cross your fingers and hope for the best.
 .Pp
-NOTE: If you run
-.Nm
-on OpenBSD, please take note that the pledge()/unveil() security system disallows
-opening or creating files in the current directory; to do this operation, please
-temporarily set the disable_openbsd_security option to true in the
-.Pa server.json
-file and restart before migrating. You can restore the option back to the default false
-value afterwards.
 .Ss Instance blocking
 Full instances can be blocked. This operation must be done from
 the command-line tool. See