Back
Configuring ScrewTurn Wiki Providers

Modified on 2014/10/15 07:26 by Administrator Categorized as Uncategorized
All ''ScrewTurn Wiki'' providers, except for Settings Storage Providers, can be installed, updated and configured directly in the administration panel, ''Providers'' section.

==Installing a new Provider==
In order to install a new provider, you will need its assembly, which is a file with ''DLL'' extension. You can upload it using the appropriate controls in the administration page. As soon as the DLL file is uploaded, all the providers it contains are loaded and listed in the same page.

==Updating a Provider==
If the provider supports automatic updates, you can simply click the ''Auto-Update Providers'' button, then restart the application. The system will automatically download the updated DLL file from the author's website and replace the old one.

If you have to manually update a provider, first delete its DLL file and then upload the new one, then restart the application.

==Configuring a Provider==
The configuration string entirely depends on the provider and might not be needed at all. To learn how to configure a specific provider, please refer to its documentation. For configuring plugins and providers that are included with ''ScrewTurn Wiki'', please refer to the [++Customize.MainPage|dedicated section].

If you enter a configuration string that is not valid or contains an error, the provider will reject it and an error message will be displayed. Detailed information is recorded in the wiki log (see the ''System Log'' administration page).

Providers can be enabled or disabled, and can also be unloaded from memory (only when already disabled). When a provider is disabled it is not used and the data it manages are not available. If a provider is unloaded, it is not accessible until the next application restart (it effectively disappears from the application).

'''Note''': you cannot disable or unload providers that are set as default or that contain required data. In such cases, the ''Disable'' and ''Unload'' buttons are disabled.

==Setting Default Providers==
Except for Settings Storage Providers, you can install and use an unlimited number of providers at the same time. You have, however, to set one of each type as the ''default'', i.e. the one that is used to store new items when no provider is explicitly specified. When creating new items (users, namespaces, etc.) in the administration interface, you are usually prompted for the provider to use. When creating new items (pages, users) outside the administration interface, the appropriate default provider is automatically selected.

'''Note''': although you can load and enable multiple Cache Providers, only the ''default'' is actually used.

==Configuring Settings Storage Providers==
Settings Storage Providers manage all the configuration data of the wiki and they also contain all the other providers that are used in the wiki. For this reason, Settings Storage Providers must be configured in the "web.config" file: you can find it in the application root directory.

You have to properly set two values, as shown in this excerpt:

@@<add key="SettingsStorageProvider" value="" />
<add key="SettingsStorageProviderConfig" value="" />@@

{{SettingsStorageProvider}} is the fully qualified name of the provider, for example ''ScrewTurn.Wiki.SettingsStorageProvider, ScrewTurn.Wiki.Core.dll'' (leave blank to use the integrated provider). {{SettingsStorageProviderConfig}} is the configuration string of the provider. Please refer to the providers' documentation for details on the actual values you must enter.

===Federated Providers===
Storage Providers can optionally work in ''Federated Mode'', i.e. you only configure the Settings Storage Provider and all the others (Pages, Users, Files) automatically detect and use the same configuration. This is how the SQL Server Data Providers work, for instance.
Meta Keywords:
Meta Description:
Change Comment:
Configuring ScrewTurn Wiki Providers

Side Projects¶

About¶
