🍄 Mycorrhiza Wiki 1.2

A wiki engine.

Main wiki

Usage

mycorrhiza [OPTIONS...] WIKI_PATH

WIKI_PATH must be a path to a git repository which you want to be a wiki.

Options:
  -config-path string
        Path to a configuration file. Leave empty if you don't want to use it.
  -print-example-config
        If true, print an example configuration file contents and exit. You can save the output to a file and base your own configuration on it.

Features

Wiki pages (called hyphae) are written in mycomarkup
Edit pages through html forms, a graphical preview and a toolbar that helps you use mycomarkup
Responsive design, dark theme (synced with system theme)
Works in text browsers
Everything is stored as simple files, no database required. You can run a wiki on almost any directory and get something to work with
Page trees; links to previous and next pages
Changes are saved to git
List of hyphae page
History page
Random page
Recent changes page; RSS, Atom and JSON feeds available
Hyphae can be deleted while still preserving history
Hyphae can be renamed (recursive renaming of subhyphae is also supported)
Light on resources
Authorization with pre-set credentials, registration
Basic Gemini protocol support

Building

See the guide on the wiki.

Installing

AUR

You can install Mycorrhiza Wiki from AUR using your favorite package manager on any Arch Linux-derivative distro (Arch, Manjaro, Garuda, etc):

yay -S mycorrhiza  # or mycorrhiza-bin if you don't want to
                   # build it from scratch

Docker

You can run Mycorrhiza Wiki in Docker using Dockerfile provided by this repository. Clone the repo and build the image:

git clone https://github.com/bouncepaw/mycorrhiza/
docker build -t mycorrhiza .

Now you can create a new Mycorrhiza Wiki container using this command:

docker run -v /path/to/wiki:/wiki -p 1737:1737 mycorrhiza

Example:

cd /dev/shm
git clone https://github.com/bouncepaw/mycorrhiza/
docker build -t mycorrhiza .
git clone https://github.com/bouncepaw/example-wiki
docker run -v /dev/shm/example-wiki:/wiki -p 1737:1737 mycorrhiza

Example 2:

# ...
docker run -v /dev/shm/:/config -v /dev/shm/example-wiki:/wiki -p 80:1737 mycorrhiza -config-path /config/myconfig.ini /wiki

Contributing

Help is always needed. We have a tg chat where some development is coordinated. You can also sponsor bouncepaw on boosty. Feel free to open an issue or contact us directly.

You can view list of all planned features on our kanban board.

2.7 KiB Raw Blame History