Difference between revisions of "Manual:Extension/BlueSpiceNSFileRepo"

[unchecked revision][unchecked revision]
m (Text replacement - "Reference:BlueSpiceNSFileRepo" to "Reference:NSFileRepo")
 


What is NSFileRepo?[edit | edit source]

NSFileRepo extension enables uploading files to namepaces. Extension restricts access to upload and read files and images to a given set of user groups associated with protected namespaces. Using this extension (within the security limitations noted above), you can protect not only pages and areas of your wiki, but also any uploaded images or files within those namespaces. Provide namespace based features to uploaded files.

How?[edit | edit source]

Generically, you use the same syntax as a normal file reference link, adding the namespace between the file specifier ("File", "Image" or "Media") and the file nameFile is still being uploaded to the File namespace (NS_FILE) but it contains additional namespace that can be any of the namespaces defined on the wiki. Such files have structure:

[[{FILE_NS}:{Namespace}:{Filename}]]

Example (where Private is the protected namespace and Filename.jpg is the file to which you wish to limit accessFor example file can be uploaded to "Private" namespace and access to that namespace can be resticted to particular user group(s):

[[File:Private:Filename.jpg]]

The standard for accessing files is generally:

[[File:Filename.jpg]]
[[Image:Filename.jpg]]
[[Media:Filename.jpg]]

This extension allows you to protect access to files by adding the namespace text identifier after the file namespace identifier, for example (where Private is the protected namespace and Filename.jpg is the file to which you wish to limit access):

                [[File:Private:Filename.jpg]]
[[Image:Private:Filename.jpg]]
[[Media:Private:Filename.jpg]]

            

It may be helpful to understand the default security model used by MediaWiki using the instructions below:

Limitations of security are the same as for Extension:Lockdown. To review these limitations, see here.

To use the full capabilities of this extension (for example, specific namespace protections) you will need to install and use the namespace protections provided through Extension:Lockdown.

This extension was made possible by the introduction of Repository Classes by Tim Starling - an elegant and brilliant implementation. It uses a new Local Repository class mechanism. Access to particular namespace can be managed by using BlueSpicePermissionManager extension.

Technical details on how this extension works can be found here.

See also[edit | edit source]

Our reference page.

Related info

<bs:bookshelf src="Book:User manual" />
        
        
        
        __TOC__
        
        
        
        ==What is NSFileRepo?==
        
        
        
        '''NSFileRepo''' extension enables uploading files to namepaces. Extension restricts access to upload and read files and images to a given set of user groups associated with protected namespaces. Using this extension (within the security limitations noted above), you can protect not only pages and areas of your wiki, but also any uploaded images or files within those namespaces. Provide namespace based features to uploaded files.
        
        
        
        ==How?==
        
        
        
        
        Generically, you use the same syntax as a normal file reference link, adding the namespace between the file specifier ("File", "Image" or "Media") and the file nameFile is still being uploaded to the File namespace (NS_FILE) but it contains additional namespace that can be any of the namespaces defined on the wiki. Such files have structure:
        
        
        
        
        <pre>[[{FILE_NS}:{Namespace}:{Filename}]]
        
        
        </pre>
        
        
        Example (where <code>Private</code> is the protected namespace and <code>Filename.jpg</code> is the file to which you wish to limit accessFor example file can be uploaded to "Private" namespace and access to that namespace can be resticted to particular user group(s):
        
        
        
        
        <pre>[[File:Private:Filename.jpg]]
        
        
        </pre>
        
        The standard for accessing files is generally:
        
        
        
        
        <pre>[[File:Filename.jpg]]
        
        [[Image:Filename.jpg]]
        
        [[Media:Filename.jpg]]
        
        
        </pre>
        
        
        This extension allows you to protect access to files by adding the namespace text identifier after the file namespace identifier, for example (where <code>Private</code> is the protected namespace and <code>Filename.jpg</code> is the file to which you wish to limit access):
            
            
            
            
            <pre>[[File:Private:Filename.jpg]]
            
            [[Image:Private:Filename.jpg]]
            
            [[Media:Private:Filename.jpg]]
            
            
            </pre>
            
            It may be helpful to understand the default security model used by MediaWiki using the instructions below:
            
            
            
            * [https://www.mediawiki.org/wiki/Manual:User_rights Manual:User rights]
            
            * [https://www.mediawiki.org/wiki/Manual:$wgGroupPermissions Manual:$wgGroupPermissions]
            
            
            
            Limitations of security are the same as for [https://www.mediawiki.org/wiki/Extension:Lockdown Extension:Lockdown]. To review these limitations, [https://www.mediawiki.org/wiki/Extension:Lockdown#Additional_measures see here].
            
            
            
            To use the full capabilities of this extension (for example, specific namespace protections) you will need to install and use the namespace protections provided through [https://www.mediawiki.org/wiki/Extension:Lockdown Extension:Lockdown].
            
            
            
            This extension was made possible by the introduction of Repository Classes by Tim Starling - an elegant and brilliant implementation. It uses a new Local Repository class mechanism. 
            
            Access to particular namespace can be managed by using [[Manual:Extension/BlueSpicePermissionManager|BlueSpicePermissionManager]] extension.
            
            
            
            
        Technical details on how this extension works can be found [https://www.mediawiki.org/wiki/Extension:NSFileRepo/DOC here].
        
        
        
        
        ==See also==
            
            
            
            Our [[NSFileRepo|reference page.]]{{Box Links-en|Topic1=[[Reference:NSFileRepo]]}}
            
            
            
            {{Translation}}
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<bs:bookshelf src="Book:User manual" />
+
 
  
 
__TOC__
 
__TOC__
Line 5: Line 5:
 
==What is NSFileRepo?==
 
==What is NSFileRepo?==
  
'''NSFileRepo''' extension restricts access to upload and read files and images to a given set of user groups associated with protected namespaces. Using this extension (within the security limitations noted above), you can protect not only pages and areas of your wiki, but also any uploaded images or files within those namespaces. Provide namespace based features to uploaded files.
+
'''NSFileRepo''' enables uploading files to namepaces. Extension restricts access to upload and read files and images to a given set of user groups associated with protected namespaces. Using this extension (within the security limitations noted above), you can protect not only pages and areas of your wiki, but also any uploaded images or files within those namespaces. Provide namespace based features to uploaded files.
  
 
==How?==
 
==How?==
  
Generically, you use the same syntax as a normal file reference link, adding the namespace between the file specifier ("File", "Image" or "Media") and the file name:
+
File is still being uploaded to the File namespace (NS_FILE) but it contains additional namespace that can be any of the namespaces defined on the wiki. Such files have structure:
  
 
<pre>[[{FILE_NS}:{Namespace}:{Filename}]]
 
<pre>[[{FILE_NS}:{Namespace}:{Filename}]]
 
</pre>
 
</pre>
Example (where <code>Private</code> is the protected namespace and <code>Filename.jpg</code> is the file to which you wish to limit access):
+
For example file can be uploaded to "Private" namespace and access to that namespace can be resticted to particular user group(s):
  
 
<pre>[[File:Private:Filename.jpg]]
 
<pre>[[File:Private:Filename.jpg]]
Line 23: Line 23:
 
[[Media:Filename.jpg]]
 
[[Media:Filename.jpg]]
 
</pre>
 
</pre>
This extension allows you to protect access to files by adding the namespace text identifier after the file namespace identifier, for example (where <code>Private</code> is the protected namespace and <code>Filename.jpg</code> is the file to which you wish to limit access):
 
 
<pre>[[File:Private:Filename.jpg]]
 
[[Image:Private:Filename.jpg]]
 
[[Media:Private:Filename.jpg]]
 
</pre>
 
It may be helpful to understand the default security model used by MediaWiki using the instructions below:
 
 
* [https://www.mediawiki.org/wiki/Manual:User_rights Manual:User rights]
 
* [https://www.mediawiki.org/wiki/Manual:$wgGroupPermissions Manual:$wgGroupPermissions]
 
 
Limitations of security are the same as for [https://www.mediawiki.org/wiki/Extension:Lockdown Extension:Lockdown]. To review these limitations, [https://www.mediawiki.org/wiki/Extension:Lockdown#Additional_measures see here].
 
  
To use the full capabilities of this extension (for example, specific namespace protections) you will need to install and use the namespace protections provided through [https://www.mediawiki.org/wiki/Extension:Lockdown Extension:Lockdown].
+
Access to particular namespace can be managed by using [[Manual:Extension/BlueSpicePermissionManager|BlueSpicePermissionManager]] extension.
  
This extension was made possible by the introduction of Repository Classes by Tim Starling - an elegant and brilliant implementation. It uses a new Local Repository class mechanism. Technical details on how this extension works can be found [https://www.mediawiki.org/wiki/Extension:NSFileRepo/DOC here].
+
Technical details on how this extension works can be found [https://www.mediawiki.org/wiki/Extension:NSFileRepo/DOC here].
  
==See also==
+
{{Box Links-en|Topic1=[[Reference:NSFileRepo]]}}
  
Our [[NSFileRepo|reference page.]]
+
{{Translation}}

Attachments

Discussions