Girish Ramakrishnan преди 9 години
родител
ревизия
066ba43e67
променени са 1 файла, в които са добавени 44 реда и са изтрити 11 реда
  1. 44 11
      README.md

+ 44 - 11
README.md

@@ -1,16 +1,44 @@
-Wordpress App
-=============
+# Wordpress Cloudron App
 
-Source
-------
-https://wordpress.org/download/
+This repository contains the Cloudron app package source for [Wordpress](https://wordpress.org/).
 
+## Installation
+
+[![Install](https://cloudron.io/img/button32.png)](https://cloudron.io/button.html?app=org.wordpress.cloudronapp)
+
+or using the [Cloudron command line tooling](https://cloudron.io/references/cli.html)
+
+```
+cloudron install --appstore-id org.wordpress.cloudronapp
+```
+
+## Building
+
+The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
+
+```
+cd wordpress-app
+
+cloudron build
+cloudron install
+```
+
+## Testing
+
+The e2e tests are located in the `test/` folder and require [nodejs](http://nodejs.org/). They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the posts are still ok.
+
+```
+cd wordpress-app/test
+
+npm install
+USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test.js
+```
+
+## Debugging
 
-Notes
------
 The site_url() will always be the location where you can reach the site by tacking on /wp-admin on the end, while home_url() would not reliably be this location.
 
-put this in wp-config.php for debugging
+Put this in wp-config.php for debugging
 
  // Enable WP_DEBUG mode
 define('WP_DEBUG', true);
@@ -25,8 +53,6 @@ define('WP_DEBUG_DISPLAY', false);
 // Use dev versions of core JS and CSS files (only needed if you are modifying these core files)
 define('SCRIPT_DEBUG', true);
 
-
-
 if ( true === WP_DEBUG ) {
     if ( is_array( $log ) || is_object( $log ) ) {
         error_log( print_r( $log, true ) );
@@ -35,5 +61,12 @@ if ( true === WP_DEBUG ) {
     }
 }
 
-The install step seems to install cookies! When testing using docker, make sure that the cookies of a previous install are cleared. Otherwise, one keeps getting a 304.
+## LDAP Plugin
+
+Various LDAP plugins were tested when this app was made.
+* [Active Directory Integration](https://wordpress.org/plugins/active-directory-integration/) - Very AD friendly
+* [wpDirAuth](https://wordpress.org/plugins/wpdirauth/) - No role mapping
+* [Simple LDAP](https://wordpress.org/plugins/simple-ldap-login/) - default role, no authenticated bind
+* [authLdap](https://wordpress.org/plugins/authldap/) - no authenticated bind
+* [LDAP LPRM](https://wordpress.org/plugins/ldap-login-password-and-role-manager/) - has role mapping which maps integer in LDAP to wp db entry, auth bind