pgsrc/PhpWikiAdministration

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