path: root/index.html

---
title: sourcehut docs
---

<p>
  <strong>Welcome to sourcehut!</strong> You can access each of the main
  services from the links in the navigation at the top of the site. You're
  currently on man.sr.ht, which hosts the user manual and provides wikis for
  projects hosted here.
</p>
<style>
dt {
  font-weight: normal;
}
.event-row .col-md-6:first-child {
  padding-right: 0.25rem;
}
.event-row .col-md-6:last-child {
  padding-left: 0.25rem;
}
</style>
<div class="row event-row">
  <div class="col-md-6 event-list">
    <div class="event">
      <h3 id="start-here">Start here!</h3>
      <p>
        New here? We have some great tutorials to introduce you to the site.
      </p>
      <a href="tutorials" class="btn btn-success btn-block">
        Read the tutorials
        <span class="icon icon-caret-right">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 192 512"><path d="M0 384.662V127.338c0-17.818 21.543-26.741 34.142-14.142l128.662 128.662c7.81 7.81 7.81 20.474 0 28.284L34.142 398.804C21.543 411.404 0 402.48 0 384.662z"/></svg>
        </span>
      </a>
    </div>
    <div class="event">
      <h3 id="general-documentation">General documentation</h3>
      <p>
        Information on billing, terms of service, privacy policy, and so on.
      </p>
      <a href="sr.ht" class="btn btn-default btn-block">
        Read boring stuff
        <span class="icon icon-caret-right">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 192 512"><path d="M0 384.662V127.338c0-17.818 21.543-26.741 34.142-14.142l128.662 128.662c7.81 7.81 7.81 20.474 0 28.284L34.142 398.804C21.543 411.404 0 402.48 0 384.662z"/></svg>
        </span>
      </a>
    </div>
  </div>
  <div class="col-md-6 event-list">
    <div class="event">
      <h3 id="getting-help">Getting help</h3>
      <p>
        Need support? There are several resources available to you.
      </p>
      <a href="support.md" class="btn btn-default btn-block">
        Support resources
        <span class="icon icon-caret-right">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 192 512"><path d="M0 384.662V127.338c0-17.818 21.543-26.741 34.142-14.142l128.662 128.662c7.81 7.81 7.81 20.474 0 28.284L34.142 398.804C21.543 411.404 0 402.48 0 384.662z"/></svg>
        </span>
      </a>
    </div>
    <div class="event">
      <h3 id="developers-amp-admins">Developers &amp; admins</h3>
      <p>
        Hacking on or deploying sourcehut yourself? Resources here.
      </p>
      <a href="installation.md" class="btn btn-default btn-block">
        Getting started
        <span class="icon icon-caret-right">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 192 512"><path d="M0 384.662V127.338c0-17.818 21.543-26.741 34.142-14.142l128.662 128.662c7.81 7.81 7.81 20.474 0 28.284L34.142 398.804C21.543 411.404 0 402.48 0 384.662z"/></svg>
        </span>
      </a>
    </div>
  </div>
</div>
<div class="alert alert-warning">
  <strong>Notice</strong>: sr.ht documentation is a work in progress, and is
  incomplete in many places.
</div>
<h3 id="news-and-updates">News &amp; Updates</h3>
<p>
  Want to keep up with the latest news on sr.ht? A monthly "what's cooking" is
  posted to the
  <a href="https://lists.sr.ht/~sircmpwn/sr.ht-announce">
    sr.ht-announce
  </a> list. Be sure to subscribe!
</p>
<h3 id="service-documentation">Service Documentation</h3>
<dl class="row">
  <div class="col-md-6">
    <dt>
      <strong>git.sr.ht</strong>: git hosting
    </dt>
    <dd>
      <a href="/git.sr.ht">User Manual</a>
      &mdash;
      <a href="/git.sr.ht/api.md">API Reference</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>hg.sr.ht</strong>: mercurial hosting
    </dt>
    <dd>
      <a href="/hg.sr.ht">User Manual</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>builds.sr.ht</strong>: build service
    </dt>
    <dd>
      <a href="/builds.sr.ht">User Manual</a>
      &mdash;
      <a href="/builds.sr.ht/api.md">API Reference</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>todo.sr.ht</strong>: bug tracking
    </dt>
    <dd>
      <a href="/todo.sr.ht">User Manual</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>lists.sr.ht</strong>: mailing lists
    </dt>
    <dd>
      <a href="/lists.sr.ht">User Manual</a>
      &mdash;
      <a href="/lists.sr.ht/api.md">API Reference</a>
    </dd>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>man.sr.ht</strong>: manual &amp; wikis
    </dt>
    <dd>
      <a href="/man.sr.ht">User Manual</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>dispatch.sr.ht</strong>: task automation
    </dt>
    <dd>
      <a href="/dispatch.sr.ht">User Manual</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>meta.sr.ht</strong>: account &amp; security
    </dt>
    <dd>
      <a href="/meta.sr.ht">User Manual</a>
      &mdash;
      <a href="/meta.sr.ht/api.md">API Reference</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>
      <strong>paste.sr.ht</strong>: ad-hoc text file hosting
    </dt>
    <dd>
      <a href="/paste.sr.ht">User Manual</a>
      &mdash;
      <a href="/paste.sr.ht/api.md">API Reference</a>
    </dd>
  </div>
</dl>