Installation

There are several options for installing and running WikiDB.

Package Managers

If we publish a package for your favorite package manager, this would be the preferred option. We will publish .deb and .pkg packages for each release, but we might expand to other package managers in the future. Packages for each release can be found in the releases page. The binaries distributed in each package are self-contained, so the .NET runtime is not required to run them.

Binaries

If your favorite package manager is not available, you may also obtain binaries for the application. Compiled binaries are released in each release for linux-x64, linux-arm, and linux-arm64. These binaries are all self-contained, so the .NET runtime is not required to run them. The binaries are distributed in an archive named as wikidb-v().().().(platform).tar.gz. Each .tar.gz contains all of the binaries required for the applications (wikidb, wikiget, and wikiserve).

You may run the binaries from anywhere on the system, but be aware that the applications look for configuration files in fixed locations. The applications will always look in ~/.config/wikidb/config.xml and then /etc/wikidb/config.xml. If it fails to find configs, it will not run. You will need to place a config file in one of these two places. Also note that the default config file includes references to files that are installed by default when using a package manager (references to injected styles and html for the archwiki that is configured by default, located in /etc/wikidb/wikis/archwiki/style and /etc/wikidb/wikis/archwiki/header). You will have to reconcile these missing files or remove the references to them.

Build from Source

If none of the above options are appealing, you may also build from source. You will need the .NET Core SDK version 7.

You will first have to clone the git repo to your desired build directory:

$ git clone https://github.com/PilotGuy772/wikidb.git /path/to/build/directory/
$ cd /path/to/build/directory

Next, you will have to run the following SDK commands:

$ dotnet restore
$ dotnet build

To publish for your desired runtime, you will have a few options.

# to publish for linux-x64
$ dotnet publish -c Release
# to publish for any other runtime
$ dotnet publish -c Release -r <rid>

The RID, or runtime ID, is an identifier for the target runtime. Notable options include linux-arm and linux-arm64 for 32-bit or 64-bit ARM systems, win-x64, win-x86, win-arm64, osx-x64, and osx-arm64.