cookbook 'ikiwiki', '= 1.3.1'
ikiwiki (10) Versions 1.3.1 Follow1
Installs ikiwiki with useful plugins and a nice bootstrap 3 theme
cookbook 'ikiwiki', '= 1.3.1', :supermarket
knife supermarket install ikiwiki
knife supermarket download ikiwiki
ikiwiki with bootstrap 3 theme
This cookbook deploys ikiwiki (the best wiki ever!) as well as the bootstrap 3 theme based on Twitter's bootstrap CSS framework. Ikiwiki is a wiki backed by a git repository that updates on commits and uses markdown! Ikiwiki also comes with a clean web interface based on Twitter's Bootstrap 3 for graphical administration and editing. This cookbook deploys ikiwiki in a way that is very similar to the Github wiki but with more features.
Requirements
- Centos 6+
- yum-epel
Attributes
['ikiwiki']['wikiName'] = 'ikiWiki'
['ikiwiki']['wikiNameShort'] = 'ikiWiki'
['ikiwiki']['adminEmail'] = 'admin@mysite.com'
['ikiwiki']['siteUrl'] = 'http://wiki.mysite.com'
['ikiwiki']['wikiAdmin'] = 'ikiwiki'
['ikiwiki']['wikiPass'] = 'ikiwiki'
['ikiwiki']['passworded'] = false
Usage
- Make sure to setup all attributes above before running your cookbook or else it will initialize with the wrong values that wont change!
- Add to your run_list
- After execution put your company logo at
/var/www/html/logo.png
on the wiki server
A user named ikiwiki will be created, apache will be installed and a wiki will be hosted at /var/www/ikiwiki with a git repo at /home/ikiwiki/yourwikiname.git
. If you want to clone that directory, you will need to setup an authorized_keys file at /home/ikiwiki/.ssh/authorized_keys with your public keys in it. You will then do your git clone
as git clone ikiwiki@ikiwikiServer:wikiNameShort.git
.
Ikiwiki has lots of plugins that you can install. Simply edit your /home/ikiwiki/setup.settings
file to enable them and then run ikiwiki --setup /home/ikiwiki/ikiwiki.settings
to run a rebuild on the wiki.
These plugins are enabled by this cookbook but can be disabled easily via the web UI settings page:
- sqlite_search
- color
- highlight
- attachment
- addtag
- hilight
- img
- newpage
- notifyemail
- linkmap
- relativedate
- remove
- heading anchors
If the passworded attribute is set to true, the wiki will require authentication from a user on the system that PAM can auth against. It will not allow system users like root.
Thanks
Thanks to the author of ikiwiki bootstrap 3 and of course ikiwiki!
Contributing
Contributions are welcomed. Lets get ikiwiki out there as a more popular wiki!
License and Authors
Authors: Eric Greer (ericgreer@gmail.com)
Dependent cookbooks
yum-epel >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
ikiwiki CHANGELOG
1.3.1
- Various stability fixes and interface tweaks
1.3.0
- Added full text search that is enabled by default
- Added highlight plugin
1.2.1
Package name typo fix
1.2.0
Added support for password auth and made some fixes for packages required by some plugins
1.1.0
Added more default ikiwiki plugins and packages required by them:
- color
- attachment
- addtag
- hilight
- img
- newpage
- notifyemail
- linkmap
- relativedate
- remove
- heading anchors
1.0.3
Adding plugin instructions
1.0.2
README.md typo
1.0.1
Updating readme to work on chef supermarket site
1.0.0
- Eric Greer - Initial release of ikiwiki
Foodcritic Metric
1.3.1 failed this metric
FC031: Cookbook without metadata file: /tmp/cook/47a0673a71d23142c1a981f0/ikiwiki/metadata.rb:1
FC039: Node method cannot be accessed with key: /tmp/cook/47a0673a71d23142c1a981f0/ikiwiki/attributes/default.rb:17
FC045: Consider setting cookbook name in metadata: /tmp/cook/47a0673a71d23142c1a981f0/ikiwiki/metadata.rb:1
1.3.1 failed this metric
FC039: Node method cannot be accessed with key: /tmp/cook/47a0673a71d23142c1a981f0/ikiwiki/attributes/default.rb:17
FC045: Consider setting cookbook name in metadata: /tmp/cook/47a0673a71d23142c1a981f0/ikiwiki/metadata.rb:1