Fixed mkdir bug that was breaking on multi-level directory arg
[project/apps.git] / README.txt
1 -- SUMMARY --
2
3 The Apps module provides a much better user experience of extending your Drupal site by providing facilities to download modules and all of their dependencies in one easy step.
4
5 For a full description of the module, visit the project page:
6   http://drupal.org/project/apps
7
8 To submit bug reports and feature suggestions, or to track changes:
9     http://drupal.org/project/issues/apps
10
11 A video tutorial is available here:  http://youtu.be/SF7bZw9wCwg
12
13
14 -- REQUIREMENTS --
15
16 A connector module is needed to access an app's server.
17  * An example of a connector module is Level Ten Apps http://drupal.org/project/levelten_apps
18
19 -- INSTALLATION --
20
21 * Install as usual, see http://drupal.org/node/70151 for further information.
22
23 * An Apps tab will open up in the Administration bar
24
25 * To install an app, click the Apps tab, which will bring up the apps available to you.
26
27 * Click a specific app's page and choose "install app"
28
29 * The necessary modules will then be downloaded to your Drupal site
30      
31
32 -- CONFIGURATION --
33
34 * After an app is done downloading, a configuration page will appear.
35
36 * Configure user permissions in Administration  People  Permissions:
37
38        
39 -- CUSTOMIZATION --
40
41
42
43
44 -- TROUBLESHOOTING --
45
46
47 -- FAQ --
48
49 *I am having trouble installing Apps that contain files from a GitHub download URL*
50
51 GitHub download URLs are typically of the style, http://github.com/user/repo/tarball/branch
52 Drupal's downloader and GitHub's download URLs have typically not played nice
53 together, so we recommend either appending a filename to the end of the GitHub
54 URL such as, http://github.com/user/repo/tarball/branch/filename.tar.gz or
55 using a utility such as http://githubredir.debian.net/ to generate those
56 URLs for you.
57
58
59 -- APP INSTALLATION --
60
61 Apps uses the same mechanism for installing modules as the update module in
62 core. This depends on certain php extensions to be installed on your server.
63 Below is the documentation for the various methods of installing.
64
65 *Install via FTP*
66
67 In order to install via ftp, you must have the ftp php extension enabled.
68 Most apache2/php installs have this by default which is by it probably shows
69 up on most installs. You may run into a server that doesn't have ftp so then
70 you will need to install it or use an alternative method. See
71 http://us2.php.net/manual/en/book.ftp.php for how to install the ftp php
72 extension. You will also need an ftp username and password that has rights
73 to write to your site directory on your server.
74
75 *Install via SSH*
76
77 This is the recommended method of install
78
79 In order to install via ssh, you must have the ssh2 php extension installed
80 and enabled. This does not come by default with many apache2/php installs
81 so it commonly needs to be added. See http://us2.php.net/manual/en/book.ssh2.php
82 for how to install the ssh2 php extension. You will also need a username and
83 password of a user that can ssh into the server and has write permissions to
84 your site directory on your server.
85
86 *Install directly to sites directory*
87
88 This is not the preferred method of install and should be a last resort.
89
90 In order to install directly the sites/all/modules directory it needs to be
91 writable. In order to do this go to the root of your drupal install and type
92
93 sudo chmod 777 sites/all/modules
94
95 Additionally you need write access to sites/all/libraries (or if that does not
96 exist, then sites/all).  In order to give this access you should go to the root
97 of your drupal install and type
98
99 sudo chmod 777 sites/all/libraries
100
101 If you get an error that sites/all/libraries does not exist, you can either
102 create it first and give it the proper permissions or open up the permissions
103 on sites/all like so:
104
105 sudo chmod 777 sites/all
106
107 Be aware that there are security issues with leaving your site in this state.
108
109 -- APP UNINSTALL --
110 When an app is uninstalled, it should remove or cleanup items that a normal
111 Drupal module would do via hook_uninstall. This includes variables that the
112 module has set and modifications to existing tables. If there is content
113 that the app has created that makes sense to remove, it should be deleted.
114 If contexts, views, etc. were created by code, then disabling or uninstalling
115 the app will remove them automatically. Features won't remove content types,
116 but will make them eligible to delete.
117
118 See also: hook_uninstall [1]
119
120 -- DEFAULT CONTENT --
121 If an app provides default content provided by the defaultcontent module, it
122 has to be listed as a dependency for the app. Any app's demo content module
123 that uses the defaultcontent module for its content should include it as a
124 dependency.
125
126 The dependency will be listed automatically in the .info file when creating
127 the feature to be used as the app's demo content module with the following:
128
129 dependencies[] = "defaultcontent"
130
131 The dependency should be added to the app manifest by specifying both the
132 dependency and download location. The following lines added to the app
133 manifest specifies a dependency on version 7.x-1.0-alpha6:
134
135 dependencies[defaultcontent] = defaultcontent 1.0-alpha6
136 downloadables[defaultcontent 1.0-alpha4] = http://ftp.drupal.org/files/projects/defaultcontent-7.x-1.0-alpha6.tar.gz
137
138 See also: Default Content Module [2]
139
140 -- CONTACT --
141
142 Current maintainers:
143 * randallknutson - http://drupal.org/user/183932
144 * febbraro - http://drupal.org/user/43670
145 * jec006 - http://drupal.org/user/855980
146 * tirdadc - http://drupal.org/user/383630
147
148
149 [1]: http://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_uninstall/7
150 [2]: http://drupal.org/project/defaultcontent