pgsrc/PhpWikiAdministration

   1 Date: Mon, 17 Jan 2005 08:44:07 +0100
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.11)
   3 X-Rcs-Id: $Id: PhpWikiAdministration,v 1.40 2006-12-22 01:32:29 rurban Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=PhpWikiAdministration;
   6   pgsrc_version="2 $Revision: 1.40 $";
   7   flags=PAGE_LOCKED;
   8   markup=2;
   9   charset=iso-8859-1
  10 Content-Transfer-Encoding: binary
  11
  12 _*Note:*_  _Most of the actions on this page require administrative
  13 privileges. They will not work unless you have set an admin username and
  14 password in the PhpWiki config file._
  15
  16 <?plugin CreateToc jshide||=1 with_toclink||=1 ?>
  17
  18 ----
  19 !!! Page Explorer
  20
  21 First select pages and then define the action:
  22
  23 <?plugin-form WikiAdminSelect s="*" ?>
  24
  25 or call the available ~WikiAdmin actions directly:
  26
  27 [/Remove] |
  28   [/Rename] |
  29     [/Replace] |
  30       [/SetAcl] |
  31         [/Chmod] |
  32           [/Chown]
  33
  34 ----
  35 !!! User Management
  36
  37 PhpWiki:EmailVerification is currently non-strict, leaving some possible holes, which can be
  38 administrated below.
  39
  40   This button will show a list of all users with registered emails and buttons to set the
  41   verification status manually.
  42
  43   <?plugin WikiAdminUtils
  44            action=email-verification
  45            label="Email Verification"
  46    ?>
  47
  48 To prevent from robots eating all possible ressources in a short time, blocking from certain IPs
  49 or not-well-behaving user agents can be defined below. See PhpWiki:HowToBlockRobots and
  50 MeatBall:SurgeProtector. _Note: Not yet enabled._
  51
  52   <?plugin WikiAdminUtils
  53            action=access-restrictions
  54            label="Access Restrictions"
  55    ?>
  56
  57 ----
  58 !!! Cleanup
  59
  60 A Wiki SandBox is very easy to clean. Here you can restore it to
  61 pristine condition by loading the default from pgsrc.
  62
  63   [Rake the SandBox|phpwiki:?action=loadfile&source=pgsrc/SandBox].
  64
  65 ----------
  66
  67 !!! Making Snapshots or Backups
  68
  69 !! ZIP files of database
  70
  71 These links lead to zip files, generated on the fly, which contain all
  72 the pages in your Wiki. The zip file will be downloaded to your local
  73 computer.
  74
  75   This *[ZIP Snapshot | phpwiki:?action=zip]* contains only the
  76   latest versions of each page, while this *[ZIP Dump |
  77   phpwiki:?action=zip&include=all]* contains all archived versions.
  78
  79   (If the PhpWiki is configured to allow it, anyone can download a zip
  80   file.)
  81
  82 If your php has _zlib_ support, the files in the archive will be
  83 compressed, otherwise they will just be stored.
  84
  85 !! Dump to directory
  86
  87 Here you can dump pages of your Wiki into a directory of your choice.
  88
  89   <?plugin WikiForm action=dumpserial?>
  90
  91 The most recent version of each page will written out to the
  92 directory, one page per file. Your server must have write permissions
  93 to the directory!
  94
  95 -----------
  96 !!! Restoring
  97
  98 If you have dumped a set of pages from PhpWiki, you can reload them
  99 here. Note that pages in your database will be overwritten; thus, if
 100 you dumped your HomePage when you load it from this form it will
 101 overwrite the one in your database now. If you want to be selective
 102 just delete the pages from the directory (or zip file) which you don't
 103 want to load.
 104
 105 !! Upload File
 106
 107 Here you can upload ZIP archives, or individual files from your
 108 (client) machine.
 109
 110   <?plugin WikiForm action=upload?>
 111
 112 !! Load File
 113
 114 Here you can load ZIP archives, individual files or entire
 115 directories. The file or directory must be local to the http
 116 server. You can also use this form to load from an http: or ftp: URL.
 117
 118   <?plugin WikiForm action=loadfile?>
 119   <?plugin WikiForm action=loadfile buttontext="Load & Overwrite" overwrite=1?>
 120
 121 !! Upgrade
 122
 123 Do some verification checks and upgrade changes automatically, after having installed a
 124 new phpwiki engine update:
 125 * Upgrade new or changed page revisions from pgsrc,
 126 * Upgrade the database schema (mysql _page.id auto_increment_, ADD _session.sess_ip_),
 127
 128 ;:[ Upgrade | phpwiki:HomePage?action=upgrade ]
 129
 130 -----------
 131
 132 !!! Format of the files
 133
 134 Currently the pages are stored, one per file, as MIME (RFC:2045)
 135 e-mail (RFC:822) messages. The content-type _application/x-phpwiki_
 136 is used, and page meta-data is encoded in the content-type
 137 parameters. (If the file contains several versions of a page, it will
 138 have type _multipart/mixed_, and contain several sub-parts, each
 139 with type _application/x-phpwiki_.)  The message body contains the
 140 page text.
 141
 142 !! Old Formats
 143
 144 *Serialized Files*
 145
 146   The dump to directory command used to dump the pages as PHP
 147   _serialized()_ strings. For humans, this made the files very hard
 148   to read, and nearly impossible to edit.
 149
 150 *Plain Files*
 151
 152   Before that the page text was just dumped to a file--this means that
 153   all page meta-data was lost. Note that when loading _plain files_,
 154   the page name is deduced from the file name.
 155
 156 The upload and load functions will automatically recognize each of
 157 these three types of files, and handle them accordingly.
 158
 159 ----
 160
 161 !!! Dump pages as XHTML
 162
 163   <?plugin WikiForm action=dumphtml?>
 164
 165 This will generate a directory of static pages suitable for
 166 distribution on disk where no web server is available. The various
 167 links for page editing functions and navigation are removed from the
 168 pages.
 169
 170   The XHTML file collection can also be downloaded as an
 171   *[XHTML ZIP Snapshot | phpwiki:?action=ziphtml]*.
 172
 173 ----
 174
 175 !!! Phpwiki Internals
 176
 177 These are here mostly for debugging purposes (at least, that is the
 178 hope.)
 179
 180 In normal use, you should not need to use these, though, then again,
 181 they should not really do any harm.
 182
 183 !! Purge Markup Cache
 184
 185 (If your wiki is so configured,) the transformed (almost-HTML) content
 186 of the most recent version of each page is cached. This speeds up page
 187 rendering since parsing of the wiki-text takes a fair amount of juice.
 188
 189   Hitting this button will delete all cached transformed
 190   content. (Each pages content will be transformed and re-cached next
 191   time someone views it.)
 192
 193   <?plugin WikiAdminUtils
 194            action=purge-cache
 195            label="Purge Markup Cache"
 196    ?>
 197
 198 !! Clean WikiDB of Illegal Filenames
 199
 200 Page names beginning with the subpage-separator, usually a slash
 201 (=/=), are not allowed. Sometimes though an errant plugin or something
 202 might create one....
 203
 204   This button will delete any pages with illegal page names, without possibility to restore.
 205
 206   <?plugin WikiAdminUtils
 207            action=purge-bad-pagenames
 208            label="Purge bad pagenames"
 209    ?>
 210
 211 !! Clean WikiDB of empty and unreferenced pages
 212
 213   *Warning!* This button will delete every empty and unreferenced page, without any possibility to restore them again.
 214   This will disable the possibility to revert or get back any deleted page.
 215
 216   <?plugin WikiAdminUtils
 217            action=purge-empty-pages
 218            label="Purge all empty unreferenced pages"
 219    ?>
 220
 221 !! Convert cached_html to new SQL column
 222
 223   This is only needed on SQL or ADODB if you didn't do action=upgrade, but created the
 224   new page.cached_html field seperately, and now you want to move this data from
 225   page.pagedata over to page.cached_html.
 226
 227   <?plugin WikiAdminUtils
 228            action=convert-cached-html
 229            label="Convert cached_html"
 230    ?>
 231
 232
 233 !! Check WikiDB
 234
 235   This button will check the Wiki page database for consistency.
 236
 237   <?plugin WikiAdminUtils
 238            action=db-check
 239            label="Check WikiDB"
 240    ?>
 241
 242 !! Rebuild WikiDB
 243
 244   This button will rebuild the Wiki backlink database on consistency errors.
 245
 246   <?plugin WikiAdminUtils
 247            action=db-rebuild
 248            label="Rebuild WikiDB"
 249    ?>
 250
 251 ----
 252 PhpWikiDocumentation