amphora-wiki/README.md

Amphora Wiki

This is a simple wiki based on Pythons Flask framework. There is much great wiki software. Most of them are using some kind of database. I however just want to put my markdown files in a directory and get a working wiki.

Features/To-Dos

• Plain text support for wiki entries
  • Markdown Files (.md)
• Entry page
  • Option to get plain text file
  • Optimize CSS for code
• Start page
  • Overview of pages and namespaces
• Search page
  • Full-text search
  • Show first few lines of each match (preview)
  • Better CSS
• Navigation
  • More advanced namespaces
  • Header
  • Random article
  • Search bar in header
  • Footer
• Switchable CSS
  • CSS dark-theme
  • CSS light-theme
• Config file
• Docker installation
• Logo

Usage

Create entries

Wiki entries are managed by plain markdown files in the templates/entry/ directory. The first line of each document is reserved as the title of the document.

Deployment

PIP/Python

• git clone https://github.com/tiyn/amphora-wiki
• cd amphora-wiki/src
• edit the config.py file according to your needs
• pip3install -r requirements.txt - install depenencies
• run python app.py
• wiki is available on port 5000

Docker

Make sure you copy an example config.py and edit it before running the container. The config.py can be found in the src folder.

Volumes

Set the following volumes with the -v tag.

Volume-Name	Container mount	Description
config-file	/wiki/config.py	Config file
entries	/wiki/templates/entry	Directory for wiki entries
css	/wiki/static/css	(optional) Directory for css files
html	/wiki/templates	(optional) Directory for templates (entry-volume not needed)

Ports

Set the following ports with the -p tag.

Container-Port	Recommended outside port	Protocol	Description
5000	80	TCP	HTTP port

Example run-command

An example run command is shown in rebuild.sh.