@@ -16,3 +16,32 @@ Also, if Qiita is running with the default server SSL certificate, you need to e
1616
1717export QIITA_ROOT_CA=< QIITA_INSTALL_PATH> /qiita_core/support_files/ci_rootca.crt
1818```
19+
20+ Configure for cloud computing
21+ -----------------------------
22+ In the default scenario, Qiita main and Qiita plugins are executed on the same
23+ machines, maybe spread across a Slurm or other grid compute cluster, but main
24+ and plugins have direct access to all files in ` BASE_DATA_DIR ` .
25+
26+ This can be different, if you set up Qiita within a cloud compute environment,
27+ where main and plugins do ** not** share one file system. In this case, input-
28+ files must first be transferred from main to plugin, then plugin can do its
29+ processing and resulting files must be transferred back to main, once
30+ processing is finished. To achieve this, the qiita_client, as it is part of
31+ each plugin, provides the two functions for this file transfer
32+ ` fetch_file_from_central ` and ` push_file_to_central ` . According to
33+ ` self._plugincoupling ` , these functions operate on different "protocols";
34+ as of 2025-08-29, either "filesystem" or "https". Switch to ** "https"** for
35+ cloud environments, default is ** filesystem** .
36+
37+ The plugin coupling protocoll can be set in three ways
38+
39+ 1. default is always "filesystem", i.e. _DEFAULT_PLUGIN_COUPLINGS
40+ This is to be downward compatible.
41+ 2. the plugin configuration can hold a section 'network' with an
42+ option 'PLUGINCOUPLING'. For old config files, this might not
43+ (yet) be the case. Therefore, we are double checking existance
44+ of this section and parameter here.
45+ 3. you can set the environment variable QIITA_PLUGINCOUPLING
46+ Precedence is 3, 2, 1, i.e. the environment variable overrides the
47+ other two ways.
0 commit comments