Skip to content

Installation Guide

This guide covers the detailed installation process for U.WIKI.

System Requirements

  • Operating System: Windows, macOS, or Linux
  • Python: 3.8 or higher
  • Memory: 512MB RAM minimum
  • Disk Space: 100MB for installation

Step-by-Step Installation

1. Install Python

First, ensure you have Python installed:

python3 --version

If Python is not installed, download it from python.org.

2. Clone the Repository

git clone https://github.com/yourusername/U.WIKI.git
cd U.WIKI

3. Create Virtual Environment

python3 -m venv venv
source venv/bin/activate

python -m venv venv
venv\Scripts\activate

4. Install Dependencies

pip install -r requirements.txt

This installs: - MkDocs - Static site generator - Material for MkDocs - Theme - Extensions - Additional functionality

5. Verify Installation

mkdocs --version

You should see the MkDocs version number.

Troubleshooting

Common Issues

Python venv not available

If you get an error about venv not being available:

# Ubuntu/Debian
sudo apt install python3-venv

# Fedora
sudo dnf install python3-venv

# macOS (with Homebrew)
brew install python3

Permission Errors

If you encounter permission errors:

# Use --user flag
pip install --user -r requirements.txt

SSL Certificate Errors

If you have SSL certificate issues:

pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org -r requirements.txt

Next Steps

Once installed, you can:

  1. Start the development server
  2. Configure your wiki
  3. Create your first page

Updating

To update to the latest version:

git pull origin main
pip install -r requirements.txt --upgrade