<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><div>Dear Users,</div><div><br></div><div>One of the largest complains with FreeRADIUS is the lack of comprehensive documentation.</div><div><br></div><div>The current wiki @ <a href="http://wiki.freeradius.org">wiki.freeradius.org</a> has served its purpose, but has ultimately failed to provide an update to date, well organised source of documentation.</div><div><br></div><div>The current major problems with the wiki are:</div><div>* spam users - which meant we had to lock registration, and discouraged new users from contributing</div><div>* exporting information - all pages are stored in an sql lite instance, which makes it hard to automatically roll pages into releases</div><div>* formatting information - Information stored in the wiki is in the Media wiki format, whereas the documentation bundled with FreeRADIUS is either unformatted or in rst format.</div><div><br></div><div>To try and solve these issues and glue everything together a bit more, i've been working with Alan DeKok to set up a new instance of Gollum. Gollum is a ruby on rails application which exposes a git repository as wiki site. Gollum can render files in many markup languages including plaintext, RST and Mediawiki format, which means we can import all current server documentation, all current wiki documentation and have them neatly presented in a single wiki site. Neat huh?</div><div><br></div><div>But what about spam and registration? Well by default gollum doesn't authenticate anyone. But because it's a rails application we can drop in a library called 'OmniAuth' which uses Oauth to authenticate a bunch of providers.</div><div><br></div><div>This allows us to leverage authentication and spam account prevention services of providers like GitHub, Facebook and Twitter.</div><div><br></div><div>Unfortunately the new wiki isn't ready from primetime. The mediawiki page format renderer in gollum isn't perfect, so we need to convert those pages to RST as a priority.</div><div><br></div><div>If you want to help out, please do the following:</div><div><div>1) Sign up for Facebook, Twitter or GitHub</div><div>2) Go to <a href="http://power.freeradius.org:4567">http://power.freeradius.org:4567</a></div><div>3) Pick a page where the MediaWiki format doesn't render correctly</div><div>4) Edit it</div><div>5) Change edit mode from MediaWiki to reStructuredText</div><div>6) Convert markup to RST (see here: <a href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html">http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html</a>)</div><div>7) Save the page</div><div>8) Get warm fuzzy glow from contributing to open source</div></div><div><br></div><div>Also please report any bugs here:</div><div><a href="https://github.com/github/gollum/issues?_pjax=true&state=open">https://github.com/github/gollum/issues?_pjax=true&state=open</a></div><div><br></div><div>Many Thanks,</div><div>Arran</div><div><br></div><div><br></div><div>
Arran Cudbard-Bell<br>RM-RF Limited - Security consultation and contracting<br>VoIP: +1 916-436-1352 Cell: +44 7854041841<br><br><br><br>
</div>
<br></body></html>