.. _Buckets:

🪣 Buckets
----------

Documents are organised into **buckets**.
Each bucket is a self-contained git repository that holds one or more (Typst) files.

Selecting a bucket
~~~~~~~~~~~~~~~~~~

Click the bucket button in the toolbar (top-left) to open the bucket picker.
Select a bucket from the list to load its files into the editor.

Creating a bucket
~~~~~~~~~~~~~~~~~

Administrators can create new buckets from the bucket picker dialog.
Click **New Bucket**, fill in a slug (the unique identifier) and an optional description, then save.

Access control
~~~~~~~~~~~~~~

Each bucket has its own access control list.
Entries map an OIDC group to one of three roles:

.. list-table::
   :header-rows: 1
   :widths: 15 85

   * - Role
     - Permissions
   * - **Viewer**
     - Browse files and view commit history.
   * - **Editor**
     - Everything a Viewer can do, plus create, edit, rename, and delete files.
   * - **Committer**
     - Everything an Editor can do, plus commit changes to the git repository.

.. note::

  Members of the configured admin groups (see :attr:`TYPARR_ADMIN_GROUPS <typarr.config.TYPARR_ADMIN_GROUPS>`) are implicitly treated as **Committer** on every bucket.