๐Ÿ„Deploy

Deploying a Mycorrhiza wiki is simple.

The rest of the instruction assumes you're using a UNIX-compatible operating system such as macOS or a distribution of GNU+Linux. If you're using Windows or any other obscure system, good luck, I have no knowledge of them. The process will be similar though.

Building

Dependencies

MycorrhizaWiki depends on several
other programs in order to work.

Go

Go is a compiled programming language MycorrhizaWiki is written in. You need a recent version of Go installed. Get it at Go's website. Using your OS's repositories is not recommended because they may be out-of-date.

Git

Git is the most popular version control system. You probably have it installed. If not, consult your OS' repos or download from Git website.

Other dependencies

There is a Makefile in the source code. If you want to use it, you will need make which you probably have installed. If not, consult your OS' repos. You can also avoid using it by invoking the Go compiler directly.

The rest of the dependences will be fetched by the Go compiler automatically. Don't forget to put $GOPATH/bin into your $PATH.

Getting the source code

Visit the GitHub repository

You can download a .zip archive by clicking Code ยป Download ZIP or use this command (recommended):

git clone --recurse-submodules  https://github.com/bouncepaw/mycorrhiza

Either way, you should end up with a folder full of .go files. Let's assume it is located at ~/src/mycorrhiza.

Starting

Use either make run or make build. If you use make run, the engine will be compiled and then run on metarrhiza wiki. It's a default wiki used for testing and for helpful metainformation. You are probably reading this text on that metarrhiza wiki.

The wiki is available now to you and your local network on this address:

If you want to use any other wiki, you need to use a file called mycorrhiza that appears in the folder after running make run or make build. It's the executable.

Running

To start a wiki, run:

~/src/mycorrhiza/mycorrhiza /path/to/your/wiki

Of course, you can move the mycorrhiza file anywhere. Your wiki can also be anywhere.

The only runtime dependency for MycorrhizaWiki is git. It won't start without it. Also, your wiki must be a valid writable git repository. The easiest way to make a git repo is by entering the folder and running this command:

git init

Run this command to see a short summary of configuration options:

~/src/mycorrhiza/mycorrhiza -help

What wiki folders should look like?

You can just base of the default wiki, metarrhiza. This way, you will have handy help built-in. The other option is to run the wiki on an empty repo. An interesting option is to run the wiki on any of your image collections. They'll appear as hyphae!

If you have a subfolder called static, you can customize the wiki behaviour. File static/favicon.ico is used as a favicon for the site. File static/common.css is used for styling. Both are optional.

How to setup authorization?

See authorization