Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vndmtrx committed Nov 16, 2024
1 parent 75a8a89 commit 6a09031
Showing 1 changed file with 56 additions and 22 deletions.
78 changes: 56 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,8 @@ A secure, rootless Docker image for DokuWiki with persistent storage support.

- 🐳 Based on official PHP 8.3 Apache image
- 🔒 Runs as non-root user (www-data)
- 📁 Persistent storage for:
- Configuration files
- Wiki data and pages
- Plugins
- Templates
- Cache
- ⚙️ Full environment variable configuration
- 📁 Persistent storage for configuration, data, plugins and templates

## 🚀 Quick Start

Expand All @@ -20,23 +16,62 @@ A secure, rootless Docker image for DokuWiki with persistent storage support.
# Create persistent volume
docker volume create dokuwiki_data

# Run container
# Run container with basic configuration
docker run -d \
--name dokuwiki \
-p 8080:80 \
-v dokuwiki_data:/dokuwiki \
-e DOKUWIKI_TITLE="My Wiki" \
-e DOKUWIKI_SUPERUSER=admin \
-e DOKUWIKI_SUPERPASS=mysecurepass \
-e DOKUWIKI_FULLNAME="Wiki Admin" \
-e [email protected] \
--user www-data \
vndmtrx/dokuwiki:latest
```

### Using Docker Compose
```bash
# Create persistent volume
docker volume create dokuwiki_data

# Start services
docker compose up -d
```
Check the docker-compose.yml file in the repository for a complete example with all available options.

## 🔧 Environment Variables

### Basic Configuration
| Variable | Install.php Equivalent | Description |
|----------|----------------------|-------------|
| DOKUWIKI_TITLE | Wiki Name | Site title |
| DOKUWIKI_TAGLINE | Tag Line | Site description |
| DOKUWIKI_LANG | Language | Interface language |
| DOKUWIKI_LICENSE | License | Content license |
| DOKUWIKI_BASEURL | Base URL | Wiki URL |

### User Management
| Variable | Install.php Equivalent | Description |
|----------|----------------------|-------------|
| DOKUWIKI_SUPERUSER | Superuser | Admin username |
| DOKUWIKI_SUPERPASS | Password | Admin password |
| DOKUWIKI_FULLNAME | Real Name | Admin full name |
| DOKUWIKI_EMAIL | E-Mail | Admin email |

### Access Control
| Variable | Install.php Equivalent | Description | Default |
|----------|----------------------|-------------|---------|
| DOKUWIKI_USEACL | Use ACL | Enable access control | - |
| DOKUWIKI_AUTHTYPE | Authentication Backend | Auth mechanism | - |
| DOKUWIKI_DEFAULTGROUP | Initial Group | Default group for new users | - |
| DOKUWIKI_DISABLEACTIONS | Disabled Actions | Disabled features | - |
| DOKUWIKI_ACL_POLICY | Initial ACL policy | Access policy (open/public/closed) | open |

### Important Notes About Installation

If environment variables are provided:
- The wiki will be pre-configured with these settings
- The install.php file will be automatically removed for security
- No manual configuration will be needed

If no environment variables are set:
- The install.php wizard will be available at first access
- Manual configuration will be required through the web interface
- The install.php will remain until manual configuration is completed

## 📁 Volume Structure

Expand All @@ -46,23 +81,22 @@ The `/dokuwiki` volume contains:
- `plugins/`: DokuWiki plugins
- `tpl/`: Templates

## 🛠️ Configuration

After starting the container, access:
```
http://localhost:8080/install.php
```

## 🔒 Security

- Runs as non-root user (www-data)
- No new privileges allowed
- Minimal base image and dependencies
- Automatic removal of install.php after configuration when using environment variables

## 📜 License
## 📜 Licenses

[GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html)

This project builds upon other open source software:

- **DokuWiki**: [GNU General Public License v2.0](https://github.com/dokuwiki/dokuwiki/blob/master/LICENSE)
- **PHP**: [PHP License v3.01](https://www.php.net/license/3_01.txt)

## 🔗 Links

- [Docker Hub](https://hub.docker.com/r/vndmtrx/dokuwiki)
Expand Down

0 comments on commit 6a09031

Please sign in to comment.