File Manager - BorneoXploit

Editing: DeployConfigurations.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
 <meta charset="utf-8" />
 <meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" />

const defaultStyle = document.createElement('style');
defaultStyle.textContent = `pre.mermaid {
    /* Same as .mermaid-container > pre */
    display: block;
    width: 100%;
}

pre.mermaid > svg {
    /* Same as .mermaid-container > pre > svg */
    height: 500px;
    width: 100%;
    max-width: 100% !important;
}
`;
document.head.appendChild(defaultStyle);

const fullscreenStyle = document.createElement('style');
fullscreenStyle.textContent = `.mermaid-container {
    display: flex;
    flex-direction: row;
    width: 100%;
}

.mermaid-container > pre {
    display: block;
    width: 100%;
}

.mermaid-container > pre > svg {
    height: 500px;
    width: 100%;
    max-width: 100% !important;
}

.mermaid-fullscreen-btn {
    width: 28px;
    height: 28px;
    background: rgba(255, 255, 255, 0.95);
    border: 1px solid rgba(0, 0, 0, 0.3);
    border-radius: 4px;
    cursor: pointer;
    display: flex;
    align-items: center;
    justify-content: center;
    transition: all 0.2s;
    box-shadow: 0 2px 6px rgba(0, 0, 0, 0.2);
    font-size: 14px;
    line-height: 1;
    padding: 0;
    color: #333;
}

.mermaid-fullscreen-btn:hover {
    opacity: 100% !important;
    background: rgba(255, 255, 255, 1);
    box-shadow: 0 3px 10px rgba(0, 0, 0, 0.3);
    transform: scale(1.1);
}

.mermaid-fullscreen-btn.dark-theme {
    background: rgba(50, 50, 50, 0.95);
    border: 1px solid rgba(255, 255, 255, 0.3);
    color: #e0e0e0;
}

.mermaid-fullscreen-btn.dark-theme:hover {
    background: rgba(60, 60, 60, 1);
    box-shadow: 0 3px 10px rgba(255, 255, 255, 0.2);
}

.mermaid-fullscreen-modal {
    display: none;
    position: fixed !important;
    top: 0 !important;
    left: 0 !important;
    width: 95vw;
    height: 100vh;
    background: rgba(255, 255, 255, 0.98);
    z-index: 9999;
    padding: 20px;
    overflow: auto;
}

.mermaid-fullscreen-modal.dark-theme {
    background: rgba(0, 0, 0, 0.98);
}

.mermaid-fullscreen-modal.active {
    display: flex;
    align-items: center;
    justify-content: center;
}

.mermaid-container-fullscreen {
    position: relative;
    width: 95vw;
    height: 90vh;
    max-width: 95vw;
    max-height: 90vh;
    background: white;
    border-radius: 8px;
    padding: 20px;
    box-shadow: 0 10px 40px rgba(0, 0, 0, 0.3);
    overflow: auto;
    display: flex;
    align-items: center;
    justify-content: center;
}

.mermaid-container-fullscreen.dark-theme {
    background: #1a1a1a;
    box-shadow: 0 10px 40px rgba(0, 0, 0, 0.8);
}

.mermaid-container-fullscreen pre.mermaid {
    width: 100%;
    height: 100%;
    display: flex;
    align-items: center;
    justify-content: center;
}

.mermaid-container-fullscreen .mermaid svg {
    height: 100% !important;
    width: 100% !important;
    cursor: grab;
}

.mermaid-fullscreen-close {
    position: fixed !important;
    top: 20px !important;
    right: 20px !important;
    width: 40px;
    height: 40px;
    background: rgba(255, 255, 255, 0.95);
    border: 1px solid rgba(0, 0, 0, 0.2);
    border-radius: 50%;
    cursor: pointer;
    z-index: 10000;
    display: flex;
    align-items: center;
    justify-content: center;
    box-shadow: 0 4px 12px rgba(0, 0, 0, 0.3);
    transition: all 0.2s;
    font-size: 24px;
    line-height: 1;
    color: #333;
}

.mermaid-fullscreen-close:hover {
    background: white;
    box-shadow: 0 6px 16px rgba(0, 0, 0, 0.4);
    transform: scale(1.1);
}

.mermaid-fullscreen-close.dark-theme {
    background: rgba(50, 50, 50, 0.95);
    border: 1px solid rgba(255, 255, 255, 0.2);
    color: #e0e0e0;
}

.mermaid-fullscreen-close.dark-theme:hover {
    background: rgba(60, 60, 60, 1);
    box-shadow: 0 6px 16px rgba(255, 255, 255, 0.2);
}

.mermaid-fullscreen-modal .mermaid-fullscreen-btn {
    display: none !important;
}`;
document.head.appendChild(fullscreenStyle);

