Skip to content
Simple Wiki engine inspired by Gollum
Clojure CSS HTML Dockerfile
Branch: master
Clone or download

README.md

One wiki to rule them all

Welcome to Smeagol!

Smeagol is a hackable, extensible Wiki engine which is reasonably user-friendly. It uses Markdown as its text format, and Git to provide versioning and backup.

Using Smeagol

Read the [[User Documentation]] for an introduction to all Smeagol's features.

Markup syntax

Smeagol uses the Markdown format as provided by markdown-clj, with the addition that anything enclosed in double square brackets, [[like this]], will be treated as a link into the wiki itself. The markdown format is extensible, and has extensions already for inclusions, for data visualisations and for picture galleries. Read more about [[Extensible Markup]].

Security and authentication

Smeagol now has good security and authentication. While the initial password supplied with the system is not encrypted, when it is changed it will be; and passwords for new users added through the user administration pages are encrypted. Read more about [[Security and authentication]].

Internationalisation

Smeagol has built in internationalisation. Currently it has translation files for English, German, Lithuanian and Russian. We'd welcome volunteers to translate it into other languages.

Images

You can (if you're logged in) upload files, including images, using the Upload a file link on the top menu bar. You can link to an uploaded image, or to other images already available on the web, like this:

Smeagol

Running Smeagol

You can run Smeagol from the [[Docker Image]]; alternatively you can run it from an executable jar file or as a war file in a servlet container. Read how about [[Configuring Smeagol]] and [[Deploying Smeagol]].

Developing Smeagol

Smeagol is an open source project; you're entitled to make changes yourself. Read more about [[Developing Smeagol]].

License

Copyright © 2014-2020 Simon Brooke. Licensed under the GNU General Public License, version 2.0 or (at your option) any later version. If you wish to incorporate parts of Smeagol into another open source project which uses a less restrictive license, please contact me; I'm open to dual licensing it.

Phoning home

Smeagol does currently fetch one image from my home site. Read more about [[Phoning Home]], and how to prevent it (if you want to).

Advertisement

If you like what you see here, I am available for work on open source Clojure projects.

You can’t perform that action at this time.