Changesets can be listed by changeset number.
The Git repository is here.
- Revision:
- 2
- Log:
Initial import of Instiki 0.11.0 sources from a downloaded Tarball.
Instiki is a Ruby On Rails based Wiki clone.
- Author:
- adh
- Date:
- Sat Jul 22 14:54:51 +0100 2006
- Size:
- 5070 Bytes
- Properties:
- Property svn:executable is set
| 1 | ===What is Instiki? |
| 2 | |
| 3 | Admitted, it's YetAnotherWikiClone[http://c2.com/cgi/wiki?WikiWikiClones], but with a strong focus |
| 4 | on simplicity of installation and running: |
| 5 | |
| 6 | Step 1. Download |
| 7 | Step 2. Run "instiki" |
| 8 | |
| 9 | If you are on Windows: |
| 10 | "Step 3. Chuckle... "There's no step three!" (TM)" |
| 11 | |
| 12 | You're now running a perfectly suitable wiki on port 2500 |
| 13 | that'll present you with one-step setup, followed by a textarea for the home page |
| 14 | on http://localhost:2500 |
| 15 | |
| 16 | Instiki lowers the barriers of interest for when you might consider |
| 17 | using a wiki. It's so simple to get running that you'll find yourself |
| 18 | using it for anything -- taking notes, brainstorming, organizing a |
| 19 | gathering. |
| 20 | |
| 21 | Having said all that, if you are not on Windows, in this version of Instiki it is a somewhat different story. |
| 22 | Since the author has no Linux or Mac at hand, and Instiki is moving to a SQL-based backend, this is what it takes |
| 23 | to install (until somebody sends a patch to properly package Instiki for all those other platforms): |
| 24 | |
| 25 | 3. Kill "instiki" |
| 26 | 4. Install SQLite 3 database engine from http://www.sqlite.org/ |
| 27 | 5. Install SQLite 3 driver for Ruby from http://sqlite-ruby.rubyforge.org/ |
| 28 | 6. Install Rake from http://rake.rubyforge.org/ |
| 29 | 7. Execute rm -f db/*.db |
| 30 | 8. Execute 'rake migrate' |
| 31 | 9. Make an embarrassed sigh (as I do while writing this) |
| 32 | 10. Run 'instiki' again |
| 33 | 11. Pat yourself on the shoulder for being such a talented geek |
| 34 | 12. At least, there is no step twelve! (TM) |
| 35 | |
| 36 | ===Features: |
| 37 | * Regular expression search: Find deep stuff really fast |
| 38 | * Revisions: Follow the changes on every page from birth. Rollback to an earlier rev |
| 39 | * Export to HTML or markup in a zip: Take the entire wiki with you home or for reference |
| 40 | * RSS feeds to track recently revised pages |
| 41 | * Multiple webs: Create separate wikis with their own namespace |
| 42 | * Password-protected webs: Keep it private |
| 43 | * Authors: Each revision is associated with an author, so you can see who changed what |
| 44 | * Reference tracker: Which other pages are pointing to the current? |
| 45 | * Speed: Using Madelein[http://madeleine.sourceforge.net] for persistence (all pages are in memory) |
| 46 | * Three markup choices: Textile[http://www.textism.com/tools/textile] |
| 47 | (default / RedCloth[http://www.whytheluckystiff.net/ruby/redcloth]), |
| 48 | Markdown (BlueCloth[http://bluecloth.rubyforge.org]), and RDoc[http://rdoc.sourceforge.net/doc] |
| 49 | * Embedded webserver: Through WEBrick[http://www.webrick.org] |
| 50 | * Internationalization: Wiki words in any latin, greek, cyrillian, or armenian characters |
| 51 | * Color diffs: Track changes through revisions |
| 52 | * Definitely can run on SQLite and MySQL |
| 53 | * May be able to run on Postgres, Oracle, DB2 and SqlServer. If you try this, and it works |
| 54 | (or, it doesn't, but you make it work) please write about it on Instiki.org. |
| 55 | |
| 56 | ===Command-line options: |
| 57 | * Run "ruby instiki --help" |
| 58 | |
| 59 | ===History: |
| 60 | * See CHANGELOG |
| 61 | |
| 62 | ===Migrating Instiki 0.10.2 storage to Instiki 0.11.0 database |
| 63 | 1. Install Instiki 0.11 and check that it works (you should be able to create a web, edit and save a HomePage) |
| 64 | 2. Execute |
| 65 | ruby script\import_storage \ |
| 66 | -t /full/path/to/instiki0.10/storage \ |
| 67 | -i /full/path/to/instiki0.10/installation \ |
| 68 | -d sqlite (or mysql, or postgres, depending on what you use) \ |
| 69 | -o instiki_import.sql |
| 70 | for example (Windows): |
| 71 | ruby script\import_storage -t c:\instiki-0.10.2\storage\2500 -i c:\instiki-0.10.2 -d sqlite -o instiki_import.sql |
| 72 | 3. This will produce instiki_import.sql file in the current working directory. |
| 73 | Open it in a text editor and inspect carefully. |
| 74 | 4. Connect to your production database (e.g., 'sqlite3 db\prod.db'), |
| 75 | and have it execute instiki_import.sql (e.g., '.read instiki_import.sql') |
| 76 | 5. Execute ruby script\reset_references |
| 77 | (this script parses all pages for crosslinks between them, so it may take a few minutes) |
| 78 | 6. Restart Instiki |
| 79 | 7. Go over some pages, especially those with a lot of complex markup, and see if anything is broken. |
| 80 | |
| 81 | The most common migration problem is this: if you open All Pages and see a lot of orphaned pages, |
| 82 | you forgot to run ruby script\reset_references after importing the data. |
| 83 | |
| 84 | ===Upgrading from Instiki-AR Beta 1 |
| 85 | In Beta 2, we switch to ActiveRecord:Migrations. Therefore: |
| 86 | 1. Back up your production database. |
| 87 | 2. Open command-line session to your database and execute: |
| 88 | create table schema_info (version integer(11)); |
| 89 | insert into schema_info (version) values (1); |
| 90 | 3. Go back to the shell, change directory to the new Instiki and execute "rake migrate". |
| 91 | |
| 92 | Step 2 creates a table that tells to ActiveRecord:Migrations that the current version |
| 93 | of this database is 1 (corresponding to Beta 1), and step 3 makes it up-to-date with |
| 94 | the current version of Instiki. |
| 95 | |
| 96 | ===Download the latest release from: |
| 97 | * http://rubyforge.org/project/showfiles.php?group_id=186 |
| 98 | |
| 99 | ===Visit the "official" Instiki wiki: |
| 100 | * http://instiki.org |
| 101 | |
| 102 | ===License: |
| 103 | * same as Ruby's |
| 104 | |
| 105 | --- |
| 106 | Authors:: |
| 107 | |
| 108 | Versions 0.0 to 0.9.1:: David Heinemeier Hansson |
| 109 | Email:: david@loudthinking.com |
| 110 | Weblog:: http://www.loudthinking.com |
| 111 | |
| 112 | From 0.9.2 onwards:: Alexey Verkhovsky |
| 113 | Email:: alex@verk.info |
