MYCORRHIZA(1)

NAME
mycorrhiza - serve a wiki from mycomarkup pages in a git repo

SYNOPSIS
mycorrhiza [-help] [-create-admin username] [-listen-addr addr] wiki-path

DESCRIPTION
Mycorrhiza Wiki is a lightweight wiki engine. It uses Git repositories as a means of keeping history, and provides a custom-made markup language called Mycomarkup for authoring pages. The only runtime dependency is the git command-line program. The web interface provides viewing and editing capabilities, history, administration, and simple search.

The mycorrhiza program serves a web interface for the wiki located in wiki-path, on the address specified by addr or the configuration file. If the wiki directory does not exist, it's automatically created, and the configuration is populated with default values. The default configuration file (config.ini) includes comments describing different options.

The options are as follows:

-help
    Display help.

-create-admin username
    Create a new user with name set to username, and give them administrative rights. The password is prompted in the terminal.

-listen-addr addr
    Listen on addr instead of the value specified in the configuration file. addr must be a valid socket address (either a path to a local Unix socket, or an address:port pair).

FILES
wiki/wiki.git/
    Git repository containing all hyphae (pages) in the wiki.
wiki/static/
    Directory holding static assets not tracked by Git and not editable by users.
wiki/cache/
    Storage for temporary files, such as session tokens.
wiki/config.ini
    Main configuration file with options required for operation. Not editable through the web interface.
wiki/users.json
    User database that contains basic user information and hashed passwords, serialized as a JSON file.

SEE ALSO
https://mycorrhiza.wiki/

There's built-in documentation available. You can access it by visiting /help/ on a live wiki, or by following the Help link in the default header, if available. For example: https://mycorrhiza.wiki/help/

AUTHORS
Created and maintained by Timur Ismagilov <bouncepaw2@ya.ru> with help from other contributors.