Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 1.8 KB

README.md

File metadata and controls

98 lines (64 loc) · 1.8 KB

👋 Welcome to wiki-js 🚀

Modern and powerful wiki application

📋 Description

Modern and powerful wiki application

🚀 Services

  • wiki-js: wiki-js/wiki-js:latest

Infrastructure Components

  • wiki-js-db: Postgres database

📦 Installation

Option 1: Quick Install

curl -q -LSsf "https://raw.githubusercontent.com/composemgr/wiki-js/main/docker-compose.yaml" -o compose.yml

Option 2: Git Clone

git clone "https://github.com/composemgr/wiki-js" ~/.local/srv/docker/wiki-js
cd ~/.local/srv/docker/wiki-js
docker compose up -d

Option 3: Using composemgr

composemgr install wiki-js

🔧 Configuration

Environment Variables

TZ=America/New_York

See docker-compose.yaml for complete list of configurable options.

🌐 Access

📂 Volumes

  • ./rootfs/data/wiki-js - Data storage
  • ./rootfs/config/wiki-js - Data storage
  • ./rootfs/data/db/postgres/wiki-js - Data storage

🔐 Security

  • Change all default passwords before deploying to production
  • Use strong secrets for all authentication tokens
  • Configure HTTPS using a reverse proxy (nginx, traefik, caddy)
  • Regularly update Docker images for security patches
  • Backup your data regularly

🔍 Logging

docker compose logs -f wiki-js

🛠️ Management

# Start services
docker compose up -d

# Stop services
docker compose down

# Update to latest images
docker compose pull && docker compose up -d

# View logs
docker compose logs -f

# Restart services
docker compose restart

📋 Requirements

  • Docker Engine 20.10+
  • Docker Compose V2+

🤝 Author

🤖 casjay: Github 🤖
🦄 composemgr: Github 🦄