mirror of
https://github.com/caprover/caprover
synced 2026-05-12 14:40:39 +00:00
Kasra Bigdeli
77 lines
17 KiB
HTML
77 lines
17 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Troubleshooting · CaptainDuckDuck</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p><br/></p>
|
||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Troubleshooting · CaptainDuckDuck"/><meta property="og:type" content="website"/><meta property="og:url" content="https://www.captainduckduck.com/index.html"/><meta property="og:description" content="<p><br/></p>
|
||
"/><meta property="og:image" content="https://www.captainduckduck.com/img/captainduckduck.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://www.captainduckduck.com/img/captainduckduck.png"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/captainduckduck.png" alt="CaptainDuckDuck"/><h2 class="headerTitleWithLogo">CaptainDuckDuck</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/get-started.html" target="_self">Docs</a></li><li class=""><a href="https://github.com/githubsaturn/captainduckduck" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Help</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Basics</h3><ul><li class="navListItem"><a class="navItem" href="/docs/get-started.html">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/docs/captain-definition-file.html">Captain Definition File</a></li><li class="navListItem"><a class="navItem" href="/docs/deployment-methods.html">Deployment Methods</a></li><li class="navListItem"><a class="navItem" href="/docs/app-configuration.html">App Configuration</a></li><li class="navListItem"><a class="navItem" href="/docs/complete-webapp-tutorial.html">Complete Webapp Tutorial</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Do More</h3><ul><li class="navListItem"><a class="navItem" href="/docs/enabling-https.html">Enabling HTTPS</a></li><li class="navListItem"><a class="navItem" href="/docs/one-click-apps.html">One-Click Apps</a></li><li class="navListItem"><a class="navItem" href="/docs/resource-monitoring.html">Resource Monitoring</a></li><li class="navListItem"><a class="navItem" href="/docs/nginx-customization.html">NGINX Config</a></li><li class="navListItem"><a class="navItem" href="/docs/app-scaling-and-cluster.html">App Scaling & Cluster</a></li><li class="navListItem"><a class="navItem" href="/docs/pre-deploy-script.html">Pre-deploy Script</a></li><li class="navListItem"><a class="navItem" href="/docs/cli-commands.html">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/run-locally.html">Run Locally</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Recipes and Tips</h3><ul><li class="navListItem"><a class="navItem" href="/docs/recipe-deploy-create-react-app.html">Static React App</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Help</h3><ul><li class="navListItem"><a class="navItem" href="/docs/server-purchase.html">Server Purchase</a></li><li class="navListItem"><a class="navItem" href="/docs/disk-cleanup.html">Disk Clean-Up</a></li><li class="navListItem"><a class="navItem" href="/docs/firewall.html">Firewall & Port Forwarding</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/troubleshooting.html">Troubleshooting</a></li></ul></div></div></section></div><script>
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||
createToggler('#tocToggler', 'body', 'tocActive');
|
||
|
||
const headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
if (event.target.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
}
|
||
}, false);
|
||
|
||
function createToggler(togglerSelector, targetSelector, className) {
|
||
var toggler = document.querySelector(togglerSelector);
|
||
var target = document.querySelector(targetSelector);
|
||
|
||
if (!toggler) {
|
||
return;
|
||
}
|
||
|
||
toggler.onclick = function(event) {
|
||
event.preventDefault();
|
||
|
||
target.classList.toggle(className);
|
||
};
|
||
}
|
||
});
|
||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">Troubleshooting</h1></header><article><div><span><p><br/></p>
|
||
<p>This section covers most frequent issues that uses may encounter.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="cannot-connect-ip-server-3000"></a><a href="#cannot-connect-ip-server-3000" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Cannot connect <ip_server>:3000?</h2>
|
||
<p>There is a whole set of reasons for this.</p>
|
||
<p>First you need to make sure that CaptainDuckDuck is running on your server. To check this, ssh to your server and run <code>docker service ps captain-captain --no-trunc</code>. You might see Captain is getting restarted constantly due to an error. Fix the issue and retry. For example, see <a href="https://github.com/githubsaturn/captainduckduck/issues/14#issuecomment-345447689">here</a></p>
|
||
<p>Linode for example is notorious for <a href="https://github.com/docker/machine/issues/2753#issuecomment-171822791">this kind of problem</a> and <a href="https://github.com/docker/machine/issues/2753#issuecomment-188353704">this</a></p>
|
||
<p>If you don't see any errors when your ran <code>docker service ps captain-captain --no-trunc</code>, then try <code>curl localhost:3000 -v</code>. If successful, it's probably your firewall that's blocking the connection. See <a href="/docs/firewall.html">Firewall Docs</a>.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="successful-deploy-but-502-bad-gateway-error"></a><a href="#successful-deploy-but-502-bad-gateway-error" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Successful Deploy but 502 bad gateway error!</h2>
|
||
<p>This applies to you if:</p>
|
||
<ul>
|
||
<li>You have been able to setup your server and access it via <code>captain.rootdomain.example.com</code>.</li>
|
||
<li>You have been able to deploy one of the samples apps (see <a href="https://github.com/githubsaturn/captainduckduck/tree/master/captain-sample-apps">here</a>) successfully and it worked.</li>
|
||
<li>You tried to deploy your own application and it deployed successfully, but when you try to access it via <code>yourappname.root.example.com</code> you get a 502 error.</li>
|
||
</ul>
|
||
<p>If all above points are correct, this is how to troubleshoot:</p>
|
||
<ul>
|
||
<li>SSH to your server and view your application logs. Make sure it hasn't crashed and it's running. To view logs, please see the section at the end of this page "<a href="#how-to-view-my-applications-log">How to view my application's log</a>"</li>
|
||
<li>If you application logs show that your application is running, the most common case is that your application is binding to a custom port, not port 80. See here for <a href="https://github.com/githubsaturn/captainduckduck/issues/130">the fix</a> .</li>
|
||
</ul>
|
||
<h2><a class="anchor" aria-hidden="true" id="want-to-customize-a-captain-dashboard-url-or-any-other-constants"></a><a href="#want-to-customize-a-captain-dashboard-url-or-any-other-constants" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Want to customize a captain dashboard URL (or any other constants)</h2>
|
||
<p>You can customize any constant defined in <a href="https://github.com/githubsaturn/captainduckduck/blob/master/app-backend/src/utils/CaptainConstants.js">CaptainConstants</a> by adding a JSON file to <code>/captain/constants.conf</code>. For example, to change <code>defaultMaxLogSize</code>, the content of <code>/captain/constants.conf</code> will be:</p>
|
||
<pre><code class="hljs">{
|
||
<span class="hljs-attr">"defaultMaxLogSize"</span>:<span class="hljs-string">"128m"</span>
|
||
}
|
||
</code></pre>
|
||
<h2><a class="anchor" aria-hidden="true" id="how-to-view-my-application-s-log"></a><a href="#how-to-view-my-application-s-log" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>How to view my application's log?</h2>
|
||
<p>Your application is deployed as a Docker service. For example, if your app name in captain is <code>my-app</code> you can view your logs by connecting to your server via SSH and run the following command:</p>
|
||
<pre><code class="hljs">docker<span class="hljs-built_in"> service </span>logs srv-captain--my-app --since 60m --follow
|
||
</code></pre>
|
||
<p>Note that Docker service name is prefixed with <code>srv-captain--</code>. Also, you can replace 60m with 10m to view last 10 minutes.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="how-to-restart-my-application"></a><a href="#how-to-restart-my-application" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>How to restart my application?</h2>
|
||
<p>If your application is not behaving well, you can try force restarting it by going to the web dashboard and select your app, then click on "Save Configuration & Update" button. It will forcefully restarts your application.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="how-to-restart-captainduckduck"></a><a href="#how-to-restart-captainduckduck" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>How to restart CaptainDuckDuck</h2>
|
||
<p>If your CaptainDuckDuck is not behaving well, you can try force restarting CaptainDuckDuck using:</p>
|
||
<pre><code class="hljs">docker<span class="hljs-built_in"> service </span>update captain-captain --force
|
||
</code></pre>
|
||
<p>Alternatively, you can go to CaptainDuckDuck dashboard, select your app, without changing anything, simply click on SAVE AND UPDATE CONFIGURATIONS button at the bottom of the page. This will force restart your app.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="how-to-stop-and-remove-captain"></a><a href="#how-to-stop-and-remove-captain" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>How to stop and remove Captain?</h2>
|
||
<p>Captain uses docker swarm to support clustering and restarting containers if they stop. That's why it keeps re-appearing. Try this:</p>
|
||
<p><code>docker service rm $(docker service ls -q)</code></p>
|
||
<p>then</p>
|
||
<p><code>docker swarm leave --force</code></p>
|
||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/firewall.html"><span class="arrow-prev">← </span><span>Firewall & Port Forwarding</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#cannot-connect-ip-server-3000">Cannot connect :3000?</a></li><li><a href="#successful-deploy-but-502-bad-gateway-error">Successful Deploy but 502 bad gateway error!</a></li><li><a href="#want-to-customize-a-captain-dashboard-url-or-any-other-constants">Want to customize a captain dashboard URL (or any other constants)</a></li><li><a href="#how-to-view-my-application-s-log">How to view my application's log?</a></li><li><a href="#how-to-restart-my-application">How to restart my application?</a></li><li><a href="#how-to-restart-captainduckduck">How to restart CaptainDuckDuck</a></li><li><a href="#how-to-stop-and-remove-captain">How to stop and remove Captain?</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/captainduckduck.png" alt="CaptainDuckDuck" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/get-started.html">Getting Started</a></div><div><h5>Community</h5><a href="https://twitter.com/search?vertical=default&q=captainduckduck&src=typd" target="_blank" rel="noreferrer noopener">Twitter</a><a href="https://join.slack.com/t/captainduckduck/shared_invite/enQtNDEwMjc3MjcxNjUzLWQ4YjljN2JiMGU5Nzk5NjcwMDEzNDNiMTNkOTVhNTA4YTYwOThkNDkyMTlkMDFhMzAzOTA5YjcwY2E4NWRkYzk" target="_blank" rel="noreferrer noopener">Slack Group</a></div><div><h5>More</h5><a href="https://github.com/githubsaturn/captainduckduck" target="_blank">GitHub</a><a class="github-button" href="https://github.com/githubsaturn/captainduckduck" data-icon="octicon-star" data-count-href="/githubsaturn/captainduckduck/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 githubsaturn</section><script async="" src="https://www.googletagmanager.com/gtag/js?id=UA-121064489-1"></script><script>
|
||
window.dataLayer = window.dataLayer || [];
|
||
function gtag(){dataLayer.push(arguments);}
|
||
gtag('js', new Date());
|
||
gtag('config', 'UA-121064489-1');
|
||
</script></footer></div></body></html> |