diff --git a/README.md b/README.md index 12dcc97..445292c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# dokuwiki +# DokuWiki Installation Guide +This guide provides instructions for setting up DokuWiki using the `linuxserver/dokuwiki` Docker image. + +## Installation Steps + +1. **Create Project Directory** + ```bash + mkdir dokuwiki-project && cd dokuwiki-project + ``` + +2. **Create Data Directory** + ```bash + mkdir dw_data + ``` + +3. **Run Docker Compose** + ```bash + docker-compose up -d + ``` + +4. **Access the Setup Page** + Open your browser and navigate to: + ``` + https:///install.php + ``` + Replace `` with your server's IP address. + +## Configuration Details + +All data and configurations for the `linuxserver/dokuwiki` image are stored within the `/config` directory: + +- **Wiki Pages**: `/config/www/data` +- **Configuration Files**: `/config/www/conf` +- **Plugins**: `/config/www/lib/plugins` +- **Users and ACL**: + - `/config/www/conf/users.auth.php` + - `/config/www/conf/acl.auth.php` \ No newline at end of file