Apache Sling :: Getting Started

<!DOCTYPE html><html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/> <title>Apache Sling :: Getting Started</title> <link rel="icon" href="/favicon.ico"/> <link rel="stylesheet" href="/res/css/bulma.min.css"/> <link rel="stylesheet" href="/res/css/site.css"/> <script src='https://www.apachecon.com/event-images/snippet.js'></script><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/> <script src='https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js'></script><script> hljs.initHighlightingOnLoad(); </script>  <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="https://matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '6']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script>  <link href='/pagefind/pagefind-ui.css' rel='stylesheet'><script src='/pagefind/pagefind-ui.js' type='text/javascript'></script> <script> window.addEventListener('DOMContentLoaded', (event) => { new PagefindUI({ element: "#searchbox" }); }); </script> </head> <body> <div class="section"> <div class="level is-marginless"> <div class="logo"> <a href="https://sling.apache.org"> <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="https://www.apache.org"> <img border="0" alt="Apache" src="/res/logos/apache.png"/> </a> </div> </div><section class="searchbox level is-marginless"> <div id="searchbox"></div> </section><div class="columns is-gapless"> <div class="column is-narrow sidemenu"> <div class="container"> <nav class="menu"> <ul class="menu-list box is-shadowless is-marginless"> <li> <p class="menu-label"> <strong>Documentation</strong> </p><ul> <li><a href="/documentation.html">Overview</a></li><li><a href="/documentation/getting-started.html">Getting Started</a></li><li><a href="/documentation/the-sling-engine.html">The Sling Engine</a></li><li><a href="/documentation/development.html">Development</a></li><li><a href="/documentation/bundles.html">Bundles</a></li><li><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a></li><li><a href="/components/">Maven Plugins</a></li><li><a href="/documentation/configuration.html">Configuration</a></li> </ul> </li><li> <p class="menu-label"> <strong>API Docs</strong> </p><ul> <li><a href="/apidocs/sling13/index.html">Sling 13</a></li><li><a href="/apidocs/sling12/index.html">Sling 12</a></li><li><a href="/apidocs/sling11/index.html">Sling 11</a></li><li><a href="/apidocs/sling10/index.html">Sling 10</a></li><li><a href="/apidocs/sling9/index.html">Sling 9</a></li><li><a href="/documentation/apidocs.html">All versions</a></li> </ul> </li><li> <p class="menu-label"> <strong>Support</strong> </p><ul> <li><a href="https://s.apache.org/sling.wiki">Wiki</a></li><li><a href="https://s.apache.org/sling.faq">FAQ</a></li><li><a href="/sitemap.html">Sitemap</a></li> </ul> </li><li> <p class="menu-label"> <strong>Project Info</strong> </p><ul> <li><a href="/downloads.cgi">Downloads</a></li><li><a href="https://www.apache.org/licenses/">License</a></li><li><a href="/news.html">News</a></li><li><a href="/releases.html">Releases</a></li><li><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a></li><li><a href="/links.html">Links</a></li><li><a href="/contributing.html">Contributing</a></li><li><a href="/project-information.html">Project Information</a></li><li><a href="/project-information/security.html">Security</a></li> </ul> </li><li> <p class="menu-label"> <strong>Source</strong> </p><ul> <li><a href="/repolist.html">Repositories</a></li><li><a href="https://gitbox.apache.org/repos/asf#sling">Git at Apache</a></li> </ul> </li><li> <p class="menu-label"> <strong>Apache Software<br>Foundation</strong> </p><ul> <li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li><li><a href="https://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a></li> </ul> </li><li> <a class="acevent" data-format="square" data-event="random"></a> </li><li> <a href="https://apache.org/foundation/contributing.html" class="column"> <img border="0" alt="Support the Apache Software Foundation!" src="/res/images/SupportApache-small.png" width="125"/> </a> </li> </ul> </nav> </div> </div><div class="column main"> <div class="box is-shadowless is-marginless"> <div class="level"> <div class="pagenav"> <div class="breadcrumb"> <ul> <li> <a href="/"> Home </a> </li><li> <a href="/documentation.html"> Documentation </a> </li> </ul> </div> </div><div class="tags"> <span class="tag"> <a href="/tags/tutorials.html"> tutorials </a> </span> </div> </div><h1 class="title"> Getting Started </h1><nav class="menu"> <ul class="menu-list box is-shadowless is-paddingless"> <li id="generatedToC"> <p class="menu-label"> <strong>Table of Contents</strong> </p> </li> </ul> </nav><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=title],h2,h3','ulClass':'menu-list'}); } );</script><div class="content is-marginless"> <div class="row" data-pagefind-body="true"><div><section><h1><a href="#run-the-sling-application" id="run-the-sling-application">Run the Sling Application</a></h1> <p>There are different ways to get Apache Sling running. You can either use Docker, download a distribution or build it from source.</p> <h2><a href="#sling-docker-image" id="sling-docker-image">Sling Docker Image</a></h2> <p>The preferred way to get Apache Sling running is to use Docker. If you don't have Docker installed you can skip to the next section.</p> <p>We maintain a docker image of our latest release at <a href="https://hub.docker.com/r/apache/sling">Apache Sling Docker Image</a>.</p> <p>The simplest command to launch Sling is:</p> <pre><code>docker run -p 8080:8080 -v /tmp/sling:/opt/sling/sling apache/sling:13 </code></pre> <p>This will start the latest released version of Apache Sling distribution and mount the Sling directory to <em>/tmp/sling</em> on your machine. Make sure that your docker configuration allows this or change to a different directory.</p> <h2><a href="#sling-features" id="sling-features">Sling Features</a></h2> <p>Another option is to download the latest released Apache Sling standalone feature archive and the Sling Feature Launcher from our <a href="/downloads.cgi">Downloads</a> section. Once you have downloaded them, unzip the Feature Launcher Archive and ensure that you have Java 8 or later installed.</p> <p>Launch Sling with</p> <pre><code>./org.apache.sling.feature.launcher-*/bin/launcher -f org.apache.sling.starter-13-oak_*_far.far </code></pre> <p>Starting the Sling application creates the Sling directory name <em>launcher</em> in the same directory from where you started the above command.</p> <h2><a href="#sling-karaf" id="sling-karaf">Sling Karaf</a></h2> <p>You can run Sling on <a href="https://karaf.apache.org">Karaf</a> as well by either starting a <a href="karaf.html#sling-karaf-distribution">Sling Karaf Distribution</a> or installing <a href="karaf.html#sling-karaf-features">Sling's Karaf Features</a> into a running Karaf Container.</p> <h1><a href="#explore-sling" id="explore-sling">Explore Sling</a></h1> <p>Once Sling is started, you can access Sling at <a href="http://localhost:8080">http://localhost:8080</a>.</p> <p>The Sling directory contains a directory <em>logs</em>. This directory contains all the log files created by Sling. The main log file is called <em>error.log</em>.</p> <h1><a href="#where-to-head-from-here" id="where-to-head-from-here">Where to head from here</a></h1> <p>We're on the way to update the documentation to make it more easy to get in touch with Sling. We recommend you read through following topics to get as fast as possible into Sling:</p> <ul> <li><a href="/documentation/development/getting-and-building-sling.html">Getting and building Sling</a></li> <li><a href="getting-started/discover-sling-in-15-minutes.html">Discover Sling in 15 minutes</a></li> <li><a href="/documentation/the-sling-engine/architecture.html">Architecture</a></li> <li><a href="/documentation/the-sling-engine/dispatching-requests.html">Dispatching Requests</a></li> <li><a href="/documentation/the-sling-engine/resources.html">Resources</a></li> <li><a href="/documentation/development/ide-tooling.html">Sling IDE Tooling</a></li> <li><a href="/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Manipulating Content - The SlingPostServlet (servlets.post)</a></li> <li><a href="/documentation/the-sling-engine/request-parameters.html">Request Parameters</a></li> <li><a href="/documentation/the-sling-engine/authentication.html">Authentication</a></li> <li><a href="/documentation/bundles/apache-sling-eventing-and-job-handling.html">Eventing and Jobs</a></li> </ul> </section></div></div><div data-pagefind-body="true" data-pagefind-weight="7.0" style="display:none;"> - ( Getting Started )</div> </div> </div> </div> </div><footer class="footer"> <div class="content has-text-centered is-small"> <div class="editpagelink"> This page can be edited on GitHub at <a href="https://github.com/apache/sling-site/edit/master/src/main/jbake/content/documentation/getting-started.md"> content/documentation/getting-started.md </a> </div> <div class="revisionInfo"> Last modified by <span class="author">Robert Munteanu</span> on <span class="comment">2022-03-21</span> </div><p> Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. </p><p> Copyright 漏 2007-2025<a href="https://www.apache.org/"> The Apache Software Foundation </a>|<a href="https://privacy.apache.org/policies/privacy-policy-public.html"> Privacy Policy </a> </p> </div> </footer> </div> </body> </html>

CINXE.COM

Apache Sling :: Getting Started