{% extends "admin/dbs/wiki/_layout.html" %}

{% block wiki %}
<h1>The DBS manager</h1>
<p>The DBS manager is a separate application in the same package. Run it on your own
machine with:</p>
<pre><code>django_dbs run</code></pre>
<p>If the shell says <code>django_dbs</code> is not recognized, pip put the script in a
folder that is not on your <code>PATH</code>. Run <code>python -m dbs.manager run</code>
instead, or install with <code>pipx install django-dbs</code>.</p>
<p>It opens in your browser and looks after many servers over SSH: it takes and pulls their
backups, keeps their <code>.env</code> versions and folder archives, and can restore a
project onto a new server when the old one goes down.</p>
<h2>From a terminal</h2>
<p>Everything the manager's interface does is also a command, on the same data and the same
audit trail:</p>
<pre><code>django_dbs server add web --host app.example.com --user deploy --ssh-password
django_dbs backup take --all
django_dbs backup list --server web</code></pre>
<p><code>server add</code> shows the host key fingerprint to confirm, finds this project and
the Python that has django-dbs, and checks the server. Actions the interface protects with
your password ask for it in the terminal too. <code>django_dbs AREA VERB --help</code> lists
the rest: <code>server</code>, <code>backup</code>, <code>plan</code>,
<code>activity</code>, <code>env</code>, <code>files</code> and <code>redeploy</code>.</p>
<h2>With Claude</h2>
<p><code>django_dbs mcp</code> lets Claude add servers, take and verify backups, set up plans
and rehearse restores (<code>claude mcp add dbs -- django_dbs mcp</code>). It never reveals a
secret, never takes your account password, and cannot restore for real, remove or delete
anything.</p>
<h2>Letting it reach this project</h2>
<ol>
  <li>Open <a href="{% url 'admin:dbs_connection' %}">Connection</a> and press
      <em>Copy</em>.</li>
  <li>In the manager, choose <em>Add a server</em> and paste the snippet, or run
      <code>django_dbs server add</code>. Without one, the
      manager searches the server for the project once it can sign in, and
      <em>Browse the server</em> lets you pick its folder from the server's own folders.</li>
  <li>Confirm the host key fingerprint matches the one shown on the Connection page.</li>
  <li>Add the key the manager shows to <code>~/.ssh/authorized_keys</code> for the user
      that owns this project.</li>
</ol>
<p>If this project runs in a Docker Compose service, choose <em>In a Docker Compose
service</em> under <em>Where the project runs</em> and name the service, or pass
<code>--runtime compose --compose-service backend</code> to <code>server add</code>. The
manager then runs every <code>manage.py</code> command inside that service with
<code>docker compose exec</code>, from the project folder, and copies backups in and out with
<code>docker compose cp</code>. The SSH user must be able to run <code>docker compose</code>
and the service must be running, with django-dbs installed in its image.</p>
<p>This project never contacts the manager and keeps nothing about it. A backup the manager
asks for is written to <code>DBS_BACKUP_DIR</code> and recorded in the
<a href="{% url 'admin:dbs_auditevent_changelist' %}">audit trail</a> like any other
backup.</p>
{% endblock %}