| Index: trunk/testing/installer/QUICKSTART |
| — | — | @@ -0,0 +1,75 @@ |
| | 2 | +Document: (C) 2009 Kim Bruning, released as documentation under MIT license |
| | 3 | + |
| | 4 | +Quickstart guide: |
| | 5 | + |
| | 6 | +INSTALLER |
| | 7 | +1. svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/testing/ |
| | 8 | +2. cd testing/installer |
| | 9 | +3. copy settings.example to settings.py and check with settings_handler (if you need to) ... if you leave out this step, it'll only work in your homedir. |
| | 10 | +4. mkdir ~/public_html/revisions (if you are indeed working in your homedir) |
| | 11 | +# installer now works. |
| | 12 | + |
| | 13 | +TESTING |
| | 14 | +5. To get testing working |
| | 15 | +./installer.py install toolkit:pywikipedia |
| | 16 | +6. also, in exttest, copy settings.py.example to settings.py, and edit. |
| | 17 | + |
| | 18 | +testing can still use a lot of coding work. |
| | 19 | + |
| | 20 | + |
| | 21 | + |
| | 22 | + |
| | 23 | +USING THE INSTALLER: |
| | 24 | +To get something installed. There's a REPL (command line) and you can also access the same commands from bash (or some other shell, or popen, or what have you) |
| | 25 | +The interface and back end are somewhat separate (installer.py is current interface, installers.py is the basic back end), so someone might be able to create a GUI or web front end someday soon. :-) |
| | 26 | + |
| | 27 | +basic commands are: |
| | 28 | +ls |
| | 29 | +install |
| | 30 | +uninstall |
| | 31 | + |
| | 32 | +to see what you can install: |
| | 33 | +-mediawiki revisions |
| | 34 | + ls available.mediawiki: |
| | 35 | +-extensions |
| | 36 | + ls available.extensions: |
| | 37 | + |
| | 38 | +to install something: |
| | 39 | + |
| | 40 | + install mediawiki:REL1_14_0 as myfirstwiki |
| | 41 | + install extension:ImageMap in myfirstwiki |
| | 42 | + |
| | 43 | +to uninstall things |
| | 44 | + uninstall extension:ImageMap in myfirstwiki |
| | 45 | + uninstall myfirstwiki |
| | 46 | + |
| | 47 | +(incidentally, uninstall myfirstwiki will uninstall all extensions and drop the database automatically) |
| | 48 | + |
| | 49 | +And that's basically it! |
| | 50 | + |
| | 51 | +Why is this handy at all? |
| | 52 | + |
| | 53 | +Well, imagine if you want to install many different wikis with slightly different settings and extensions, so you can test how things interact. (this is a testing environment, after all ;-) ) You can use this tool to script your installation procedure. |
| | 54 | + |
| | 55 | +It's also fairly handy for maintaining large numbers of wikis in a production environment. Or for maintaining backups of even just a single wiki |
| | 56 | + |
| | 57 | +if you hadn't uninstalled your first wiki yet: |
| | 58 | + |
| | 59 | + duplicate myfirstwiki mysecondwiki |
| | 60 | + |
| | 61 | +will create a clone of the first wiki, which you can either leave online and allow to grow and change by itself, or you can tar it up and pack it away someplace safe as a backup. |
| | 62 | + |
| | 63 | + |
| | 64 | + |
| | 65 | +calling from bash is easy too |
| | 66 | + |
| | 67 | + ./installer.py install mediawiki:latest as cuttingedgedude |
| | 68 | + |
| | 69 | +For examples of some ready made scripts, see ../util/environment/ |
| | 70 | + |
| | 71 | + |
| | 72 | + |
| | 73 | + |
| | 74 | + |
| | 75 | + |
| | 76 | + |