Documentation/public-inbox-init.pod

   1 =head1 NAME
   2
   3 public-inbox-init - create or reinitialize a public-inbox
   4
   5 =head1 SYNOPSIS
   6
   7 B<public-inbox-init> [OPTIONS] NAME INBOX_DIR HTTP_URL ADDRESS [ADDRESS..]
   8
   9 =head1 DESCRIPTION
  10
  11 Creates an empty public-inbox or reinitializes an existing one.
  12 It updates C<~/.public-inbox/config> by creating a
  13 C<[publicinbox "NAME"]> section where
  14 C<publicinbox.NAME.mainrepo> is C<INBOX_DIR>,
  15 C<publicinbox.NAME.url> is C<HTTP_URL>, and
  16 C<publicinbox.NAME.address> is C<ADDRESS>.  Multiple addresses
  17 may be specified for inboxes with multiple addresses.
  18
  19 =head1 OPTIONS
  20
  21 =over
  22
  23 =item -V, --version FORMAT_VERSION
  24
  25 Specify C<2> here to use the scalable L<public-inbox-v2-format(5)>
  26 if you have L<DBD::SQLite> installed.
  27
  28 The default is C<1> for the old L<public-inbox-v1-format(5)>,
  29 but C<2> is strongly recommended for scalability if you have
  30 L<DBD::SQLite>.
  31
  32 Default: C<1>
  33
  34 =item --indexlevel <basic|medium|full>
  35
  36 Controls the indexing level for L<public-inbox-index(1)>
  37
  38 See L<public-inbox-config(5)> for more information.
  39
  40 Default: C<full>
  41
  42 =item -S, --skip-epoch
  43
  44 For C<-V2> (L<public-inbox-v2-format(5)>) inboxes only, this option
  45 allows archivists to publish incomplete archives with newer
  46 mail while allowing "0.git" (or "1.git" and so on) epochs to be
  47 added-after-the-fact (without affecting "git clone" followers).
  48
  49 Default: unset, no epochs are skipped
  50
  51 =back
  52
  53 =head1 ENVIRONMENT
  54
  55 =over 8
  56
  57 =item PI_CONFIG
  58
  59 Used to override the default C<~/.public-inbox/config> value.
  60
  61 =back
  62
  63 =head1 LIMITATIONS
  64
  65 This tool predates NNTP support in public-inbox and is missing
  66 C<newsgroup> and many of the options documented in
  67 L<public-inbox-config(5)>.  See L<public-inbox-config(5)> for all the
  68 options which may be applied to a given inbox.
  69
  70 =head1 CONTACT
  71
  72 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  73
  74 The mail archives are hosted at L<https://public-inbox.org/meta/>
  75 and L<http://hjrcffqmbrq6wope.onion/meta/>
  76
  77 =head1 COPYRIGHT
  78
  79 Copyright 2019 all contributors L<mailto:meta@public-inbox.org>
  80
  81 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  82
  83 =head1 SEE ALSO
  84
  85 L<git-init(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>,
  86 L<public-inbox-v2-format(5)>