pgsrc/PhpWikiAdministration

   1 Date: Mon, 10 Oct 2008 14:15:24 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=PhpWikiAdministration;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 _*Note:*_  _Most of the actions on this page require administrative
  12 privileges. They will not work unless you have set an admin username and
  13 password in the [PhpWiki|PhpWiki:PhpWiki] config file._
  14
  15 <?plugin CreateToc jshide||=0 with_toclink||=1 liststyle=ul?>
  16
  17 !!! Page Explorer
  18
  19 First select pages and then define the action:
  20
  21 <?plugin-form WikiAdminSelect s="*" ?>
  22
  23 or call the available ~WikiAdmin actions directly:
  24
  25 [/Remove] |
  26   [/Rename] |
  27     [/Replace] |
  28       [/SetAcl] |
  29         [/Chmod] |
  30           [/Chown]
  31
  32 !!! User Management
  33
  34 Reset a users password:
  35
  36   <?plugin-form PasswordReset textinput=user method=post ?>
  37
  38 Email Verification:
  39
  40   This is currently non-strict, leaving some possible holes in not being able to
  41   connect to certain mail hosts, which can be overridden below. See PhpWiki:EmailVerification
  42
  43   This button will show a list of all users with registered emails and buttons to set the
  44   verification status manually.
  45
  46   <?plugin WikiAdminUtils
  47            action=email-verification
  48            label="Email Verification"
  49    ?>
  50
  51 Access Restrictions (disabled):
  52
  53   To prevent from robots eating all possible ressources in a short time, blocking from certain IPs
  54   or not-well-behaving user agents can be defined below. See PhpWiki:HowToBlockRobots and
  55   MeatBall:SurgeProtector. _Note: Not yet enabled._
  56
  57   <?plugin WikiAdminUtils
  58            action=access-restrictions
  59            label="Access Restrictions"
  60    ?>
  61
  62 !!! Cleanup
  63
  64 A Wiki SandBox is very easy to clean. Here you can restore it to
  65 pristine condition by loading the default from pgsrc.
  66
  67   [Rake the SandBox|phpwiki:?action=loadfile&source=pgsrc/SandBox].
  68
  69 !!! Making Snapshots or Backups
  70
  71 !! ZIP files of database
  72
  73 These links lead to zip files, generated on the fly, which contain all
  74 the pages in your Wiki. The zip file will be downloaded to your local
  75 computer.
  76
  77   This *[ZIP Snapshot | phpwiki:?action=zip]* contains only the
  78   latest versions of each page, while this *[ZIP Dump |
  79   phpwiki:?action=zip&include=all]* contains all archived versions.
  80
  81   (If the [PhpWiki|PhpWiki:PhpWiki] is configured to allow it, anyone can download a zip
  82   file.)
  83
  84 If your php has _zlib_ support, the files in the archive will be
  85 compressed, otherwise they will just be stored.
  86
  87 !! Dump to directory
  88
  89 Here you can dump pages of your Wiki into a directory of your choice.
  90
  91   <?plugin WikiForm action=dumpserial?>
  92
  93 The most recent version of each page will written out to the
  94 directory, one page per file. Your server must have write permissions
  95 to the directory!
  96
  97 !!! Restoring
  98
  99 If you have dumped a set of pages from [PhpWiki|PhpWiki:PhpWiki], you can reload them
 100 here. Note that pages in your database will be overwritten; thus, if
 101 you dumped your HomePage when you load it from this form it will
 102 overwrite the one in your database now. If you want to be selective
 103 just delete the pages from the directory (or zip file) which you don't
 104 want to load.
 105
 106 !! Upload File
 107
 108 Here you can upload ZIP archives, or individual files from your
 109 (client) machine.
 110
 111   <?plugin WikiForm action=upload?>
 112
 113 !! Load File
 114
 115 Here you can load ZIP archives, individual files or entire
 116 directories. The file or directory must be local to the http
 117 server. You can also use this form to load from an http: or ftp: URL.
 118
 119   <?plugin WikiForm action=loadfile?>
 120   <?plugin WikiForm action=loadfile buttontext="Load & Overwrite" overwrite=1?>
 121
 122 !! Upgrade
 123
 124 Do some verification checks and upgrade changes automatically, after having installed a
 125 new phpwiki engine update:
 126 * Upgrade new or changed page revisions from pgsrc,
 127 * Upgrade the database schema (mysql _page.id auto_increment_, ADD _session.sess_ip_),
 128
 129 ;:[ Upgrade | phpwiki:HomePage?action=upgrade ]
 130
 131 !!! Format of the files
 132
 133 Currently the pages are stored, one per file, as MIME (RFC:2045)
 134 e-mail (RFC:822) messages. The content-type _application/x-phpwiki_
 135 is used, and page meta-data is encoded in the content-type
 136 parameters. (If the file contains several versions of a page, it will
 137 have type _multipart/mixed_, and contain several sub-parts, each
 138 with type _application/x-phpwiki_.)  The message body contains the
 139 page text.
 140
 141 !! Old Formats
 142
 143 *Serialized Files*
 144
 145   The dump to directory command used to dump the pages as PHP
 146   _serialized()_ strings. For humans, this made the files very hard
 147   to read, and nearly impossible to edit.
 148
 149 *Plain Files*
 150
 151   Before that the page text was just dumped to a file--this means that
 152   all page meta-data was lost. Note that when loading _plain files_,
 153   the page name is deduced from the file name.
 154
 155 The upload and load functions will automatically recognize each of
 156 these three types of files, and handle them accordingly.
 157
 158 !!! Dump pages as XHTML
 159
 160   <?plugin WikiForm action=dumphtml?>
 161
 162 This will generate a directory of static pages suitable for
 163 distribution on disk where no web server is available. The various
 164 links for page editing functions and navigation are removed from the
 165 pages.
 166
 167   The XHTML file collection can also be downloaded as an
 168   *[XHTML ZIP Snapshot | phpwiki:?action=ziphtml]*.
 169
 170 ----
 171 [CategoryActionPage]