files

Documentation

Overview

Package files is used to get paths to different files Mycorrhiza uses. Also see cfg.

Index

• func CategoriesJSON() string
• func ConfigPath() string
• func FileInRoot(filename string) string
• func GitRepo() string
• func HyphaeDir() string
• func InterwikiJSON() string
• func PrepareWikiRoot() error
• func StaticFiles() string
• func TokensJSON() string
• func UserCredentialsJSON() string

Functions

func CategoriesJSON

func CategoriesJSON() string

CategoriesJSON returns the path to the JSON categories storage.

func ConfigPath

func ConfigPath() string

ConfigPath returns the path to the config file.

func FileInRoot

func FileInRoot(filename string) string

FileInRoot returns full path for the given filename if it was placed in the root of the wiki structure.

func GitRepo

func GitRepo() string

GitRepo returns the path to the Git repository of the wiki.

func HyphaeDir

func HyphaeDir() string

HyphaeDir returns the path to hyphae storage. A separate function is needed to easily know where a general storage path is needed rather than a concrete Git or the whole wiki storage path, so that we could easily refactor things later if we'll ever support different storages.

func InterwikiJSON

func InterwikiJSON() string

func PrepareWikiRoot

func PrepareWikiRoot() error

PrepareWikiRoot ensures all needed directories and files exist and have correct permissions.

func StaticFiles

func StaticFiles() string

StaticFiles returns the path to static files directory

func TokensJSON

func TokensJSON() string

TokensJSON returns the path to the JSON user tokens storage.

func UserCredentialsJSON

func UserCredentialsJSON() string

UserCredentialsJSON returns the path to the JSON user credentials storage.