-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathManagingExternalApplications.html
277 lines (257 loc) · 15.8 KB
/
ManagingExternalApplications.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Managing External Applications — AppAPI latest documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
<link rel="stylesheet" type="text/css" href="_static/css/styles.css?v=92f2225a" />
<link rel="stylesheet" type="text/css" href="_static/css/dark.css?v=41caee7b" />
<link rel="stylesheet" type="text/css" href="_static/css/light.css?v=c3d70dd7" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c6e86fd7"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/tabs.js?v=3ee01567"></script>
<script src="_static/js/script.js?v=783f4f19"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Concepts" href="Concepts.html" />
<link rel="prev" title="Test Deploy Daemon" href="TestDeploy.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
AppAPI
<img src="_static/logo.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="DeployConfigurations.html">Deployment configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="CreationOfDeployDaemon.html">Creation of Deploy Daemon</a></li>
<li class="toctree-l1"><a class="reference internal" href="TestDeploy.html">Test Deploy Daemon</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Managing External Applications</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#occ-cli">OCC CLI</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#register">Register</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#arguments">Arguments</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#unregister">Unregister</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id1">Arguments</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id2">Options</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#update">Update</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id3">Arguments</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id4">Options</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#enable">Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="#disable">Disable</a></li>
<li class="toctree-l3"><a class="reference internal" href="#list-exapps">List ExApps</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#using-the-exapp-management-ui">Using the ExApp Management UI</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="tech_details/index.html">Technical details</a></li>
<li class="toctree-l1"><a class="reference internal" href="DevSetup.html">Setting up dev environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes_for_developers/index.html">Notes for Developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq/index.html">Frequently Asked Questions</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">AppAPI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Managing External Applications</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/ManagingExternalApplications.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="managing-external-applications">
<h1>Managing External Applications<a class="headerlink" href="#managing-external-applications" title="Link to this heading"></a></h1>
<p>There are two ways to manage ExApps:</p>
<ol class="arabic simple">
<li><p>Using OCC CLI tool</p></li>
<li><p>Using the ExApp Management UI</p></li>
</ol>
<section id="occ-cli">
<h2>OCC CLI<a class="headerlink" href="#occ-cli" title="Link to this heading"></a></h2>
<p>There are several commands to work with ExApps:</p>
<ol class="arabic simple">
<li><p>Register</p></li>
<li><p>Unregister</p></li>
<li><p>Update</p></li>
<li><p>Enable</p></li>
<li><p>Disable</p></li>
<li><p>List ExApps</p></li>
<li><p>List ExApp users (removed since AppAPI 3.0.0)</p></li>
<li><p>List ExApp scopes</p></li>
</ol>
<section id="register">
<h3>Register<a class="headerlink" href="#register" title="Link to this heading"></a></h3>
<p>Command: <code class="docutils literal notranslate"><span class="pre">app_api:app:register</span> <span class="pre">[--force-scopes]</span> <span class="pre">[--info-xml</span> <span class="pre">INFO-XML]</span> <span class="pre">[--json-info</span> <span class="pre">JSON-INFO]</span> <span class="pre">[--]</span> <span class="pre"><appid></span> <span class="pre"><daemon-config-name></span></code></p>
<p>The register command is the first ExApp installation step.</p>
<section id="arguments">
<h4>Arguments<a class="headerlink" href="#arguments" title="Link to this heading"></a></h4>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">appid</span></code> - unique name of the ExApp (e.g. <code class="docutils literal notranslate"><span class="pre">app_python_skeleton</span></code>, must be the same as in deployed container)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">daemon-config-name</span></code> - unique name of the daemon (e.g. <code class="docutils literal notranslate"><span class="pre">docker_local_sock</span></code>)</p></li>
</ul>
</div></blockquote>
</section>
<section id="options">
<h4>Options<a class="headerlink" href="#options" title="Link to this heading"></a></h4>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--force-scopes</span></code> <em>[optional]</em> - force scopes approval</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--json-info</span> <span class="pre">JSON-INFO</span></code> <strong>[optional]</strong> - ExApp deploy JSON info (json string)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--info-xml</span> <span class="pre">INFO-XML</span></code> <strong>[optional]</strong> - path to info.xml file (url or local absolute path)</p></li>
</ul>
</div></blockquote>
</section>
</section>
<section id="unregister">
<h3>Unregister<a class="headerlink" href="#unregister" title="Link to this heading"></a></h3>
<p>Command: <code class="docutils literal notranslate"><span class="pre">app_api:app:unregister</span> <span class="pre">[--rm-data]</span> <span class="pre">[--force]</span> <span class="pre">[--silent]</span> <span class="pre">[--]</span> <span class="pre"><appid></span></code></p>
<p>To remove an ExApp you can use the unregister command.
There are additional options to keep the ExApp persistent storage (data volume).</p>
<section id="id1">
<h4>Arguments<a class="headerlink" href="#id1" title="Link to this heading"></a></h4>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">appid</span></code> - unique name of the ExApp (e.g. <code class="docutils literal notranslate"><span class="pre">app_python_skeleton</span></code>, must be the same as in deployed container)</p></li>
</ul>
</div></blockquote>
</section>
<section id="id2">
<h4>Options<a class="headerlink" href="#id2" title="Link to this heading"></a></h4>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--rm-data</span></code> <em>[optional]</em> - remove ExApp persistent storage (data volume)</dt><dd><ul>
<li><p><code class="docutils literal notranslate"><span class="pre">--force</span></code> <em>[optional]</em> - continue removal even if some error occurs.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--silent</span></code> <em>[optional]</em> - print a minimum of information, display only some errors, if any.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
</section>
</section>
<section id="update">
<h3>Update<a class="headerlink" href="#update" title="Link to this heading"></a></h3>
<p>Command: <code class="docutils literal notranslate"><span class="pre">app_api:app:update</span> <span class="pre">[--info-xml</span> <span class="pre">INFO-XML]</span> <span class="pre">[--force-update]</span> <span class="pre">[--force-scopes]</span> <span class="pre">[-e|--enabled]</span> <span class="pre">[--]</span> <span class="pre"><appid></span></code></p>
<p>ExApp will be updated if there is a new version available.</p>
<section id="id3">
<h4>Arguments<a class="headerlink" href="#id3" title="Link to this heading"></a></h4>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">appid</span></code> - unique name of the ExApp (e.g. <code class="docutils literal notranslate"><span class="pre">app_python_skeleton</span></code>, must be the same as in deployed container)</p></li>
</ul>
</div></blockquote>
</section>
<section id="id4">
<h4>Options<a class="headerlink" href="#id4" title="Link to this heading"></a></h4>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--info-xml</span> <span class="pre">INFO-XML</span></code> <strong>[optional]</strong> - path to info.xml file (url or local absolute path)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--force-update</span></code> <em>[optional]</em> - force ExApp update (do not prompt for confirmation)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--force-scopes</span></code> <em>[optional]</em> - force scopes approval (accept all scopes)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-e|--enabled</span></code> <em>[optional]</em> - enable ExApp after update</p></li>
</ul>
</div></blockquote>
</section>
</section>
<section id="enable">
<h3>Enable<a class="headerlink" href="#enable" title="Link to this heading"></a></h3>
<p>Command: <code class="docutils literal notranslate"><span class="pre">app_api:app:enable</span> <span class="pre"><appid></span></code></p>
</section>
<section id="disable">
<h3>Disable<a class="headerlink" href="#disable" title="Link to this heading"></a></h3>
<p>Command: <code class="docutils literal notranslate"><span class="pre">app_api:app:disable</span> <span class="pre"><appid></span></code></p>
</section>
<section id="list-exapps">
<h3>List ExApps<a class="headerlink" href="#list-exapps" title="Link to this heading"></a></h3>
<p>Command: <code class="docutils literal notranslate"><span class="pre">app_api:app:list</span></code></p>
<p>ListExApps command will show all ExApps:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ExApps</span><span class="p">:</span>
<span class="n">appid</span> <span class="p">(</span><span class="n">Display</span> <span class="n">Name</span><span class="p">):</span> <span class="n">version</span> <span class="p">[</span><span class="n">enabled</span><span class="o">/</span><span class="n">disabled</span><span class="p">]</span>
<span class="n">to_gif_example</span> <span class="p">(</span><span class="n">To</span> <span class="n">Gif</span> <span class="n">Example</span><span class="p">):</span> <span class="mf">1.0.0</span> <span class="p">[</span><span class="n">enabled</span><span class="p">]</span>
<span class="n">upscaler_example</span> <span class="p">(</span><span class="n">Upscaler</span> <span class="n">Example</span><span class="p">):</span> <span class="mf">1.0.0</span> <span class="p">[</span><span class="n">enabled</span><span class="p">]</span>
</pre></div>
</div>
</section>
</section>
<section id="using-the-exapp-management-ui">
<h2>Using the ExApp Management UI<a class="headerlink" href="#using-the-exapp-management-ui" title="Link to this heading"></a></h2>
<p>ExApps management is similar to default Apps management.
To access ExApps management navigate using Admin settings dropdown menu or from AppAPI admin settings section.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>ExApps management support only apps from App Store. For manual-install type use CLI ExApps management commands.</p>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="TestDeploy.html" class="btn btn-neutral float-left" title="Test Deploy Daemon" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Concepts.html" class="btn btn-neutral float-right" title="Concepts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024 Nextcloud GmbH.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>