View difference between Paste ID: ymNvATWg and mdYnSKbX
SHOW: | | - or go back to the newest paste.
1
 ------------------------------------------------
2
|      AjaXplorer Quick Start                   |
3
 ------------------------------------------------
4
 
5
 1 SYSTEM REQUIREMENTS & QUICK INSTALL
6
 
7
 To be able to run this system on your webserver, it must have PHP 5.1 or higher
8
 running, and you must have an FTP access to upload the files on the server. 
9
 Just make sure that the "data" folder is (recursively) writeable by the webserver.
10
11
 That's all! For the default configuration, no database is needed. But if you want to
12
 store data in a database, it's possible, see the *.sql plugins.
13
14
 2 CONFIGURATION
15
16
    The very basic configurations are to be found in the conf/ folder :
17
18
    + You should not have to tweak the bootstrap_context.php, unless you want to customize
19
      heavily your installation.
20
    + The bootstrap_plugins.php file contains the configurations for the Authentification
21
      plugin, the Config plugin (how to save ajaxplorer config data) and the Logger.
22
    + The bootstrap_repositories.php contains the default repositories definition. The preferred
23
      way of creating new repositories is by using the GUI (switch to the "Settings"), but you
24
      can also define them manually in this file if it's more handy for you
25
26
 2.1 REPOSITORIES 
27
    
28
    In AjaXplorer, a repository is a folder that you want to browse/modify with 
29
    the application. A repository does not have to be inside the ajaxplorer installation 
30
    folder, since you set it with an absolute path on your server.
31
    
32
    You can set as many repositories as you want : you will be able to switch from one to 
33
    another when logged to AjaXplorer, and you can precisely set rights for each users (see 
34
    paragraph 2.2) on each repository. 
35
    
36
    By default, the basic repository is set to the "data/files" folder inside the ajaxplorer
37
    installation folder. You can change it to whatever you want, using absolute path 
38
    like : /home/login/www/location, or /C:/myfolder/ on windows.
39
    
40
    Note that a repository does not have to be accessible to the internet, AjaXplorer will 
41
    work as a "proxy" between your files and the web.
42
    
43
 2.2 USERS MANAGEMENT
44
    
45
    An evoluted users management system has been developed in AjaXplorer. You are encouraged 
46
    to use it to secure your data, but it's up to you, you can disable it totally (for example 
47
    if you are already working in a very secure zone, and don't need any users profiles).
48
    
49
    If you are a beginner, just change the ADMIN_PASSWORD variable before uploading on your 
50
    server everything should be fine. If you do not change it, you will be reminded to change 
51
    the first time you log in, because otherwise anybody knowing AjaXplorer could login with 
52
    the standard initial password "admin"...
53
    
54
    You can add / modify / delete users by logging in AjaXplorer as "admin" and switching to the
55
    "Settings" repository. For each user, you will be able to give read and/or right access separately
56
    on each repository. Note that a user that has no rights on any repository cannot log in.
57
    
58
    For a better integration in existing systems, AjaXplorer can "prelog" a user from external 
59
    data or logging system. Users must still be created in AjaXplorer, since their rights on 
60
    repositories and preferences are stored by the application. But they will not be able to 
61
    change their password, since they are in that case managed by an external application.
62
    
63
    2.2.1 BASIC USERS CONFIGURATION
64
      
65
      ENABLE_USERS => 1   Users management is enabled
66
              0   Users management is totally disabled. No logging required and all 
67
                users share the same preferences.
68
              
69
      ALLOW_GUEST_BROWSING => 1   In the "Settings" console accessed by admin user, 
70
                    a "guest" user is created on which you can set 
71
                    rights on repositories like any other user. This 
72
                    user will be automatically logged in if no user 
73
                    is identified.
74
                  0   When no user is identified, the login screen appears 
75
                    and no repository is loaded.
76
77
  2.2.2 AUTHENTICATION METHOD
78
  
79
  In ajaXplorer, Authentication is (like the repositories as access and the configuration ) plugin-based.
80
  By default, in the conf/boostrap_plugins.php file you can see that the basic auth.serial plugin
81
  is used to manage your users. This means that the users and their rights and personnal data 
82
  will be stored on the filesystem, in a specific ajaxplorer format. This plugin is the most
83
  performant, but may not be suited for managing a huge amount of users, or when managing users
84
  already created in an external system like a CMS. In that case, you should have a look at the auth.ldap
85
  or auth.remote plugins, or even auth.mysql, each of these plugin giving you more features for 
86
  managing plugin.
87
                    
88
                   
89
 2.3 FURTHER CONFIGURATION   
90
 
91
  Switch to the "Settings" repository, and browse the various "Global Configurations" : particularly,
92
  you should have a look at the "Core" options, as well as the Plugins > Gui > Client Plugin (gui.ajax)
93
  where you can do some basic customization for your interface.
94
95
---------------------------------------------------------------------------
96
 * Copyright 2007-2011 Charles du Jeu <charles (at) ajaxplorer.info>
97
 * This file is part of AjaXplorer.
98
 *
99
 * AjaXplorer is free software: you can redistribute it and/or modify
100
 * it under the terms of the GNU Affero General Public License as published by
101
 * the Free Software Foundation, either version 3 of the License, or
102
 * (at your option) any later version.
103
 *
104
 * AjaXplorer is distributed in the hope that it will be useful,
105
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
106
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
107
 * GNU Affero General Public License for more details.
108
 *
109
 * You should have received a copy of the GNU Affero General Public License
110
 * along with AjaXplorer.  If not, see <http://www.gnu.org/licenses/>.
111
 *
112
 * The latest code can be found at <http://www.ajaxplorer.info/>.
113
114
115
116
117
conf.sql plugin documentation
118
-----------------------------
119
120
This is the conf.sql plugin. It stores AjaXplorer configuration
121
information in an SQL database,
122
it is responsible for storing the following information in the
123
AjaXplorer application:
124
125
- Repository definitions
126
- User bookmarks
127
- User preferences
128
- User rights
129
130
configuring the plugin
131
----------------------
132
133
Below is an example configuration. Tweak this to suit your needs and
134
then insert it into conf.php.
135
You will need to comment out or remove the existing serial driver in
136
order for this to work properly.
137
138
139
$CONF_STORAGE = array(
140
	"NAME"		=> "sql",
141
	"OPTIONS"	=> array(
142
		"SQL_DRIVER" => array(
143
			"driver" => "mysql",
144
			"host"	=> "localhost",
145
			"database" => "ajxp",
146
			"user"	=> "ajxp_database_user",
147
			"password" => "ajxp_database_password"
148
		)
149
	)
150
);
151
152
When you are happy with the configuration, run the create.sql script
153
located inside the same directory as the plugin
154
to create the database schema for the conf.sql plugin.
155
156
Note that the performance of AjaXplorer is slightly degraded by the
157
overhead of the plugin - but that's what you sacrifice for the
158
flexibility.
159
160
This file is part of the AjaXplorer distribution.
161
Contribution by Mosen : greetings!
162
163
164
165
Stores all data inside a database. It is database generic, the connexion to the database must be described in an array, see http://dibiphp.com/cs/ for more info on databases supported and configurations. A create.sql file is included to generate the necessary tables for storing users data.
166
167
The SQL_DRIVER option defined in the bootstrap_plugins.php file must be set with a "dibi" configuration that is PHP array like this : 
168
169
170
    "SQL_DRIVER"	=> array(
171
        "driver" => "mysql",
172
        "host"   => "localhost",
173
        "database"   => "ajxp",
174
        "user"   => "user",
175
        "password"   => "pass",
176
    ),