// Detect if page has dark background
const isDarkTheme = () => {
 const bgColor = window.getComputedStyle(document.body).backgroundColor;
 const match = bgColor.match(/rgb\((\d+),\s*(\d+),\s*(\d+)/);
 if (match) {
 const r = parseInt(match[1]);
 const g = parseInt(match[2]);
 const b = parseInt(match[3]);
 const brightness = (r * 299 + g * 587 + b * 114) / 1000;
 return brightness < 128;
 }
 return false;
};

const load = async () => {
    await mermaid.run();

const all_mermaids = document.querySelectorAll(".mermaid");
    const mermaids_processed = document.querySelectorAll(".mermaid[data-processed='true']");

if ("False" === "True") {
 const mermaids_to_add_zoom = -1 === -1 ? all_mermaids.length : -1;
 if(mermaids_to_add_zoom > 0) {
 var svgs = d3.selectAll("");
 if(all_mermaids.length !== mermaids_processed.length) {
 setTimeout(load, 200);
 return;
 } else if(svgs.size() !== mermaids_to_add_zoom) {
 setTimeout(load, 200);
 return;
 } else {
 svgs.each(function() {
 var svg = d3.select(this);
 svg.html("<g class='wrapper'>" + svg.html() + "</g>");
 var inner = svg.select("g");
 var zoom = d3.zoom().on("zoom", function(event) {
 inner.attr("transform", event.transform);
 });
 svg.call(zoom);
 });
 }
 }
 } else if(all_mermaids.length !== mermaids_processed.length) {
 // Wait for mermaid to process all diagrams
 setTimeout(load, 200);
 return;
 }

const darkTheme = isDarkTheme();

// Stop here if not adding fullscreen capability
    if ("True" !== "True") return;

const modal = document.createElement('div');
 modal.className = 'mermaid-fullscreen-modal' + (darkTheme ? ' dark-theme' : '');
 modal.setAttribute('role', 'dialog');
 modal.setAttribute('aria-modal', 'true');
 modal.setAttribute('aria-label', 'Fullscreen diagram viewer');
 modal.innerHTML = `
 <button class="mermaid-fullscreen-close${darkTheme ? ' dark-theme' : ''}" aria-label="Close fullscreen">✕</button>
 <div class="mermaid-container-fullscreen${darkTheme ? ' dark-theme' : ''}"></div>
 `;
 document.body.appendChild(modal);

const modalContent = modal.querySelector('.mermaid-container-fullscreen');
    const closeBtn = modal.querySelector('.mermaid-fullscreen-close');

let previousScrollOffset = [window.scrollX, window.scrollY];

const closeModal = () => {
        modal.classList.remove('active');
        modalContent.innerHTML = '';
        document.body.style.overflow = ''
        window.scrollTo({left: previousScrollOffset[0], top: previousScrollOffset[1], behavior: 'instant'});
    };

closeBtn.addEventListener('click', closeModal);
    modal.addEventListener('click', (e) => {
        if (e.target === modal) closeModal();
    });
    document.addEventListener('keydown', (e) => {
        if (e.key === 'Escape' && modal.classList.contains('active')) {
            closeModal();
        }
    });

const allButtons = [];

document.querySelectorAll('.mermaid').forEach((mermaidDiv) => {
        if (mermaidDiv.parentNode.classList.contains('mermaid-container') ||
            mermaidDiv.closest('.mermaid-fullscreen-modal')) {
            return;
        }

const container = document.createElement('div');
        container.className = 'mermaid-container';
        mermaidDiv.parentNode.insertBefore(container, mermaidDiv);
        container.appendChild(mermaidDiv);

const fullscreenBtn = document.createElement('button');
        fullscreenBtn.className = 'mermaid-fullscreen-btn' + (darkTheme ? ' dark-theme' : '');
        fullscreenBtn.setAttribute('aria-label', 'View diagram in fullscreen');
        fullscreenBtn.textContent = '⛶';
        fullscreenBtn.style.opacity = '50%';

// Calculate dynamic position based on diagram's margin and padding
        const diagramStyle = window.getComputedStyle(mermaidDiv);
        const marginTop = parseFloat(diagramStyle.marginTop) || 0;
        const marginRight = parseFloat(diagramStyle.marginRight) || 0;
        const paddingTop = parseFloat(diagramStyle.paddingTop) || 0;
        const paddingRight = parseFloat(diagramStyle.paddingRight) || 0;
        fullscreenBtn.style.top = `${marginTop + paddingTop + 4}px`;
        fullscreenBtn.style.right = `${marginRight + paddingRight + 4}px`;

fullscreenBtn.addEventListener('click', () => {
            previousScrollOffset = [window.scroll, window.scrollY];
            const clone = mermaidDiv.cloneNode(true);
            modalContent.innerHTML = '';
            modalContent.appendChild(clone);

const svg = clone.querySelector('svg');
            if (svg) {
                svg.removeAttribute('width');
                svg.removeAttribute('height');
                svg.style.width = '100%';
                svg.style.height = 'auto';
                svg.style.maxWidth = '100%';
                svg.style.sdisplay = 'block';

if ("False" === "True") {
 setTimeout(() => {
 const g = svg.querySelector('g');
 if (g) {
 var svgD3 = d3.select(svg);
 svgD3.html("<g class='wrapper'>" + svgD3.html() + "</g>");
 var inner = svgD3.select("g");
 var zoom = d3.zoom().on("zoom", function(event) {
 inner.attr("transform", event.transform);
 });
 svgD3.call(zoom);
 }
 }, 100);
 }
 }

modal.classList.add('active');
            document.body.style.overflow = 'hidden';
        });

container.appendChild(fullscreenBtn);
        allButtons.push(fullscreenBtn);
    });

// Update theme classes when theme changes
    const updateTheme = () => {
        const dark = isDarkTheme();
        allButtons.forEach(btn => {
            if (dark) {
                btn.classList.add('dark-theme');
            } else {
                btn.classList.remove('dark-theme');
            }
        });
        if (dark) {
            modal.classList.add('dark-theme');
            modalContent.classList.add('dark-theme');
            closeBtn.classList.add('dark-theme');
        } else {
            modal.classList.remove('dark-theme');
            modalContent.classList.remove('dark-theme');
            closeBtn.classList.remove('dark-theme');
        }
    };

// Watch for theme changes
    const observer = new MutationObserver(updateTheme);
    observer.observe(document.documentElement, {
        attributes: true,
        attributeFilter: ['class', 'style', 'data-theme']
    });
    observer.observe(document.body, {
        attributes: true,
        attributeFilter: ['class', 'style']
    });
};

window.addEventListener("load", load);
</script>
 <script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
 <script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
 <script src="../_static/js/theme.js"></script>
 <script src="../_static/js/versions.js"></script>
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="next" title="Managing Deploy Daemons" href="ManagingDeployDaemons.html" />
 <link rel="prev" title="AppAPI and External Apps" href="AppAPIAndExternalApps.html" /> 
</head>

<a href="../contents.html">
 
 <img src="../_static/logo-white.png" class="logo" alt="Logo"/>
 </a>
 <div class="switch-menus">
 <div class="version-switch"></div>
 <div class="language-switch"></div>
 </div>
<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">
 Getting Started
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../declarations/index.html">Declarations</a></li>
</ul>
Release notes
<ul>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Critical changes</a></li>
</ul>
Installation
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
</ul>
Configuration
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../occ_command.html">Using the occ command</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../webhook_listeners/index.html">Webhook Listeners</a></li>
<li class="toctree-l1"><a class="reference internal" href="../windmill_workflows/index.html">Windmill Workflows</a></li>
</ul>
Files
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
</ul>
Apps
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">ExApps management</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="AppAPIAndExternalApps.html">AppAPI and External Apps</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Deployment configurations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#docker-deploy-daemon">Docker Deploy Daemon</a></li>
<li class="toctree-l3"><a class="reference internal" href="#docker-deploy-daemon-harp">Docker Deploy Daemon (HaRP)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#nextcloud-and-docker-on-the-same-host-with-nextcloud-bare-metal">Nextcloud and Docker on the same host - with Nextcloud bare metal</a></li>
<li class="toctree-l4"><a class="reference internal" href="#nextcloud-and-docker-on-the-same-host-with-nextcloud-in-docker">Nextcloud and Docker on the same host - with Nextcloud in Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="#docker-on-a-remote-host-with-harp-container-on-the-local-host">Docker on a remote host - with HaRP container on the local host</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#docker-deploy-daemon-docker-socket-proxy">Docker Deploy Daemon (Docker Socket Proxy)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#nc-docker-on-the-same-host">NC &amp; Docker on the Same-Host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#docker-on-a-remote-host">Docker on a remote host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#nc-exapps-in-the-same-docker">NC &amp; ExApps in the same Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="#nextcloud-in-docker-aio-all-in-one">Nextcloud in Docker AIO (all-in-one)</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#nc-to-exapp-communication">NC to ExApp Communication</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="ManagingDeployDaemons.html">Managing Deploy Daemons</a></li>
<li class="toctree-l2"><a class="reference internal" href="TestDeploy.html">Test Deploy Daemon</a></li>
<li class="toctree-l2"><a class="reference internal" href="ManagingExApps.html">Managing ExApps</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedDeployOptions.html">Advanced Deploy Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
</ul>
Users
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../desktop/index.html">Desktop Clients</a></li>
</ul>
Groupware
<ul>
<li class="toctree-l1"><a class="reference internal" href="../groupware/index.html">Groupware</a></li>
</ul>
Office
<ul>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
</ul>
Maintenance
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_monitoring/index.html">Monitoring</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
</ul>
Links
<ul>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/">Community Help Forum</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">User Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">Developer Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/install/">Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://apps.nextcloud.com">App Store</a></li>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/t/translation-knowledge-valid-for-the-entire-nextcloud-project-wiki/51550">Translations</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/">GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/wiki/Maintenance-and-Release-Schedule">Supported versions</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/enterprise/">Nextcloud Enterprise</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/blob/master/COPYING-README">License</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/">Nextcloud GmbH</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" >
 
 <a href="../contents.html">Nextcloud latest Administration Manual</a>
 </nav>

<div class="wy-nav-content">
 <div class="rst-content style-external-links">
 <div role="navigation" aria-label="Page navigation">
 <ul class="wy-breadcrumbs">
 <li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
 <li class="breadcrumb-item"><a href="index.html">ExApps management</a></li>
 <li class="breadcrumb-item active">Deployment configurations</li>
 <li class="wy-breadcrumbs-aside">
 <a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/exapps_management/DeployConfigurations.rst" class="fa fa-github"> Edit on GitHub</a>
 </li>
 </ul>
 <hr/>
</div>
 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 <div itemprop="articleBody">
 
 <section id="deployment-configurations">
<h1>Deployment configurations<a class="headerlink" href="#deployment-configurations" title="Link to this heading"></a></h1>
<dl class="simple">
<dt>Currently, two kinds of application deployments are supported:</dt><dd><ul class="simple">
<li><a class="reference internal" href="#ai-app-api-ddd-dsp">Docker Deploy Daemon (Docker Socket Proxy)</a></li>
<li><a class="reference internal" href="#ai-app-api-ddd-harp">Docker Deploy Daemon (HaRP)</a></li>
</ul>
</dd>
</dl>
<section id="docker-deploy-daemon">
<h2>Docker Deploy Daemon<a class="headerlink" href="#docker-deploy-daemon" title="Link to this heading"></a></h2>
Orchestrates the deployment of applications as Docker containers.
<div class="admonition warning">
Warning
<div class="line-block">
<div class="line">The administrator is responsible for the security actions taken to configure the Docker daemon connected to the Nextcloud instance.</div>
<div class="line">These schemes are only examples of possible configurations.</div>
</div>
<div class="line-block">
<div class="line">For Docker Deploy Daemon (HaRP), <a class="reference external" href="https://github.com/nextcloud/harp">AppAPI HaRP</a> is required.</div>
<div class="line">For Docker Deploy Daemon (Docker Socket Proxy), we recommend that you use the <a class="reference external" href="https://github.com/nextcloud/docker-socket-proxy">AppAPI Docker Socket Proxy</a> or <a class="reference external" href="#nextcloud-in-docker-aio-all-in-one">AIO Docker Socket Proxy</a> container for Nextcloud AIO.</div>
</div>
</div>
There are several Docker Daemon Deploy configurations (example schemes):
<blockquote>
<div><ul class="simple">
<li>Nextcloud and Docker on the same host (via socket, DockerSocketProxy, or HaRP)</li>
<li>Nextcloud on the host and Docker on a remote host (via DockerSocketProxy with HTTPS, or HaRP)</li>
<li>Nextcloud and ExApps in the same Docker network (via DockerSocketProxy, or HaRP)</li>
<li>Nextcloud in AIO Docker and ExApps in the same Docker network (via AIO DockerSocketProxy)</li>
</ul>
</div></blockquote>
</section>
<section id="docker-deploy-daemon-harp">
<h2>Docker Deploy Daemon (HaRP)<a class="headerlink" href="#docker-deploy-daemon-harp" title="Link to this heading"></a></h2>
<div class="line-block">
<div class="line">With HaRP, the ExApps initiate the connection for tunneling to the Nextcloud instance and the HaRP container so there is no need to expose any ports or open any firewall rules.</div>
<div class="line">See the diagrams of the respective configurations in the <a class="reference internal" href="#ai-app-api-ddd-dsp">Docker Deploy Daemon (Docker Socket Proxy)</a> section below.</div>
</div>
A little introduction to the default ports of the HaRP container is given below. More about it can be found in the <a class="reference external" href="https://github.com/nextcloud/harp?tab=readme-ov-file#environment-variables">HaRP’s readme</a>.
<ul class="simple">
<li>Port <code class="docutils literal notranslate">8780</code> is the HTTP communication port used where Nextcloud connects to the HaRP container.</li>
<li>Port <code class="docutils literal notranslate">8781</code> is the HTTPS communication port when setup.</li>
<li>Port <code class="docutils literal notranslate">8782</code> is the FRP tunnel port used by ExApps to connect to the HaRP container.</li>
</ul>
In any of the cases, the following connections should succeed:
<ul class="simple">
<li>Nextcloud -&gt; HaRP container (on port 8780/8781)</li>
<li>HaRP container -&gt; Nextcloud (through proxy or directly as the NC_INSTANCE_URL env var dictates)</li>
<li>ExApp -&gt; HaRP container (on port 8782)</li>
<li>ExApp -&gt; Nextcloud (through proxy or directly as the <code class="docutils literal notranslate">Nextcloud URL</code> in the daemon config dictates)</li>
</ul>
<section id="nextcloud-and-docker-on-the-same-host-with-nextcloud-bare-metal">
<h3>Nextcloud and Docker on the same host - with Nextcloud bare metal<a class="headerlink" href="#nextcloud-and-docker-on-the-same-host-with-nextcloud-bare-metal" title="Link to this heading"></a></h3>
The simplest configuration is when Nextcloud is installed on the host and docker is on the same host and applications are deployed to it.
Create a HaRP container with either <code class="docutils literal notranslate">--network host</code> option or expose the ports <code class="docutils literal notranslate">8780</code> and <code class="docutils literal notranslate">8782</code> to the host.
<div class="highlight-bash notranslate"><div class="highlight"><pre>docker run \
 -e HP_SHARED_KEY=&quot;some_very_secure_password&quot; \
 -e NC_INSTANCE_URL=&quot;https://127.0.0.1:8080&quot; \
 -v /var/run/docker.sock:/var/run/docker.sock \
 -v `pwd`/certs:/certs \
 --name appapi-harp -h appapi-harp \
 --restart unless-stopped \
 -p 8780:8780 \
 -p 8782:8782 \
 -d ghcr.io/nextcloud/nextcloud-appapi-harp:release
</pre></div>
</div>
Go to AppAPI admin settings and register a <code class="docutils literal notranslate">HaRP Proxy (Host)</code> daemon.
<img alt="../_images/harp_host.png" src="../_images/harp_host.png" />
Finally, test the whole setup with “Test deploy” in the 3-dots menu of the deploy daemon.
</section>
<section id="nextcloud-and-docker-on-the-same-host-with-nextcloud-in-docker">
<h3>Nextcloud and Docker on the same host - with Nextcloud in Docker<a class="headerlink" href="#nextcloud-and-docker-on-the-same-host-with-nextcloud-in-docker" title="Link to this heading"></a></h3>
When Nextcloud is installed in Docker, the HaRP container can be created in the same docker network as the Nextcloud instance.
Create a HaRP container with <code class="docutils literal notranslate">--network &lt;nextcloud_docker_network_name&gt;</code> option, where <code class="docutils literal notranslate">&lt;nextcloud_docker_network_name&gt;</code> is the name of the Docker network in which Nextcloud is accessible.
<div class="highlight-bash notranslate"><div class="highlight"><pre>docker run \
 -e HP_SHARED_KEY=&quot;some_very_secure_password&quot; \
 -e NC_INSTANCE_URL=&quot;https://nextcloud.tld&quot; \
 -v /var/run/docker.sock:/var/run/docker.sock \
 -v `pwd`/certs:/certs \
 --name appapi-harp -h appapi-harp \
 --restart unless-stopped \
 --net &lt;nextcloud_docker_network_name&gt; \
 -d ghcr.io/nextcloud/nextcloud-appapi-harp:release
</pre></div>
</div>
Go to AppAPI admin settings and register a <code class="docutils literal notranslate">HaRP Proxy (Docker)</code> daemon. Take note of the <code class="docutils literal notranslate">&lt;nextcloud_docker_network_name&gt;</code> value in the <code class="docutils literal notranslate">Docker network</code> field.
<img alt="../_images/harp_docker.png" src="../_images/harp_docker.png" />
Finally, test the whole setup with “Test deploy” in the 3-dots menu of the deploy daemon.
</section>
<section id="docker-on-a-remote-host-with-harp-container-on-the-local-host">
<h3>Docker on a remote host - with HaRP container on the local host<a class="headerlink" href="#docker-on-a-remote-host-with-harp-container-on-the-local-host" title="Link to this heading"></a></h3>
This configuration is suited for deployments that want to offload the heavy lifting of the ExApps to a remote host, especially when using GPUs as compute devices. There can be multiple deploy daemons that can be used to deploy ExApps on different remote hosts for different compute capabilities.
Here the HaRP container is deployed on the local host and the remote host tunnels the remote host’s docker socket to the local host over the <a class="reference external" href="https://github.com/fatedier/frp">FRP</a> secure tunnel. The ExApps are deployed on the remote host.
A setup with the HaRP container itself on the remote is not supported.
<ol class="arabic simple">
<li>Create a HaRP container in the local host following <a class="reference internal" href="#ai-app-api-nc-harp-baremetal">the above examples</a> but without the docker socket mount.</li>
</ol>
<blockquote>
<div><div class="highlight-bash notranslate"><div class="highlight"><pre>docker run \
 -e HP_SHARED_KEY=&quot;some_very_secure_password&quot; \
 -e NC_INSTANCE_URL=&quot;https://127.0.0.1:8080&quot; \
 -v `pwd`/certs:/certs \
 --name appapi-harp -h appapi-harp \
 --restart unless-stopped \
 -p 8780:8780 \
 -p 8782:8782 \
 -d ghcr.io/nextcloud/nextcloud-appapi-harp:release
</pre></div>
</div>
</div></blockquote>
<ol class="arabic simple" start="2">
<li>Create a matching deploy daemon with <code class="docutils literal notranslate">Docker socket proxy port</code> set to <code class="docutils literal notranslate">24001</code>.</li>
</ol>
<blockquote>
<div><img alt="../_images/harp_remote_24001.png" src="../_images/harp_remote_24001.png" />
</div></blockquote>
<ol class="arabic" start="3">
<li>The FRP generated client certificates should be present in the <code class="docutils literal notranslate">certs</code> folder locally. Copy the files <code class="docutils literal notranslate">client.crt</code>, <code class="docutils literal notranslate">client.key</code> and <code class="docutils literal notranslate">ca.crt</code> inside the <code class="docutils literal notranslate">certs</code> folder to the remote host.</li>
<li>Create a folder structure on the remote host: <code class="docutils literal notranslate">mkdir -p certs/frp</code> and copy the files <code class="docutils literal notranslate">client.crt</code>, <code class="docutils literal notranslate">client.key</code> and <code class="docutils literal notranslate">ca.crt</code> to the <code class="docutils literal notranslate">certs/frp</code> folder.</li>
<li>Create a new file <code class="docutils literal notranslate">frpc.toml</code> with the following contents.
<blockquote>
<div><div class="highlight-toml notranslate"><div class="highlight"><pre># frpc.toml
serverAddr = &quot;your.harp.server.address&quot; # Replace with your HP_FRP_ADDRESS host
serverPort = 8782 # Default port for FRP or the port your reverse proxy listens on
loginFailExit = false # If the FRP (HaRP) server is unavailable, continue trying to log in.

transport.tls.certFile = &quot;certs/frp/client.crt&quot;
transport.tls.keyFile = &quot;certs/frp/client.key&quot;
transport.tls.trustedCaFile = &quot;certs/frp/ca.crt&quot;
transport.tls.serverName = &quot;harp.nc&quot; # DO NOT CHANGE THIS VALUE

metadatas.token = &quot;some_very_secure_password&quot; # HP_SHARED_KEY in quotes

[[proxies]]
remotePort = 24001 # Unique remotePort for each Docker Engine (range: 24001-24099)
name = &quot;deploy-daemon-1&quot; # Unique name for each Docker Engine
type = &quot;tcp&quot;
[proxies.plugin]
type = &quot;unix_domain_socket&quot;
unixPath = &quot;/var/run/docker.sock&quot;
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line">Make sure to replace the <code class="docutils literal notranslate">your.harp.server.address</code> with the actual address of the local host where the HaRP container is running.</div>
<div class="line">You might want to open the port <code class="docutils literal notranslate">8782</code> on the local host firewall to allow the remote host to connect to it,</div>
<div class="line">or use a reverse proxy to forward the requests to the HaRP container. An example with nginx is given below. Feel free to adjust the port you want to listen on. The FRP client will connect to this port exposed port.</div>
<div class="line">With the reverse proxy config below, the whole setup would only need the main Nextcloud proxy to be exposed and reachable from the outside world, simplifying the network setup.</div>
</div>
<blockquote>
<div><div class="highlight-nginx notranslate"><div class="highlight"><pre>stream {
 server {
 listen 8782; # Replace with the port you want to listen on
 proxy_pass 127.0.0.1:8782;
 proxy_protocol off;
 proxy_connect_timeout 10s;
 proxy_timeout 300s;
 }
}
</pre></div>
</div>
</div></blockquote>
</li>
<li>Download a release of the FRP client from <a class="reference external" href="https://github.com/fatedier/frp/releases/latest">the official releases</a> or <a class="reference external" href="https://github.com/nextcloud/HaRP/tree/main/exapps_dev">our snapshot from here</a>.</li>
<li>Extract and copy the <code class="docutils literal notranslate">frpc</code> binary to an appropriate location on the remote host, e.g. <code class="docutils literal notranslate">/usr/local/bin</code>.</li>
<li>Make it executable: <code class="docutils literal notranslate">chmod +x /usr/local/bin/frpc</code>.</li>
<li>Start the FRP client with the command: <code class="docutils literal notranslate">frpc -c /path/to/frpc.toml</code>.</li>
<li>Finally, test the whole setup with “Test deploy” in the 3-dots menu of the deploy daemon.</li>
</ol>
</section>
</section>
<section id="docker-deploy-daemon-docker-socket-proxy">
<h2>Docker Deploy Daemon (Docker Socket Proxy)<a class="headerlink" href="#docker-deploy-daemon-docker-socket-proxy" title="Link to this heading"></a></h2>
<section id="nc-docker-on-the-same-host">
<h3>NC &amp; Docker on the Same-Host<a class="headerlink" href="#nc-docker-on-the-same-host" title="Link to this heading"></a></h3>
The simplest configuration is when Nextcloud is installed on the host and Docker is on the same host and applications are deployed to it.
<pre class="mermaid">
 stateDiagram-v2
 classDef docker fill: #1f97ee, color: white, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/docker.png) no-repeat center center / contain
 classDef nextcloud fill: #006aa3, color: white, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/nextcloud.svg) no-repeat center center / contain
 classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px

Host

state Host {
                Nextcloud --&gt; Daemon : /var/run/docker.sock
                Daemon --&gt; Containers

state Containers {
                        ExApp1
                        --
                        ExApp2
                        --
                        ExApp3
                }
        }

class Nextcloud nextcloud
 class Daemon docker
 class ExApp1 python
 class ExApp2 python
 class ExApp3 python
 </pre><dl class="simple">
<dt>Suggested config values(template Custom default):</dt><dd><ol class="arabic simple">
<li>Daemon host: <code class="docutils literal notranslate">/var/run/docker.sock</code></li>
<li>HTTPS checkbox: not supported using docker socket</li>
<li>Network: <code class="docutils literal notranslate">host</code></li>
<li>HaProxy password: not supported using raw docker socket, should be empty</li>
</ol>
</dd>
</dl>
—
Suggested way to communicate with Docker via <a class="reference external" href="https://github.com/nextcloud/docker-socket-proxy">Docker Socket Proxy container</a>.
<pre class="mermaid">
 stateDiagram-v2
 classDef docker fill: #1f97ee, color: white, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/docker.png) no-repeat center center / contain
 classDef nextcloud fill: #006aa3, color: white, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/nextcloud.svg) no-repeat center center / contain
 classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px

Host

state Host {
                Nextcloud --&gt; DockerSocketProxy: by port
                Docker --&gt; Containers
                Docker --&gt; DockerSocketProxy : /var/run/docker.sock

state Containers {
                        DockerSocketProxy --&gt; ExApp1
                        DockerSocketProxy --&gt; ExApp2
                        DockerSocketProxy --&gt; ExApp3
                }
        }

class Nextcloud nextcloud
 class Docker docker
 class ExApp1 python
 class ExApp2 python
 class ExApp3 python
 </pre><dl class="simple">
<dt>Suggested config values(template Docker Socket Proxy):</dt><dd><ol class="arabic simple">
<li><dl class="simple">
<dt>Daemon host: <code class="docutils literal notranslate">localhost:2375</code></dt><dd><dl class="simple">
<dt>Choose A or B option:</dt><dd><ol class="upperalpha simple">
<li>Docker Socket Proxy should be deployed with <code class="docutils literal notranslate">network=host</code> and <code class="docutils literal notranslate">BIND_ADDRESS=127.0.0.1</code></li>
<li>Docker Socket Proxy should be deployed with <code class="docutils literal notranslate">network=bridge</code> and it’s port should be published to host’s 127.0.0.1(e.g. -p 127.0.0.1:2375:2375)</li>
</ol>
</dd>
</dl>
</dd>
</dl>
</li>
<li>HTTPS checkbox: disabled</li>
<li>Network: <code class="docutils literal notranslate">host</code></li>
<li>HaProxy password: should not be empty</li>
</ol>
</dd>
</dl>
<div class="admonition warning">
Warning
Be careful with option <code class="docutils literal notranslate">A</code>, by default Docker Socket Proxy binds to <code class="docutils literal notranslate">*</code> if <code class="docutils literal notranslate">BIND_ADDRESS</code> is not specified during container creation.
Check opened ports after finishing configuration.
</div>
</section>
<section id="docker-on-a-remote-host">
<h3>Docker on a remote host<a class="headerlink" href="#docker-on-a-remote-host" title="Link to this heading"></a></h3>
Distributed configuration occurs when Nextcloud is installed on one host and Docker is located on a remote host, resulting in the deployment of applications on the remote host.
Benefit: no performance impact on Nextcloud host.
In this case, the AppAPI uses a Docker Socket Proxy deployed on remote host to access docker socket and ExApps.
<pre class="mermaid">
 stateDiagram-v2
 classDef docker fill: #1f97ee, color: white, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/docker.png) no-repeat center center / contain
 classDef nextcloud fill: #006aa3, color: white, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/nextcloud.svg) no-repeat center center / contain
 classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px

Direction LR

Host1 --&gt; Host2 : by port

state Host1 {
                Nextcloud
        }

state Host2 {
                [*] --&gt; DockerSocketProxy : by port
                Daemon --&gt; Containers

state Containers {
                        [*] --&gt; DockerSocketProxy : /var/run/docker.sock
                        DockerSocketProxy --&gt; ExApp1
                        DockerSocketProxy --&gt; ExApp2
                        DockerSocketProxy --&gt; ExApp3
                }
        }

class Nextcloud nextcloud
 class Daemon docker
 class ExApp1 python
 class ExApp2 python
 class ExApp3 python
 </pre><dl class="simple">
<dt>Suggested config values(template Docker Socket Proxy):</dt><dd><ol class="arabic simple">
<li>Daemon host: ADDRESS_OF_REMOTE_MACHINE (e.g. server_name.com:2375)</li>
<li>HTTPS checkbox: <code class="docutils literal notranslate">enabled</code></li>
<li>Network: <code class="docutils literal notranslate">host</code></li>
<li>HaProxy password: should not be empty</li>
</ol>
</dd>
</dl>
</section>
<section id="nc-exapps-in-the-same-docker">
<h3>NC &amp; ExApps in the same Docker<a class="headerlink" href="#nc-exapps-in-the-same-docker" title="Link to this heading"></a></h3>
Applications are deployed in the same Docker where Nextcloud resides.
Suggested way to communicate with Docker: via <code class="docutils literal notranslate">docker-socket-proxy</code>.
<pre class="mermaid">
 stateDiagram-v2
 classDef docker fill: #1f97ee, color: white, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/docker.png) no-repeat center center / contain
 classDef nextcloud fill: #006aa3, color: white, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/nextcloud.svg) no-repeat center center / contain
 classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px

Host

state Host {
                Daemon --&gt; Containers

state Containers {
                        [*] --&gt; DockerSocketProxy : /var/run/docker.sock
                        Nextcloud --&gt; DockerSocketProxy: by port
                        --
                        DockerSocketProxy --&gt; ExApp1
                        DockerSocketProxy --&gt; ExApp2
                }
        }

class Nextcloud nextcloud
 class Daemon docker
 class ExApp1 python
 class ExApp2 python
 class ExApp3 python
 </pre><dl class="simple">
<dt>Suggested config values(template Docker Socket Proxy):</dt><dd><ol class="arabic simple">
<li>Daemon host: nextcloud-appapi-dsp:2375</li>
<li>HTTPS checkbox: <code class="docutils literal notranslate">disabled</code></li>
<li>Network: <a class="reference external" href="https://docs.docker.com/network/#user-defined-networks">user defined network</a></li>
<li>HaProxy password: should not be empty</li>
</ol>
</dd>
</dl>
<div class="admonition note">
Note
Network should not be the default docker’s bridge as it does not support DNS resolving by container names.
This means that Docker Socket Proxy, Nextcloud and ExApps containers should all be in the same docker network, different from the default bridge.
</div>
</section>
<section id="nextcloud-in-docker-aio-all-in-one">
<h3>Nextcloud in Docker AIO (all-in-one)<a class="headerlink" href="#nextcloud-in-docker-aio-all-in-one" title="Link to this heading"></a></h3>
In the case of AppAPI in Docker AIO setup (installed in Nextcloud container).
<div class="admonition note">
Note
AIO Docker Socket Proxy container must be enabled.
</div>
<pre class="mermaid">
 stateDiagram-v2
 classDef docker fill: #1f97ee, color: white, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/docker.png) no-repeat center center / contain
 classDef docker2 fill: #1f97ee, color: white, font-size: 20px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/docker.png) no-repeat center center / contain
 classDef nextcloud fill: #006aa3, color: white, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/documentation/master/admin_manual/exapps_management/img/nextcloud.svg) no-repeat center center / contain
 classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px

Host

state Host {
                Daemon --&gt; Containers

state Containers {
                        [*] --&gt; NextcloudAIOMasterContainer : /var/run/docker.sock
                        [*] --&gt; DockerSocketProxy : /var/run/docker.sock
                        NextcloudAIOMasterContainer --&gt; Nextcloud
                        AppAPI --&gt; Nextcloud : installed in
                        Nextcloud --&gt; DockerSocketProxy
                        DockerSocketProxy --&gt; ExApp1
                        DockerSocketProxy --&gt; ExApp2
                        DockerSocketProxy --&gt; ExApp3
                }
        }

class Nextcloud nextcloud
 class Daemon docker
 class Daemon2 docker2
 class ExApp1 python
 class ExApp2 python
 class ExApp3 python
 </pre>AppAPI will automatically create the default DaemonConfig for AIO Docker Socket Proxy in order to use it as an orchestrator to create ExApp containers.
<div class="admonition note">
Note
Default DaemonConfig will be created only if the default DaemonConfig is not already registered.
</div>
<section id="default-aio-deploy-daemon-docker-socket-proxy">
<h4>Default AIO Deploy Daemon (Docker Socket Proxy)<a class="headerlink" href="#default-aio-deploy-daemon-docker-socket-proxy" title="Link to this heading"></a></h4>
Nextcloud AIO has a specifically created Docker Socket Proxy container to be used as the Deploy Daemon in AppAPI.
It has <a class="reference external" href="https://github.com/nextcloud/app_api/blob/main/lib/DeployActions/AIODockerActions.php#L52-L74)">fixed parameters</a>:
<ul class="simple">
<li>Name: <code class="docutils literal notranslate">docker_aio</code></li>
<li>Display name: <code class="docutils literal notranslate">AIO Docker Socket Proxy</code></li>
<li>Accepts Deploy ID: <code class="docutils literal notranslate">docker-install</code></li>
<li>Protocol: <code class="docutils literal notranslate">http</code></li>
<li>Host: <code class="docutils literal notranslate">nextcloud-aio-docker-socket-proxy:2375</code></li>
<li>Compute device: <code class="docutils literal notranslate">CPU</code></li>
<li>Network: <code class="docutils literal notranslate">nextcloud-aio</code></li>
<li>Nextcloud URL (passed to ExApps): <code class="docutils literal notranslate">https://$NC_DOMAIN</code></li>
</ul>
</section>
<section id="docker-socket-proxy-security">
<h4>Docker Socket Proxy security<a class="headerlink" href="#docker-socket-proxy-security" title="Link to this heading"></a></h4>
AIO Docker Socket Proxy has strictly limited access to the Docker APIs described in <a class="reference external" href="https://github.com/nextcloud/all-in-one/blob/main/Containers/docker-socket-proxy/haproxy.cfg">HAProxy configuration</a>.
</section>
</section>
</section>
<section id="nc-to-exapp-communication">
<h2>NC to ExApp Communication<a class="headerlink" href="#nc-to-exapp-communication" title="Link to this heading"></a></h2>
Communications between Nextcloud and ExApps are done via the AppAPI.
With Docker Socket Proxy, the requests are sent to the ExApp container directly.
For HaRP, the communication goes through the main Nextcloud proxy and the HaRP container.
Each type of DeployDaemon necessarily implements the <code class="docutils literal notranslate">resolveExAppUrl</code> function.
It has the prototype:
<div class="highlight-php notranslate"><div class="highlight"><pre>public function resolveExAppUrl(
 string $appId, string $protocol, string $host, array $deployConfig, int $port, array &amp;$auth
) {}
</pre></div>
</div>
where:
<ul class="simple">
<li>protocol is daemon protocol value</li>
<li>host is daemon host value, can be DNS:port or IP:PORT or even path to docker socket.</li>
<li>port is an integer with ExApp port</li>
<li>deployConfig can be custom for each Daemon type</li>
<li>auth is an optional array, with Basic Authentication data if needed to access ExApp</li>
</ul>
<div class="admonition note">
Note
Applies only to Docker Socket Proxy.
The optional additional parameter OVERRIDE_APP_HOST can be used to
override the host that will be used for ExApp binding.
It can be <code class="docutils literal notranslate">0.0.0.0</code> in some specific configurations, when VPN is used
or both Nextcloud instance and ExApps are one the same physical machine but different virtual environments.
Also you can specify something like <code class="docutils literal notranslate">10.10.2.5</code> and in this case <code class="docutils literal notranslate">ExApp</code> will try to bind to that address and
AppAPI will try to send request s directly to this address assuming that ExApp itself bound on it.
</div>
The simplest implementation is in the Manual-Install deploy type:
<div class="highlight-php notranslate"><div class="highlight"><pre>public function resolveExAppUrl(
 string $appId, string $protocol, string $host, array $deployConfig, int $port, array &amp;$auth
): string {
 if (boolval($deployConfig[&#39;harp&#39;] ?? false)) {
 $url = rtrim($deployConfig[&#39;nextcloud_url&#39;], &#39;/&#39;);
 if (str_ends_with($url, &#39;/index.php&#39;)) {
 $url = substr($url, 0, -10);
 }
 return sprintf(&#39;%s/exapps/%s&#39;, $url, $appId);
 }

$auth = [];
 if (isset($deployConfig[&#39;additional_options&#39;][&#39;OVERRIDE_APP_HOST&#39;]) &amp;&amp;
 $deployConfig[&#39;additional_options&#39;][&#39;OVERRIDE_APP_HOST&#39;] !== &#39;&#39;
 ) {
 $wideNetworkAddresses = [&#39;0.0.0.0&#39;, &#39;127.0.0.1&#39;, &#39;::&#39;, &#39;::1&#39;];
 if (!in_array($deployConfig[&#39;additional_options&#39;][&#39;OVERRIDE_APP_HOST&#39;], $wideNetworkAddresses)) {
 return sprintf(
 &#39;%s://%s:%s&#39;, $protocol, $deployConfig[&#39;additional_options&#39;][&#39;OVERRIDE_APP_HOST&#39;], $port
 );
 }
 }
 $host = explode(&#39;:&#39;, $host)[0];
 if ($protocol == &#39;https&#39;) {
 $exAppHost = $host;
 } elseif (isset($deployConfig[&#39;net&#39;]) &amp;&amp; $deployConfig[&#39;net&#39;] === &#39;host&#39;) {
 $exAppHost = &#39;localhost&#39;;
 } else {
 $exAppHost = $appId;
 }
 if ($protocol == &#39;https&#39; &amp;&amp; isset($deployConfig[&#39;haproxy_password&#39;]) &amp;&amp; $deployConfig[&#39;haproxy_password&#39;] !== &#39;&#39;) {
 // we only set haproxy auth for remote installations, when all requests come through HaProxy.
 $haproxyPass = $this-&gt;crypto-&gt;decrypt($deployConfig[&#39;haproxy_password&#39;]);
 $auth = [self::APP_API_HAPROXY_USER, $haproxyPass];
 }
 return sprintf(&#39;%s://%s:%s&#39;, $protocol, $exAppHost, $port);
}
</pre></div>
</div>
The route for HaRP setups remain the same here as in the previous example. All the requests are sent to the Nextcloud URL with the <code class="docutils literal notranslate">/exapps/</code> route.
For Docker Socket Proxy, however, we have much more complex algorithm of detecting to where requests should be send.
First of all, if the protocol is set to <code class="docutils literal notranslate">https</code>, AppAPI always sends requests to the daemon host,
and in this case, it is a HaProxy that will forward requests to ExApps that will be listening on <code class="docutils literal notranslate">localhost</code>.
Briefly, it will look like this (haproxy_host==daemon host value):
NC –&gt; https –&gt; <code class="docutils literal notranslate">haproxy_host:ex_app_port</code> –&gt; http –&gt; <code class="docutils literal notranslate">localhost:ex_app_port</code>
When the protocol is not <code class="docutils literal notranslate">https</code> but <code class="docutils literal notranslate">http</code>, then what will be the endpoint where to send requests is determined by <code class="docutils literal notranslate">$deployConfig['net']</code> value.
If <code class="docutils literal notranslate">net</code> is defined and equal to <code class="docutils literal notranslate">host</code>, then AppAPI assumes that ExApp is installed somewhere in the current host network and will be available on <code class="docutils literal notranslate">localhost</code> loop-back adapter.
NC –&gt; http –&gt; <code class="docutils literal notranslate">localhost:ex_app_port</code>
In all other cases, the ExApp should be available by it’s name: e.g. when using docker custom bridge network all containers available by DNS.
NC –&gt; http –&gt; <code class="docutils literal notranslate">app_container_name:ex_app_port</code>
These three different types of communication cover most popular configurations.
</section>
</section>

</div>
 </div>
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
 <a href="AppAPIAndExternalApps.html" class="btn btn-neutral float-left" title="AppAPI and External Apps" accesskey="p" rel="prev"> Previous</a>
 <a href="ManagingDeployDaemons.html" class="btn btn-neutral float-right" title="Managing Deploy Daemons" accesskey="n" rel="next">Next </a>
 </div>

<hr/>

<div role="contentinfo">
 &#169; Copyright 2016-2026 Nextcloud GmbH and Nextcloud contributors.
 </div>

</footer>
 </div>
 </div>
 </section>
 </div>

<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
 
 ☁️ latest
 
 
 <div class="rst-other-versions">
 <dl>
 <dt>☁️ Versions</dt>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/latest/admin_manual"
 
 style="color: var(--dark-link-color);"
 
 >
 latest
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/stable/admin_manual"
 
 >
 stable
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/32/admin_manual"
 
 >
 32
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/31/admin_manual"
 
 >
 31
 </a>
 </dd>
 
 </dl>
 </div>
 </div>
<script>
 jQuery(function () {
 SphinxRtdTheme.Navigation.enable(true);
 });
 </script>

</body>
</html>

Cancel