wiki rego

A lightweight, file-based wiki application written in Go with a React front-end. It supports markdown editing, page revisions, user authentication, and inline Excalidraw diagrams.

Features

• Page Management: Create, read, update, and delete wiki pages.
• Rich Text Editing: Uses CKEditor for WYSIWYG content editing.
• Revision History: Track changes and revert to previous revisions.
• User Authentication: Secure login, password change, and optional account lockout.
• Excalidraw Diagrams: Draw and embed diagrams directly in pages.
• File-Based Storage: Uses a simple filedb for data storage—no external database required.
• Docker Support: Single-container deployment with static Go binary and built React assets.

---

Live Demo

• URL: https://demo.wikigo.site/
• Username: admin
• Password: WikiGoAdmin123

Quick Start (Docker)

An official Docker image is available on Docker Hub: dannyswat/wikirego

1. Run with Docker

# Pull the latest image
docker pull dannyswat/wikirego:latest

# Start container (maps port 8080)
docker run -d \
  --name wikirego \
  -p 8080:8080 \
  -v $(pwd)/server/data:/app/data \
  -v $(pwd)/server/media:/app/media \
  -v $(pwd)/server/conf:/app/conf \
  dannyswat/wikirego:latest

The application will be available at http://localhost:8080

2. Using Docker Compose

A docker-compose.yml is provided for convenience:

# From project root
docker-compose up -d --build

This will build (if needed) and start the wikirego service, mounting server/data and server/media for persistence.

---

Custom Build

Prerequisites

• Go 1.21+
• Node.js 14+ and npm/Yarn
• Git (if using Go modules from VCS)

1. Build and run manually

# From project root
# 1) Build server
cd server
go build -o wikirego.exe ./cmd/web/main.go

# 2) Build client
cd ../client
npm install
npm run build

# 3) Copy client assets into server/public
rm -rf ../server/public/*
cp -r dist/* ../server/public/

# 4) Run the server
cd ../server
./wikirego.exe

The server listens on port 8080 by default. Browse to http://localhost:8080

2. Windows Build (build.bat)

A simple build.bat script is provided:

cd %~dp0
rmdir /s /q build
mkdir build\data
copy release\* build
mkdir build\public
copy server\public\* build\public
cd server
go build -o ..\build\wikirego.exe
cd ..\client
npm install
npm run build
copy dist\* ..\build\public

Run build.bat and then launch build\wikirego.exe.

---

Configuration

The application reads files from:

• Data: server/data (mounted in Docker or local folder)
• Media: server/media (for diagram JSON, SVG, and uploads)
• Conf: server/conf (for configuration)
• Views: server/views (HTML templates)
• Public: server/public (static assets from React build)

---

License

This project is released under the GNU General Public License v2.0 (GPL-2.0), in accordance with the CKEditor license terms. See LICENSE for details.