MYCORRHIZA(1)

📦 version 1.15.1, in alpine 3.24

💖 MYCORRHIZA(1) 💖

ok so this is the manual page for mycorrhiza, living in the General Commands Manual section. yes bestie, we're doing the whole thing. grab a snack. 🍓

✨ NAME ✨

mycorrhiza — serve a wiki from mycomarkup pages in a git repo

like... it's a wiki. it's in git. the pages are written in Mycomarkup. that's the whole vibe. 🦋

🌸 SYNOPSIS 🌸

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

👑 DESCRIPTION 👑

So Mycorrhiza Wiki is a lightweight wiki engine. It uses Git repositories as the way it keeps history (yes, that git), and it gives you a custom-made markup language called Mycomarkup for authoring pages. Your pages are literally written in it. 💅

The only runtime dependency is the git command-line program. that's it. one (1) dependency. iconic behaviour honestly. 👑

The web interface does viewing and editing, history, administration, and simple search. all of it. 🫶

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 doesn't exist, it's automatically created, and the configuration is populated with default values. The default configuration file (config.ini) includes comments describing different options — so yes, it documents itself, slay. ✨

The options are as follows:

🎀 OPTIONS 🎀

  • -help — Display help. that's it, that's the option. short and sweet. 💖
  • -create-admin username — Create a new user with name set to username, and give them administrative rights. The password is prompted in the terminal. so like, it will ask you. don't panic. 🔥
  • -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. no cap, it has to be valid. 💀

🦋 FILES 🦋

  • wiki/wiki.git/ — Git repository containing all hyphae (pages) in the wiki. yes, the pages are called hyphae. mushroom lore. 🍄
  • wiki/static/ — Directory holding static assets not tracked by Git and not editable by users. it's static, bestie, leave it alone. 🙈
  • wiki/cache/ — Storage for temporary files, such as session tokens. temporary things go here. 🔥
  • wiki/config.ini — Main configuration file with options required for operation. Not editable through the web interface. you gotta go in with your own two hands. 💅
  • wiki/users.json — User database that contains basic user information and hashed passwords, serialized as a JSON file. hashed, not plain. we're responsible here. 🔐

🌈 SEE ALSO 🌈

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/

like, the docs are inside the wiki. very main character energy. 👑

💜 AUTHORS 💜

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

okay that's the whole page!! you read it, I'm proud of you 💖✨🎀🦋🌸💅🫶😭🔥👑🌈⭐💀🙈🍓🧚💜

and for the record, this lovely thing came from the Debian folks, dated March 24, 2022 — yes it's giving vintage but it's still serving. periodt. 💅

📦 where this page comes from