Wiki logo

Fox Wiki

WikiMD Playground

Configurations

Last updated: November 1, 2025

Configuration Guide

This document explains how to configure FoxWiki for deployment, including data sources and branding options.

Configuration Options

FoxWiki can be configured using environment variables. When running in a Docker container, you can provide these variables through a
.env
file or directly in your Docker Compose or Kubernetes configuration.

Variant Support Configuration

FoxWiki supports multiple variants (e.g., different languages or versions):

Environment Variable

Description

Default Value

WIKI_ENABLE_VARIANTSEnable variant support (true or false)false
WIKI_DEFAULT_VARIANTDefault variant to useenglish

Branding Configuration

You can customize the appearance and branding of your wiki.
Icon handling:
  • Place an
    icon.svg
    (preferred) or
    icon.png
    file at the root of your wiki content directory (for markdown mode this is your
    WIKI_MARKDOWN_DIR
    , e.g.,
    /docs
    ).
  • FoxWiki will automatically use that file as the site icon and app icon. If neither file exists, it falls back to the built-in
    /fox_icon.png
    .

Environment Variable

Description

Default Value

WIKI_NAMEName of the wikiFox Wiki
WIKI_SITE_URLURL of the wiki sitehttps://wiki.orangefox.tech

Data Refetching

Environment Variable

Description

Default Value

WIKI_REFETCH_INTERVALInterval in seconds to refetch wiki content in foxapi mode. Set to 0 to disable.3600

Color Scheme Configuration

FoxWiki supports detailed color scheme customization for both light and dark themes. You can configure colors for different shades (50, 100, 200, 300, 400, 500, 600, 700, 800, 900) where 500 is the brand color:

Light Theme Primary Colors

Environment Variable

Description

Default Value

WIKI_COLOR_LIGHT_PRIMARY_50Lightest primary color#fff3e1
WIKI_COLOR_LIGHT_PRIMARY_100Very light primary color#ffe0b0
WIKI_COLOR_LIGHT_PRIMARY_200Light primary color#ffcc7e
WIKI_COLOR_LIGHT_PRIMARY_300Medium light primary color#ffb74d
WIKI_COLOR_LIGHT_PRIMARY_400Medium primary color#ffa726
WIKI_COLOR_LIGHT_PRIMARY_500Brand primary color#ed7002
WIKI_COLOR_LIGHT_PRIMARY_600Medium dark primary color#e65c00
WIKI_COLOR_LIGHT_PRIMARY_700Dark primary color#d84c00
WIKI_COLOR_LIGHT_PRIMARY_800Very dark primary color#c73e00
WIKI_COLOR_LIGHT_PRIMARY_900Darkest primary color#ae3200

Light Theme Neutral Colors

Environment Variable

Description

Default Value

WIKI_COLOR_LIGHT_NEUTRAL_100Very light neutral color#f9f2e8
WIKI_COLOR_LIGHT_NEUTRAL_200Light neutral color#eedfc8
WIKI_COLOR_LIGHT_NEUTRAL_300Medium light neutral color#c4a68b
WIKI_COLOR_LIGHT_NEUTRAL_400Medium neutral color#c4a68b
WIKI_COLOR_LIGHT_NEUTRAL_500Brand neutral color#957a63
WIKI_COLOR_LIGHT_NEUTRAL_600Medium dark neutral color#5a4a38
WIKI_COLOR_LIGHT_NEUTRAL_700Dark neutral color#3c3125
WIKI_COLOR_LIGHT_NEUTRAL_800Very dark neutral color#271f17
WIKI_COLOR_LIGHT_NEUTRAL_900Darkest neutral color#130e0b

Dark Theme Primary Colors

Environment Variable

Description

Default Value

WIKI_COLOR_DARK_PRIMARY_50Lightest primary color#fff3e1
WIKI_COLOR_DARK_PRIMARY_100Very light primary color#ffe0b0
WIKI_COLOR_DARK_PRIMARY_200Light primary color#ffcc7e
WIKI_COLOR_DARK_PRIMARY_300Medium light primary color#ffb74d
WIKI_COLOR_DARK_PRIMARY_400Medium primary color#ffa726
WIKI_COLOR_DARK_PRIMARY_500Brand primary color#ed7002
WIKI_COLOR_DARK_PRIMARY_600Medium dark primary color#e65c00
WIKI_COLOR_DARK_PRIMARY_700Dark primary color#d84c00
WIKI_COLOR_DARK_PRIMARY_800Very dark primary color#c73e00
WIKI_COLOR_DARK_PRIMARY_900Darkest primary color#ae3200

Dark Theme Neutral Colors

Environment Variable

Description

Default Value

WIKI_COLOR_DARK_NEUTRAL_100Very light neutral color#f9f2e8
WIKI_COLOR_DARK_NEUTRAL_200Light neutral color#eedfc8
WIKI_COLOR_DARK_NEUTRAL_300Medium light neutral color#c4a68b
WIKI_COLOR_DARK_NEUTRAL_400Medium neutral color#c4a68b
WIKI_COLOR_DARK_NEUTRAL_500Brand neutral color#957a63
WIKI_COLOR_DARK_NEUTRAL_600Medium dark neutral color#5a4a38
WIKI_COLOR_DARK_NEUTRAL_700Dark neutral color#3c3125
WIKI_COLOR_DARK_NEUTRAL_800Very dark neutral color#271f17
You can configure the links in the header using the
WIKI_HEADER_LINKS
environment variable. The format is:
Where:
  • Label
    is the text displayed for the link
  • URL
    is the destination URL
  • external
    (optional) indicates if the link should open in a new tab
Default header links:
  • Wiki:
    /

Docker Deployment Example

Here's an example of how to configure FoxWiki in a Docker Compose file:

Using with Environment Variables

When deploying FoxWiki in a Docker container, you can create a
.env
file and attach it to the container:
Then run your Docker container with: