reformat
Joey Hess
parent
6ffaa2fb04
commit
134dc894b6
360
doc/setup.mdwn
360
doc/setup.mdwn
|
|
@ -1,223 +1,229 @@
|
||||||
This tutorial will walk you through setting up a wiki with ikiwiki.
|
This tutorial will walk you through setting up a wiki with ikiwiki.
|
||||||
|
|
||||||
1. [[Download]] and [[install]] ikiwiki.
|
### 1. [[Download]] and [[install]] ikiwiki.
|
||||||
|
|
||||||
2. Decide where your wiki's files will go.
|
### 2. Decide where your wiki's files will go.
|
||||||
|
|
||||||
As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
|
As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
|
||||||
and outputs the files to a destination directory. If you keep your wiki in
|
and outputs the files to a destination directory. If you keep your wiki in
|
||||||
a version control system, the source directory will contain a working copy
|
a version control system, the source directory will contain a working copy
|
||||||
checked out from the version control system.
|
checked out from the version control system.
|
||||||
|
|
||||||
For the purposes of this tutorial, we'll set shell variables
|
For the purposes of this tutorial, we'll set shell variables
|
||||||
for these locations, and use those variables in the commands that follow.
|
for these locations, and use those variables in the commands that follow.
|
||||||
|
|
||||||
SRCDIR=~/wikiwc
|
SRCDIR=~/wikiwc
|
||||||
DESTDIR=~/public_html/wiki/
|
DESTDIR=~/public_html/wiki/
|
||||||
|
|
||||||
Note that ikiwiki owns the working copy directory; do not perform your own
|
Note that ikiwiki owns the working copy directory; do not perform your own
|
||||||
edits in ikiwiki's working copy.
|
edits in ikiwiki's working copy.
|
||||||
|
|
||||||
3. Create the beginnings of your wiki.
|
### 3. Create the beginnings of your wiki.
|
||||||
|
|
||||||
This will create a simple main page for the wiki.
|
This will create a simple main page for the wiki.
|
||||||
|
|
||||||
mkdir $SRCDIR
|
mkdir $SRCDIR
|
||||||
cd $SRCDIR
|
cd $SRCDIR
|
||||||
$EDITOR index.mdwn
|
$EDITOR index.mdwn
|
||||||
|
|
||||||
In the editor, you could start by entering a simple page like
|
In the editor, you could start by entering a simple page like
|
||||||
[[toggle id=page text="this one"]].
|
[[toggle id=page text="this one"]].
|
||||||
|
[[toggleable id=page text="""
|
||||||
|
Welcome to your new wiki.
|
||||||
|
|
||||||
[[toggleable id=page text="""
|
All wikis are supposed to have a \[[SandBox]],
|
||||||
Welcome to your new wiki.
|
so this one does too.
|
||||||
All wikis are supposed to have a [[SandBox]],
|
|
||||||
so this one does too.
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
This wiki is powered by [ikiwiki](http://ikiwiki.info).
|
This wiki is powered by [ikiwiki](http://ikiwiki.info).
|
||||||
"""]]
|
"""]]
|
||||||
|
|
||||||
See [[HelpOnFormatting]] for details about the markup language.
|
See [[HelpOnFormatting]] for details about the markup language.
|
||||||
|
|
||||||
Note that several [[standard_wiki_pages|basewiki]] will be added to your
|
Note that several [[standard_wiki_pages|basewiki]] will be added to your
|
||||||
wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will
|
wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will
|
||||||
automatically get a [[SandBox]], and some other useful pages.
|
automatically get a [[SandBox]], and some other useful pages.
|
||||||
|
|
||||||
4. Build your wiki for the first time.
|
### 4. Build your wiki for the first time.
|
||||||
|
|
||||||
ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/
|
ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/
|
||||||
|
|
||||||
Replace the url with the real url to your wiki. You should now
|
Replace the url with the real url to your wiki. You should now
|
||||||
be able to visit the url and see your wiki.
|
be able to visit the url and see your wiki.
|
||||||
|
|
||||||
5. Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding
|
### 5. Add content to your wiki.
|
||||||
the wiki.
|
|
||||||
|
|
||||||
To quickly get started on a common task like blogging with ikiwiki, you
|
Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding the
|
||||||
can copy in files from the [[examples]]. The examples are located in
|
wiki.
|
||||||
`doc/examples/` in the ikiwiki source package.
|
|
||||||
|
|
||||||
You can play around with other ikiwiki parameters such as `--wikiname`
|
To quickly get started on a common task like blogging with ikiwiki, you
|
||||||
and `--rebuild` too. Get comfortable with its command line (see
|
can copy in files from the [[examples]]. The examples are located in
|
||||||
[[usage]]).
|
`doc/examples/` in the ikiwiki source package.
|
||||||
|
|
||||||
6. By now you should be getting tired of typing in all the command line
|
You can experiment with other ikiwiki parameters such as `--wikiname`
|
||||||
options each time you change something in your wiki's setup. Time to
|
and `--rebuild` too. Get comfortable with its command line (see
|
||||||
introduce setup files.
|
[[usage]]).
|
||||||
|
|
||||||
A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
|
### 6. Add a setup file.
|
||||||
`doc/ikiwiki.setup` in the ikiwiki sources), and edit it. Note that this
|
|
||||||
file should *not* be put in your wiki's directory with the rest of the
|
|
||||||
files. A good place to put it is in a ~/.ikiwiki/ subdirectory.
|
|
||||||
|
|
||||||
Most of the options, like `wikiname` in the setup file are the same as
|
By now you should be getting tired of typing in all the command line
|
||||||
ikiwiki's command line options (documented in [[usage]]. `srcdir` and
|
options each time you change something in your wiki's setup. Time to
|
||||||
`destdir` are the two directories you specify when running ikiwiki by
|
introduce setup files.
|
||||||
hand. Make sure that these are pointing to the right directories, and
|
|
||||||
read through and configure the rest of the file to your liking.
|
|
||||||
|
|
||||||
When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
|
A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
|
||||||
will set everything up.
|
`doc/ikiwiki.setup` in the ikiwiki sources), and edit it. Note that this
|
||||||
|
file should *not* be put in your wiki's directory with the rest of the
|
||||||
|
files. A good place to put it is in a ~/.ikiwiki/ subdirectory.
|
||||||
|
|
||||||
7. Turn on additional features.
|
Most of the options, like `wikiname` in the setup file are the same as
|
||||||
|
ikiwiki's command line options (documented in [[usage]]. `srcdir` and
|
||||||
|
`destdir` are the two directories you specify when running ikiwiki by
|
||||||
|
hand. Make sure that these are pointing to the right directories, and
|
||||||
|
read through and configure the rest of the file to your liking.
|
||||||
|
|
||||||
Now you have a basic wiki with a configuration file. Time to experiment
|
When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
|
||||||
with ikiwiki's many features.
|
will set everything up.
|
||||||
|
|
||||||
Let's first enable a key wiki feature and set up [[CGI]] to allow
|
### 7. Turn on additional features.
|
||||||
editing the wiki from the web. Just edit ikiwiki.setup, uncomment the
|
|
||||||
block for the cgi wrapper, make sure the filename for the cgi wrapper
|
|
||||||
is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done!
|
|
||||||
|
|
||||||
There are lots of other configuration options in ikiwiki.setup that you
|
Now you have a basic wiki with a configuration file. Time to experiment
|
||||||
can uncomment, configure, and enable by re-running
|
with ikiwiki's many features.
|
||||||
`ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the
|
|
||||||
[[plugins]]..
|
|
||||||
|
|
||||||
8. Put your wiki in revision control.
|
Let's first enable a key wiki feature and set up [[CGI]] to allow
|
||||||
|
editing the wiki from the web. Just edit ikiwiki.setup, uncomment the
|
||||||
|
block for the cgi wrapper, make sure the filename for the cgi wrapper
|
||||||
|
is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done!
|
||||||
|
|
||||||
At this point you might want to check your wiki in to a revision control
|
There are lots of other configuration options in ikiwiki.setup that you
|
||||||
system you can get history of past changes and revert edits. Depending
|
can uncomment, configure, and enable by re-running
|
||||||
on the revision control system you choose, the way this is done varies.
|
`ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the
|
||||||
|
[[plugins]]..
|
||||||
|
|
||||||
There's little that's ikiwiki specific about these instructions; this is
|
### 8. Put your wiki in revision control.
|
||||||
just how you put a directory under revision control using the various
|
|
||||||
systems that ikiwiki supports. Note that the .ikiwiki subdirectory is
|
|
||||||
where ikiwiki keeps its state, and should be preserved, but not checked
|
|
||||||
into revision control.
|
|
||||||
|
|
||||||
[[toggle id=subversion text="Subversion"]]
|
At this point you might want to check your wiki in to a revision control
|
||||||
[[toggleable id=subversion text="""
|
system so you can keep track of changes and revert edits. Depending
|
||||||
REPOSITORY=~/wikirepo
|
on the revision control system you choose, the way this is done varies.
|
||||||
svnadmin create $REPOSITORY
|
|
||||||
svn mkdir file://$REPOSITORY/trunk -m "create trunk"
|
|
||||||
cd $SRCDIR
|
|
||||||
svn co file://$REPOSITORY/trunk .
|
|
||||||
svn add *
|
|
||||||
svn commit -m "initial import"
|
|
||||||
"""]]
|
|
||||||
|
|
||||||
[[toggle id=git text="Git"]]
|
There's little that's ikiwiki specific about these instructions; this is
|
||||||
[[toggleable id=git text="""
|
just how you put a directory under revision control using the various
|
||||||
When using Git, you probably want to set up two repositories, of which
|
systems that ikiwiki supports. Note that the .ikiwiki subdirectory is
|
||||||
one should be bare (meaning that it does not have a working tree
|
where ikiwiki keeps its state, and should be preserved, but not checked
|
||||||
checked out). We call the bare repository the "repository" and the
|
into revision control.
|
||||||
other will be the "srcdir" (which `ikiwiki` uses to compile the wiki).
|
|
||||||
There are [other
|
|
||||||
ways](http://blog.madduck.net/vcs/2007.07.11_publishing-git-repositories)
|
|
||||||
to do the following, but this might be easiest:
|
|
||||||
|
|
||||||
REPOSITORY=~/wiki.git
|
[[toggle id=subversion text="Subversion"]]
|
||||||
GIT_DIR=$REPOSITORY git --bare init --shared
|
[[toggleable id=subversion text="""
|
||||||
cd $SRCDIR
|
REPOSITORY=~/wikirepo
|
||||||
git init
|
svnadmin create $REPOSITORY
|
||||||
echo /.ikiwiki > .gitignore
|
svn mkdir file://$REPOSITORY/trunk -m "create trunk"
|
||||||
git add .
|
cd $SRCDIR
|
||||||
git commit -m "initial commit"
|
svn co file://$REPOSITORY/trunk .
|
||||||
git remote add origin $REPOSITORY
|
svn add *
|
||||||
git config branch.master.merge refs/heads/master
|
svn commit -m "initial import"
|
||||||
git push --all
|
"""]]
|
||||||
|
|
||||||
It is **paramount** that you **never** push to the Git repository in
|
[[toggle id=git text="Git"]]
|
||||||
`$SRCDIR` ([this FAQ entry explains
|
[[toggleable id=git text="""
|
||||||
why](http://git.or.cz/gitwiki/GitFaq#head-b6a3d85f677763313159eb39f7dbf4579d4ee28b)).
|
When using Git, you probably want to set up two repositories, of which
|
||||||
Instead, if you want to work on the wiki from a remote machine, clone
|
one should be bare (meaning that it does not have a working tree
|
||||||
`$REPOSITORY`, using either the `git` transport (if available), or
|
checked out). We call the bare repository the "repository" and the
|
||||||
`ssh`.
|
other will be the "srcdir" (which `ikiwiki` uses to compile the wiki).
|
||||||
|
There are [other
|
||||||
|
ways](http://blog.madduck.net/vcs/2007.07.11_publishing-git-repositories)
|
||||||
|
to do the following, but this might be easiest:
|
||||||
|
|
||||||
If at any point you commit changes in `$SRCDIR`, make sure to `git
|
REPOSITORY=~/wiki.git
|
||||||
push` them to the `$REPOSITORY`. ikiwiki will do this automatically
|
GIT_DIR=$REPOSITORY git --bare init --shared
|
||||||
for any changes made via the web.
|
cd $SRCDIR
|
||||||
|
git init
|
||||||
|
echo /.ikiwiki > .gitignore
|
||||||
|
git add .
|
||||||
|
git commit -m "initial commit"
|
||||||
|
git remote add origin $REPOSITORY
|
||||||
|
git config branch.master.merge refs/heads/master
|
||||||
|
git push --all
|
||||||
|
|
||||||
Finally, see [[Git_pitfalls]] if you experience problems.
|
It is **paramount** that you **never** push to the Git repository in
|
||||||
"""]]
|
`$SRCDIR` ([this FAQ entry explains
|
||||||
|
why](http://git.or.cz/gitwiki/GitFaq#head-b6a3d85f677763313159eb39f7dbf4579d4ee28b)).
|
||||||
|
Instead, if you want to work on the wiki from a remote machine, clone
|
||||||
|
`$REPOSITORY`, using either the `git` transport (if available), or
|
||||||
|
`ssh`.
|
||||||
|
|
||||||
[[toggle id=tla text="TLA"]]
|
If at any point you commit changes in `$SRCDIR`, make sure to `git
|
||||||
[[toggleable id=tla text="""
|
push` them to the `$REPOSITORY`. ikiwiki will do this automatically
|
||||||
REPOSITORY=~/wikirepo
|
for any changes made via the web.
|
||||||
tla make-archive me@localhost--wiki $REPOSITORY
|
|
||||||
tla my-id "<me@localhost>"
|
|
||||||
cd $SRCDIR
|
|
||||||
tla archive-setup me@localhost--wiki/wiki--0
|
|
||||||
tla init-tree me@localhost--wiki/wiki--0
|
|
||||||
# Edit {arch}/=tagging-method and change the precious
|
|
||||||
# line to add the .ikiwiki directory to the regexp.
|
|
||||||
tla add *
|
|
||||||
tla import
|
|
||||||
"""]]
|
|
||||||
|
|
||||||
[[toggle id=mercurial text="Mercurial"]]
|
Finally, see [[Git_pitfalls]] if you experience problems.
|
||||||
[[toggleable id=mercurial text="""
|
"""]]
|
||||||
REPOSITORY=$SRCDIR
|
|
||||||
hg init $REPOSITORY
|
|
||||||
cd $REPOSITORY
|
|
||||||
hg add *
|
|
||||||
hg commit -m "initial import"
|
|
||||||
"""]]
|
|
||||||
|
|
||||||
[[toggle id=monotone text="Monotone"]]
|
[[toggle id=tla text="TLA"]]
|
||||||
[[toggleable id=monotone text="""
|
[[toggleable id=tla text="""
|
||||||
# These instructions are standard instructions to import a directory into monotone
|
REPOSITORY=~/wikirepo
|
||||||
# and set it up so that you don't need any passwords to use it
|
tla make-archive me@localhost--wiki $REPOSITORY
|
||||||
REPOSITORY=~/.ikiwiki/mtn.db
|
tla my-id "<me@localhost>"
|
||||||
BRANCH=com.company.wikiname
|
cd $SRCDIR
|
||||||
# remember the password you use in the next step and
|
tla archive-setup me@localhost--wiki/wiki--0
|
||||||
# substitute it for 'wikiKeyPass' in the get_passphrase() hook below
|
tla init-tree me@localhost--wiki/wiki--0
|
||||||
# note the you should never generate two monotone keys with the same name
|
# Edit {arch}/=tagging-method and change the precious
|
||||||
mtn genkey web@machine.company.com
|
# line to add the .ikiwiki directory to the regexp.
|
||||||
mtn db init --db=$REPOSITORY
|
tla add *
|
||||||
mv $SRCDIR $SRCDIR-old
|
tla import
|
||||||
cd $SRCDIR-old
|
"""]]
|
||||||
echo ".ikiwiki" > $SRCDIR-old/.mtn-ignore
|
|
||||||
mtn --db=$REPOSITORY --branch=$BRANCH import . -m "initial import"
|
|
||||||
cd ..
|
|
||||||
mtn --db=$REPOSITORY --branch=$BRANCH checkout $SRCDIR
|
|
||||||
mv $SRCDIR-old/.ikiwiki $SRCDIR
|
|
||||||
cat << EOF > $SRCDIR/_MTN/monotonerc
|
|
||||||
function get_passphrase (branchname)
|
|
||||||
return "wikiKeyPass"
|
|
||||||
end
|
|
||||||
EOF
|
|
||||||
rm -r $SRCDIR-old
|
|
||||||
"""]]
|
|
||||||
|
|
||||||
9. Configure ikiwiki to use revision control.
|
[[toggle id=mercurial text="Mercurial"]]
|
||||||
|
[[toggleable id=mercurial text="""
|
||||||
|
REPOSITORY=$SRCDIR
|
||||||
|
hg init $REPOSITORY
|
||||||
|
cd $REPOSITORY
|
||||||
|
hg add *
|
||||||
|
hg commit -m "initial import"
|
||||||
|
"""]]
|
||||||
|
|
||||||
Once your wiki is checked in to the revision control system,
|
[[toggle id=monotone text="Monotone"]]
|
||||||
you should configure ikiwiki to use revision control. Edit your
|
[[toggleable id=monotone text="""
|
||||||
ikiwiki.setup, and uncomment the lines for the revision control system
|
# These instructions are standard instructions to import a directory into monotone
|
||||||
you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using
|
# and set it up so that you don't need any passwords to use it
|
||||||
subversion. Uncomment the block for the wrapper for your revision
|
REPOSITORY=~/.ikiwiki/mtn.db
|
||||||
control system, and configure the wrapper path in that block
|
BRANCH=com.company.wikiname
|
||||||
appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`).
|
# remember the password you use in the next step and
|
||||||
|
# substitute it for 'wikiKeyPass' in the get_passphrase() hook below
|
||||||
|
# note the you should never generate two monotone keys with the same name
|
||||||
|
mtn genkey web@machine.company.com
|
||||||
|
mtn db init --db=$REPOSITORY
|
||||||
|
mv $SRCDIR $SRCDIR-old
|
||||||
|
cd $SRCDIR-old
|
||||||
|
echo ".ikiwiki" > $SRCDIR-old/.mtn-ignore
|
||||||
|
mtn --db=$REPOSITORY --branch=$BRANCH import . -m "initial import"
|
||||||
|
cd ..
|
||||||
|
mtn --db=$REPOSITORY --branch=$BRANCH checkout $SRCDIR
|
||||||
|
mv $SRCDIR-old/.ikiwiki $SRCDIR
|
||||||
|
cat << EOF > $SRCDIR/_MTN/monotonerc
|
||||||
|
function get_passphrase (branchname)
|
||||||
|
return "wikiKeyPass"
|
||||||
|
end
|
||||||
|
EOF
|
||||||
|
rm -r $SRCDIR-old
|
||||||
|
"""]]
|
||||||
|
|
||||||
Once it's all set up, run `ikiwiki --setup ikiwiki.setup` once more.
|
### 9. Configure ikiwiki to use revision control.
|
||||||
Now you should be able to edit files in $SRCDIR, and use your revision
|
|
||||||
control system to commit them, and the wiki will automatically update.
|
|
||||||
And in the web interface, RecentChanges should work, and files changed
|
|
||||||
by web users will also be committed using revision control.
|
|
||||||
|
|
||||||
10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]. And check out
|
Once your wiki is checked in to the revision control system,
|
||||||
[[tips]] to find out how to get more out of ikiwiki.
|
you should configure ikiwiki to use revision control. Edit your
|
||||||
|
ikiwiki.setup, and uncomment the lines for the revision control system
|
||||||
|
you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using
|
||||||
|
subversion. Uncomment the block for the wrapper for your revision
|
||||||
|
control system, and configure the wrapper path in that block
|
||||||
|
appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`).
|
||||||
|
|
||||||
|
Once it's all set up, run `ikiwiki --setup ikiwiki.setup` once more.
|
||||||
|
Now you should be able to edit files in $SRCDIR, and use your revision
|
||||||
|
control system to commit them, and the wiki will automatically update.
|
||||||
|
And in the web interface, RecentChanges should work, and files changed
|
||||||
|
by web users will also be committed using revision control.
|
||||||
|
|
||||||
|
### 10. Enjoy your new wiki!
|
||||||
|
|
||||||
|
Add yourself to [[IkiWikiUsers]]. And check out
|
||||||
|
the [[tips]] to find out how to get more out of ikiwiki.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue