CINXE.COM
Welcome — tsuru 1.3.1 documentation
<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Welcome — tsuru 1.3.1 documentation</title> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Understanding" href="understanding/index.html" /> <link rel="stylesheet" href="_static/css/theme_overrides.css" type="text/css" /> <script src="_static/js/modernizr.min.js"></script> </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="#" class="icon icon-home"> tsuru </a> <div class="version"> 1.3.1 </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" /> <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="main navigation"> <ul> <li class="toctree-l1"><a class="reference internal" href="understanding/index.html">Understanding</a></li> <li class="toctree-l1"><a class="reference internal" href="installing/index.html">Installing</a></li> <li class="toctree-l1"><a class="reference internal" href="managing/index.html">Managing</a></li> <li class="toctree-l1"><a class="reference internal" href="using/index.html">Using</a></li> <li class="toctree-l1"><a class="reference internal" href="services/index.html">Services</a></li> <li class="toctree-l1"><a class="reference internal" href="advanced_topics/index.html">Advanced topics</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="releases/index.html">Release notes</a></li> <li class="toctree-l1"><a class="reference internal" href="experimental/index.html">Experimental</a></li> <li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">tsuru</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="#">Docs</a> »</li> <li>Welcome</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.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"> <div class="section" id="welcome"> <h1>Welcome<a class="headerlink" href="#welcome" title="Permalink to this headline">露</a></h1> <p>tsuru is an open source PaaS that makes it easy and fast to deploy and manage applications on your own servers.</p> <p>To get started, first read <a class="reference internal" href="understanding/index.html#understanding"><span class="std std-ref">understanding tsuru</span></a>.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="understanding/index.html">Understanding</a><ul> <li class="toctree-l2"><a class="reference internal" href="understanding/overview.html">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="understanding/concepts.html">Concepts</a></li> <li class="toctree-l2"><a class="reference internal" href="understanding/architecture.html">Architecture</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="installing/index.html">Installing</a><ul> <li class="toctree-l2"><a class="reference internal" href="installing/api.html">API Server</a></li> <li class="toctree-l2"><a class="reference internal" href="installing/planb-router.html">PlanB Router</a></li> <li class="toctree-l2"><a class="reference internal" href="installing/adding-nodes.html">Adding Nodes</a></li> <li class="toctree-l2"><a class="reference internal" href="installing/dashboard.html">Dashboard</a></li> <li class="toctree-l2"><a class="reference internal" href="installing/gandalf.html">Gandalf (Optional)</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="managing/index.html">Managing</a><ul> <li class="toctree-l2"><a class="reference internal" href="managing/add-platform.html">Installing platforms</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/create-platform.html">Creating a platform</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/using-pools.html">Using Pools</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/segregate-scheduler.html">Segregate Scheduler</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/upgrading-docker.html">Upgrading Docker</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/repositories.html">Managing Git repositories and SSH keys</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/users-and-permissions.html">Managing users and permissions</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/logs.html">Managing Application Logs</a></li> <li class="toctree-l2"><a class="reference internal" href="managing/debugging-and-troubleshooting.html">Debugging and Troubleshooting</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="using/index.html">Using</a><ul> <li class="toctree-l2"><a class="reference internal" href="using/install-client.html">Installing tsuru client</a></li> <li class="toctree-l2"><a class="reference internal" href="using/deploying.html">Deploying</a></li> <li class="toctree-l2"><a class="reference internal" href="using/app-deploy.html">App-Deploy</a></li> <li class="toctree-l2"><a class="reference internal" href="using/quickstart.html">Building your app in tsuru</a></li> <li class="toctree-l2"><a class="reference internal" href="using/python.html">Deploying Python applications</a></li> <li class="toctree-l2"><a class="reference internal" href="using/ruby.html">Deploying Ruby applications</a></li> <li class="toctree-l2"><a class="reference internal" href="using/go.html">Deploying Go applications</a></li> <li class="toctree-l2"><a class="reference internal" href="using/java.html">Deploying Java applications</a></li> <li class="toctree-l2"><a class="reference internal" href="using/php.html">Deploying PHP applications</a></li> <li class="toctree-l2"><a class="reference internal" href="using/docker-image.html">Deploying Docker Image applications</a></li> <li class="toctree-l2"><a class="reference internal" href="using/buildpacks.html">Using Buildpacks</a></li> <li class="toctree-l2"><a class="reference internal" href="using/services.html">Using services with your app</a></li> <li class="toctree-l2"><a class="reference internal" href="using/recovery.html">Recovering an application</a></li> <li class="toctree-l2"><a class="reference internal" href="using/logging.html">Logging</a></li> <li class="toctree-l2"><a class="reference internal" href="using/procfile.html">Procfile</a></li> <li class="toctree-l2"><a class="reference internal" href="using/tsuru.yaml.html">tsuru.yaml</a></li> <li class="toctree-l2"><a class="reference internal" href="using/unit-states.html">Unit states</a></li> <li class="toctree-l2"><a class="reference internal" href="using/cli/plugins.html">tsuru client plugins</a></li> <li class="toctree-l2"><a class="reference internal" href="using/deployment.html">Application Deployment</a></li> <li class="toctree-l2"><a class="reference internal" href="using/application-pool.html">Choose a pool to deploy your app</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="services/index.html">Services</a><ul> <li class="toctree-l2"><a class="reference internal" href="services/api.html">API workflow</a></li> <li class="toctree-l2"><a class="reference internal" href="services/build.html">Building your service</a></li> <li class="toctree-l2"><a class="reference internal" href="services/tsuru-services-env-var.html">TSURU_SERVICES environment variable</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="advanced_topics/index.html">Advanced topics</a><ul> <li class="toctree-l2"><a class="reference internal" href="advanced_topics/metrics.html">Metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="advanced_topics/node_scaling.html">Node Auto Scaling</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a><ul> <li class="toctree-l2"><a class="reference internal" href="contributing/index.html#fixing-typos-and-enhancing-the-documentation">Fixing typos and enhancing the documentation</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/index.html#adding-new-features">Adding new features</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/index.html#submitting-changes">Submitting Changes</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/index.html#development-environment">Development environment</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/index.html#running-the-tests">Running the tests</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/index.html#release-process">Release Process</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/index.html#discussing">Discussing</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference</a><ul> <li class="toctree-l2"><a class="reference internal" href="reference/tsuru-client.html">tsuru client usage</a></li> <li class="toctree-l2"><a class="reference internal" href="reference/bs.html">bs</a></li> <li class="toctree-l2"><a class="reference internal" href="reference/config.html">tsuru.conf reference</a></li> <li class="toctree-l2"><a class="reference internal" href="reference/api.html">API reference</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul> <li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-environment-variables-work">How do environment variables work?</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#how-does-the-quota-system-work">How does the quota system work?</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#how-does-routing-work">How does routing work?</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#how-are-git-repositories-managed">How are Git repositories managed?</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="releases/index.html">Release notes</a><ul> <li class="toctree-l2"><a class="reference internal" href="releases/index.html#tsurud-tsuru-server-daemon">tsurud (tsuru server daemon)</a></li> <li class="toctree-l2"><a class="reference internal" href="releases/index.html#tsuru">tsuru</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="experimental/index.html">Experimental</a><ul> <li class="toctree-l2"><a class="reference internal" href="experimental/installer.html">tsuru Installer</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a><ul> <li class="toctree-l2"><a class="reference internal" href="roadmap.html#release-process">Release Process</a></li> </ul> </li> </ul> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="understanding/index.html" class="btn btn-neutral float-right" title="Understanding" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2017, tsuru authors. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> Versions</span> v: 1.3.1 <span class="fa fa-caret-down"></span> </span> <div class="rst-other-versions"> <dl> <dd><a href="/stable/">stable</a></dd> <dd><a href="/latest/">latest</a></dd> <dd><a href="/main/">main</a></dd> </dl> <dl> <dt>Releases</dt> <dd><a href="/1.12/">1.12</a></dd> <dd><a href="/1.11/">1.11</a></dd> <dd><a href="/1.10/">1.10</a></dd> <dd><a href="/1.9/">1.9</a></dd> <dd><a href="/1.8/">1.8</a></dd> <dd><a href="/1.7/">1.7</a></dd> <dd><a href="/1.6/">1.6</a></dd> <dd><a href="/1.5/">1.5</a></dd> <dd><a href="/1.4/">1.4</a></dd> <dd><a href="/1.3/">1.3</a></dd> <dd><a href="/1.2/">1.2</a></dd> <dd><a href="/1.1/">1.1</a></dd> <dd><a href="/1.0/">1.0</a></dd> <dd><a href="/0.13/">0.13</a></dd> <dd><a href="/0.12/">0.12</a></dd> <dd><a href="/0.11/">0.11</a></dd> <dd><a href="/0.10/">0.10</a></dd> <dd><a href="/0.9/">0.9</a></dd> <dd><a href="/0.8/">0.8</a></dd> <dd><a href="/0.7/">0.7</a></dd> <dd><a href="/0.6/">0.6</a></dd> <dd><a href="/0.5/">0.5</a></dd> <dd><a href="/0.4/">0.4</a></dd> <dd><a href="/0.3/">0.3</a></dd> <dd><a href="/0.2/">0.2</a></dd> <dd><a href="/0.1/">0.1</a></dd> </dl> <hr /> </div> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'1.3.1', LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>