Zavy86/WikiDocs

php -S compatibility

Open

#106 opened on Feb 7, 2024

View on GitHubContributor guide
 (1 comment) (2 reactions) (0 assignees)JavaScript (62 forks)auto 404
enhancementhelp wantedlegacy

Repository metrics

Stars
 (509 stars)
PR merge metrics
 (Avg merge 1d 7h) (30 merged PRs in 30d)

Description

Describe the feature

I would like to be able to run WikiDocs ad-hoc without setting up Apache/NGINX just using PHP's inbuilt web server: php -s localhost:8080 -t WikiDocs/

I fixed it by placing the following code into config.inc.php

if (!isset($_GET['doc'])) {
	$_GET['doc']=ltrim($_SERVER['PATH_INFO'],"/");
}

Please consider it to make it part of WikiDocs. It may be very helpful to have some apps that are able to spin up PHP inbuilt server to provide users with WIKI.

Is your feature request related to a problem? (optional)

The WikiDocs seems to unnecessarily rely on rewriting using Apache/NGINX to set the $_GET['doc'] request variable.

Screenshots (optional)

No response

Extra fields

  • I'd like to work on this feature

Contributor guide

Research direction
Investigate the current request handling in config.inc.php, understand how the 'doc' parameter is normally provided by Apache/NGINX rewrite rules, and test the proposed fallback for PHP's built in server. Verify with a simple wiki page and check for any security implications.
Tech stack
php
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPHP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80