Keep in mind, this mode can be used for production, but it is not recommended. The whole directory must be scanned on each request. This might not make a big impact on small documentations but can be a bottleneck on bigger ones. ## Running Locally There are several ways to run the docs locally. You can use something like <a href="http://www.mamp.info/en/index.html" target="_blank">MAMP</a> or <a href="http://www.wampserver.com/en/" target="_blank">WAMP</a>. The easiest is to use PHP's built-in server. For that i've included a short command, run `daux serve` in the projects folder to start the local web server. By default the server will run at: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a> ## Running Remotely ### Clean URLs configuration Daux provides native support for Clean URLs provided the webserver has its URL Rewrite module enabled. To enable the same, set the toggle in the `config.json` file in the `/docs` folder. ```json { "live": { "clean_urls": true } } ``` ### Apache Copy the files from the repo to a web server that can run PHP 5.6 or greater. There is an included `.htaccess` for Apache web server. ### Nginx Daux.io works perfectly fine on Nginx too, just drop this configuration in your `nginx.conf` ``` server { listen 8085; server_name localhost; index index.html index.php; charset utf-8; root /var/www/docs; location / { if (!-e $request_filename){ rewrite ^(.*)$ /index.php$1; } } location ~ \.php { fastcgi_split_path_info ^(.+\.php)(/.+)$; fastcgi_pass unix:/var/run/php5-fpm.sock; #fastcgi_pass 127.0.0.1:9000; fastcgi_index index.php; include fastcgi_params; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; fastcgi_param PATH_INFO $fastcgi_path_info; } } ``` ## IIS If you have set up a local or remote IIS web site, you may need a `web.config` with: * A rewrite configuration, for handling clean urls. * A mime type handler for less files, if using a custom theme. ### Clean URLs The `web.config` needs an entry for `<rewrite>` under `<system.webServer>`: ```xml <configuration> <system.webServer> <rewrite> <rules> <rule name="Main Rule" stopProcessing="true"> <match url=".*" /> <conditions logicalGrouping="MatchAll"> <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" /> <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" /> </conditions> <action type="Rewrite" url="index.php" appendQueryString="false" /> </rule> </rules> </rewrite> </system.webServer> </configuration> ``` To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as [URL Rewriter](http://urlrewriter.net/).