Skip to content
This repository was archived by the owner on Nov 25, 2020. It is now read-only.

Commit f2ede00

Browse files
committed
Update plugin_doc files
1 parent 401679a commit f2ede00

File tree

11 files changed

+54
-12
lines changed

11 files changed

+54
-12
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<p>
2+
See auth.ftp plugin: provide a rich login screen with full connection to an FTP server (host, port, credentials, etc...)
3+
and dynamically authenticate these credentials against this server. Coupled with a "Dynamic" FTP workspace, this is used
4+
to setup Pydio as a simple WebFTP application.
5+
</p>
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<p>
2+
This plugin is a basic in-file storage for plugins that cannot be stored in the "conf.*" storage. Namely, CONF, AUTH, LOG and CACHE
3+
plugins configurations are using this plugin to store their configs. Data is stored in a JSON file on the server.
4+
</p>
5+
<p>
6+
Additionally, this plugin provides the first-time installer wizard for Pydio.
7+
</p>
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<p>
2+
Core features for workspace drivers. Most access.* drivers will extend this plugin.
3+
It also provides core model classes for Node, Repository, UserSelection, etc.
4+
</p>
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<p>This plugin is a generic container for all 'core' configs of the application. It is always loaded, and the associated options are available in the code via ConfService::getCoreConf() method.</p>
2-
<p>Main Sections are :
3-
<ul>
4-
<li><b>Main Options</b><br>Basic options, Server URL should be defined only if it cannot be detected automatically by the server (when behind a proxy for example).</li>
5-
<li><b>Sharing</b><br>Outside world sharing options, see also the Plugins > Actions > Share Center for a lot more options about Sharing.</li>
6-
<li><b>WebDAV Server</b><br>Enable this allow users to mount their workspace as network drive on their desktop.</li>
7-
<li><b>Command Line</b><br>Enable this to boost performances and/or perform requests directly via command line.</li>
8-
<li><b>Compression Features</b><br>Default options should be sufficiant, try tweaking if you encounter problems.</li>
9-
<li><b>Miscellaneous</b>Other non-classified options</li>
10-
</ul>
11-
</p>
2+
<p>Main Sections are :
3+
<ul>
4+
<li><b>Main Options</b><br>Basic options, Server URL should be defined only if it cannot be detected automatically by the server (when behind a proxy for example).</li>
5+
<li><b>Sharing</b><br>Outside world sharing options, see also the Plugins > Actions > Share Center for a lot more options about Sharing.</li>
6+
<li><b>WebDAV Server</b><br>Enable this allow users to mount their workspace as network drive on their desktop.</li>
7+
<li><b>Command Line</b><br>Enable this to boost performances and/or perform requests directly via command line.</li>
8+
<li><b>Compression Features</b><br>Default options should be sufficiant, try tweaking if you encounter problems.</li>
9+
<li><b>Miscellaneous</b>Other non-classified options</li>
10+
</ul>
11+
</p>
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
<p>Generic authentication options that are shared by all Auth plugins. Basically, determine whether users are enabled or not, guest user allowed or not, etc. Edited via the gui (Settings > Core options). Also provides the standard "auth" actions included by these plugins (login,logout).</p>
22

3-
<p>You can select one or two Authentication plugin instances to provide auth backend to the application. <br>Default starter setup will typically use a unique SQL-based instance. <br>Default enterprise setup will often be composed of a Master / Slave configuration, Master being and LDAP or equivalent directory, slave being SQL-based to store the pydio-created users locally.</p>
3+
<p>You can select one or two Authentication plugin instances to provide auth backend to the application.
4+
<br>Default starter setup will typically use a unique SQL-based instance.
5+
<br>Default enterprise setup will often be composed of a Master / Slave configuration, Master being and LDAP or equivalent directory, slave being SQL-based to store the pydio-created users locally.</p>
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<p>
2+
Core loaders for "Authentification Frontends". Authfronts are plugins that can "retrieve" a user credential from
3+
a specific context, like user/password submitted by login form, key/secret passed through API header, or through standard
4+
Basic-http headers, etc.
5+
</p>
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<p>
2+
Caching layer for optimizing both plugins/users/workspaces loading as well as files and folders listing via CacheStreamLayer.
3+
Unique implementation is currently based on Doctrine Cache module, see cache.doctrine plugin.
4+
</p>

core/src/plugins/meta.user/plugin_doc.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,4 @@
88
<li>anything_area : will create a textarea field</li>
99

1010
</ul>
11-
<p align="center"><img src="meta-user.png" alt="Sample"></p>
1211
<p>Warning, this plugin requires a "metastore" plugin to be active to do the actual storing implementation.</p>
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<p>
2+
Implements "watch" system for files and folders.
3+
</p>
4+
<p>
5+
This plugin is using the underlying MetaStore to attach watch metadata to any node of a workspace, and hooks to the nodes events
6+
(node.read, node.change) to create and post notifications to the concerned users. Make sure to add a Metastore to the workspace.
7+
</p>
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<p>
2+
Implements internal messaging inside Pydio, and internal interface with Pydio Booster.
3+
Messages are both stored in local queues (inside files on the server).
4+
</p>

0 commit comments

Comments
 (0)