Skip to content
Browse files

EXAMPLE.txt is now USAGE.txt

git-svn-id: svn://cherokee-project.com/wizards2@6807 5dc97367-97f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent e56a859 commit fa3a0dc7d8e0589fd9c74e97252cb890eaf853d0 @alobbs alobbs committed Aug 15, 2011
Showing with 38 additions and 1 deletion.
  1. +0 −1 doc/EXAMPLE.txt
  2. +38 −0 doc/USAGE.txt
View
1 doc/EXAMPLE.txt
@@ -1 +0,0 @@
-PYTHONPATH=~/prog/cherokee/admin/CTK:~/prog/cherokee/admin/ ./cherokee-wizard install 02-Content\ Management\ Systems/wordpress.py config=/tmp/hh type=vserver app_dir=/tmp/app vserver_nick=example.com
View
38 doc/USAGE.txt
@@ -0,0 +1,38 @@
+Usage
+-----
+cherokee-wizard <command> <wizard> [<param>=<value>]
+
+Commands
+--------
+install - Performs an app installation
+
+Common parameters
+-----------------
+config - Path to the Cherokee configuration file to be modified. [required]
+
+type - Type of the installation. [required]
+ Accepted values:
+ * "vserver": Create a new virtual server for the app
+ * "directory": Install it inside a directory of an existing vserver
+
+app_dir - Local directory where the app should be deployed [optional]
+
+vserver_nick - Name of the new virtual server (if type=vserver) [required]
+
+fetch_app - URL/Path to the source package [optional]
+ Accepted values:
+ * "auto": Download the app automatically
+ * <URL>: Download certain source package
+ * <PATH>: User certain source package
+
+Example
+-------
+./cherokee-wizard install 02-Content\ Management\ Systems/wordpress.py \
+config=/tmp/cherokee.conf type=vserver app_dir=/tmp/wp_inst vserver_nick=example.com
+
+
+TEMP
+----
+PYTHONPATH=~/prog/cherokee/admin/CTK:~/prog/cherokee/admin/ \
+./cherokee-wizard install 02-Content\ Management\ Systems/wordpress.py \
+config=/tmp/hh type=vserver app_dir=/tmp/app vserver_nick=example.com

0 comments on commit fa3a0dc

Please sign in to comment.
Something went wrong with that request. Please try again.