Skip to content

Homebrew Formula to install ikiwiki (basic install, work in progress)

License

Notifications You must be signed in to change notification settings

naosnz/homebrew-ikiwiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Homebrew packaging for ikiwiki

ikiwiki is a Markdown wiki compiler, written in Perl. It has a core plus many extension modules.

It was originally developed by Joey Hess.

Installation from Homebrew

A basic install of the ikiwiki tool (with minimal modules enabled) can be installed with:

brew install naosnz/ikiwiki/ikiwiki

Or as two separate steps:

brew tap naosnz/ikiwiki brew install ikiwiki.

Documentation

The ikiwiki setup guide is a good place to start for learning how to use ikiwiki. Note that the auto.setup, auto-blog.setup, and wikilist file are installed into the Homebrew etc directory (eg, /usr/local/etc/ikiwiki/auto.setup) so the example automated setup would be something like:

ikiwiki --setup /usr/local/etc/ikiwiki/auto.setup

Alternatively set up the Wiki by hand which gives much more control over which steps are done. Note that if you are testing in, eg, /tmp on macOS, this a symlink, so you will need something ikke:

ikiwiki --verbose "${SRCDIR}" "${DESTDIR}" --url="http://localhost:8000/" --set "allow_symlinks_before_srcdir=1"

to set the option that permits symlinks in th source path. (The allow_symlinks_before_srcdir was added a security feature for web editable wikis, in about 2008.)

Licensing

ikiwiki is available under a GPLv2+ license. This Homebrew Formula to facilitate installing it is available under a MIT License; see the LICENSE file for the text of the MIT License.

Caveats

So far (2024-02-05) this Formula has only been very lightly tested, and only on macOS Ventura (13). It relies on the macOS system perl, which ships with several CPAN modules pre installed. Some of those preinstalled CPAN modules are relied on.

Since only the core perl dependencies are installed it is likely that anything other than command line usage will not work.

About

Homebrew Formula to install ikiwiki (basic install, work in progress)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages