Skip to content
wavefndPublic

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

Repository files navigation

TechPedia

A multilingual, topic-independent wiki engine maintained by Wave Foundation. Go and BadgerDB serve revisioned TechMark documents with a Vue 3 frontend embedded in the executable. It is a wiki, not a CMS, blog, or social network.

Original engine source is licensed under the Blue Oak Model License 1.0.0, SPDX BlueOak-1.0.0. Copyright 2026 Wave Foundation. Third-party dependencies and fonts retain their own terms.

Documentation

The English guide covers installation, writing, administration, recovery, security, API boundaries and architecture:

The guide is hosted at wavefnd.github.io/techpedia. The source destination is wavefnd/techpedia, branch main. Development and issue tracking use this GitHub repository.

Run an installation

Install Git, Docker Engine and Compose v2, then:

cp .env.example .env
chmod 600 .env
# Edit .env: choose a real owner username and a long random initial password.
./start.sh

The example uses http://localhost:8080 with a loopback host binding. Configure accepted language editions, interface messages and a main page in the administrator panel before ordinary editing. A fresh installation has no imported articles, runtime database or pre-approved language editions.

The owner identity is immutable. Newly registered regular users inherit the configured permission policy, empty by default. Public reading is anonymous; write permissions are verified in Go. The administrator UI remains Korean; public messages and navigation remain configurable per language edition.

Main capabilities

  • Name-based /{locale}/wiki/{name} URLs, revision history, diffs and explicit moves.
  • Independent language documents connected through central Techdata identity.
  • TechMark links, infoboxes, navigation boxes, media carousels and reusable boxes.
  • Administrator-managed editions, permissions, redirects, discussions and audit.
  • Optional administrator-only OAuth/MCP reads and proposals with human diff review; no direct publish or document deletion through MCP.
  • Self-hosted fonts and server-rendered articles with lazy optional tools.

Development

Use the Go version in go.mod and Node 22 or newer. Build frontend assets before Go:

npm ci --prefix web
npm ci --prefix docs
./tests/run.sh
./tests/server.sh

Native Go reads exported environment variables, not .env. Docker is optional for unit tests. Generated frontend assets, dependencies, databases and credentials are excluded from Git.

Use ./tests/run.sh for the complete check suite, or ./tests/run.sh integration for cross-system tests without a server. Run ./tests/server.sh for an isolated native test wiki on loopback. Its database, logs, binaries and temporary files live under ignored .local/test/, never data/. See tests/README.md for setup and test-only credentials. Go test source files are stored in tests/go/; use ./tests/go.sh test ./... to run them in their original package context through Go's overlay support.

Documentation is an isolated VitePress package, not a dependency of the reader:

npm ci --prefix docs
npm run dev --prefix docs
npm run build --prefix docs

Updates and distribution

start.sh builds current source; restart.sh updates from GitHub main and rebuilds; --no-pull rebuilds without a source fetch. Scripts preserve existing .env and data/. Source updates require an approved GitHub origin and a clean main checkout. See source management.

move.sh includes local Git history and is not a public source release archive. Never publish wiki content, images, user data, backups, or secrets as engine source.

See CONTRIBUTING.md, SECURITY.md, and THIRD_PARTY_NOTICES.md. Report vulnerabilities privately. Engine versions use vMAJOR.MINOR.PATCH; maintainers decide releases.

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages