Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.94 KB

README.md

File metadata and controls

58 lines (37 loc) · 2.94 KB
Raw

dokuwiki-preconfigured

You could stop at 5 or 6 stores - or just one!

This is the umbrella project for a "batteries included" distribution of DokuWiki. Its goal is to provide a seamless setup and user experience. Its main components are:

  • A docker-compose file
  • Some scripts for common operations (backup/restore, use not required)
  • More sensible defaults (hierarchical breadcrumbs instead of a view history, pretty URLs, SVG as allowed media format)
  • Some useful plugins
  • Krypton theme (polished version of the Argon theme)
  • Polished up Visual Editor

Work is ongoing. Check Status for updates.

Installation speed run. The code block is run in and the availability of the Wiki shown

Deployment using docker-compose

This repo contains a docker-compose.yml file you can use to get started. Just clone this repository and docker-compose up:

git clone https://github.com/fablab-luenen/dokuwiki-preconfigured
cd dokuwiki-preconfigured
./start

The first time it's run it will start a docker build, which inolves pulling the base image linuxserver/docker-dokuwiki and doing some modifications on top of it.

Goals

The general goal of this distribution is to establish a good alternative to proprietary wikis (namely Confluence). This translates into the following main goals:

  • Ease of use (UX design/placement of buttons and menus)
  • Clean styling (low clutter)
  • Easy setup

Caveats

  • The initially supported languages are de-informal and en
  • It lacks a good name. Do you have an idea? Let me know!

See Krypton issues and Visual Editor issues, as well as the issues of the projects they're based on.

Status

Lately (2022-02-13) the contributions have slowed a little because the Wiki is now in active use and in a state I consider close to "good enough".

While there's still a lot to do to perfect the experience, I think it's already quite an improvement. Check out issues, PRs, Discussions and commits of the sub-projects for updates. The preview on this page may be outdated.

Thanks

Thank you to everyone who originally made the projects used in this distribution!

  • Linuxserver.io for making the base image
  • Cosmocode for making the visual editor
  • IceWreck, SoarinFerret, llune for creating the Argon theme
  • Myself (solarkraft) for the polishing effort ;-)