Skip to content
Klutch.sh Docs

Deploying WiKiss

Introduction

WiKiss is an ultra-lightweight, file-based wiki engine written in PHP that requires no database. It stores all content in plain text files, making it incredibly simple to deploy, backup, and maintain. WiKiss is designed for simplicity and ease of use, perfect for personal wikis, small team documentation, or quick knowledge bases.

Key highlights of WiKiss:

  • No Database Required: All pages stored as plain text files for easy backup and portability
  • Single File Engine: The entire wiki engine is contained in a single PHP file
  • Markdown Support: Write pages using simple Markdown syntax
  • Fast and Lightweight: Minimal resource requirements with instant page loads
  • Easy Customization: Simple theming system with CSS customization
  • Portable: Copy your wiki folder to any PHP-enabled server
  • Version History: Optional page revision tracking
  • Search Functionality: Built-in full-text search across all pages

This guide walks through deploying WiKiss on Klutch.sh using Docker with persistent storage for your wiki content.

Why Deploy WiKiss on Klutch.sh

Deploying WiKiss on Klutch.sh provides several advantages:

Simplified Deployment: Klutch.sh handles the container orchestration while WiKiss provides database-free simplicity.

Persistent Storage: Your wiki pages persist across container restarts using Klutch.sh volumes.

HTTPS by Default: Automatic SSL certificates secure your wiki without configuration.

Always Available: Your wiki remains accessible 24/7 without managing infrastructure.

Prerequisites

Before deploying WiKiss on Klutch.sh, ensure you have:

Deploying WiKiss on Klutch.sh

    Create Your Repository

    Create a new GitHub repository with a Dockerfile that sets up WiKiss with PHP:

    FROM php:8.2-apache
    

    # Enable Apache mod_rewrite
    RUN a2enmod rewrite
    

    # Set working directory
    WORKDIR /var/www/html
    

    # Download WiKiss
    RUN apt-get update && apt-get install -y wget unzip \
        && wget https://github.com/music100/WiKiss/archive/refs/heads/master.zip \
        && unzip master.zip \
        && mv WiKiss-master/* . \
        && rm -rf WiKiss-master master.zip \
        && chown -R www-data:www-data /var/www/html
    

    # Expose port 80
    EXPOSE 80

    Push to GitHub

    Push your Dockerfile to your GitHub repository.

    Create a New Project on Klutch.sh

    Navigate to the Klutch.sh dashboard and create a new project.

    Create a New App

    Within your project, create a new app and connect your GitHub repository containing the Dockerfile.

    Configure HTTP Traffic

    Set the traffic type to HTTP with port 80.

    Attach Persistent Volume

    Add a persistent volume mounted at /var/www/html/data to store your wiki pages.

    Deploy Your Application

    Click Deploy to build and launch your WiKiss instance.

    Access WiKiss

    Once deployed, access your wiki at your Klutch.sh URL and start creating pages.

Additional Resources

Conclusion

WiKiss on Klutch.sh provides an incredibly simple wiki solution that requires no database and minimal configuration. Its file-based approach makes backups trivial while persistent volumes ensure your content survives container restarts. Perfect for personal documentation or small team knowledge bases where simplicity is paramount.