https://github.com/integrii/ikiwiki
A Chef cookbook for deploying ikiwiki with bootstrap 3 and git backend
https://github.com/integrii/ikiwiki
Last synced: 3 months ago
JSON representation
A Chef cookbook for deploying ikiwiki with bootstrap 3 and git backend
- Host: GitHub
- URL: https://github.com/integrii/ikiwiki
- Owner: integrii
- Created: 2014-11-26T06:08:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-12-10T10:02:52.000Z (over 10 years ago)
- Last Synced: 2025-01-14T16:35:39.702Z (5 months ago)
- Language: Perl
- Homepage:
- Size: 457 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
#ikiwiki with bootstrap 3 theme
This cookbook deploys [ikiwiki](https://ikiwiki.info) _(the best wiki ever!)_ as well as the bootstrap 3 theme based on [Twitter's bootstrap CSS framework](http://getbootstrap.com/). 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'] = '[email protected]'
['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](https://ikiwiki.info/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](https://github.com/ramseydsilva/ikiwiki-bootstrap-theme) and of course [ikiwiki](https://ikiwiki.info/)!
Contributing
------------
Contributions are welcomed. Lets get ikiwiki out there as a more popular wiki!
License and Authors
-------------------
Authors: Eric Greer ([email protected])