Skip to content

Commit

Permalink
Update TUF section in developer documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Lukas Puehringer <[email protected]>
  • Loading branch information
lukpueh committed Apr 22, 2024
1 parent 5dd1e3b commit 33dabfe
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions docs/dev/development/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -265,19 +265,16 @@ includes the TUF trust root for development and other configuration.
By calling this API, RSTUF creates the TUF metadata repository, installs the
TUF trust root for development, and creates the initial set of TUF metadata.

.. note::
Once this process is finished, TUF metadata will update automatically whenever
distribution files are uploaded, yanked or removed. To disable this behavior,
you can set the ``TUF_ENABLED`` environment variable to false. TUF metadata
is hosted at: http://localhost:9001/tuf-metadata/

The RSTUF API is exposed only for development purposes and will not be
available in production. Currently, no upload hooks or automatic metadata
update tasks are configured to interact with RSTUF.
.. note::

Take a look at the `RSTUF API documentation
<https://repository-service-tuf.readthedocs.io/en/stable/guide/general/usage.html#adding-artifacts>`_
to see how you can simulate artifact upload or removal, and how they affect
the TUF metadata repository:
RSTUF and automated TUF metadata updates are currently only available in the
Warehouse development environment.

* RSTUF API: http://localhost:8001
* TUF Metadata Repository: http://localhost:9001/tuf-metadata/


Resetting the development database
Expand Down

0 comments on commit 33dabfe

Please sign in to comment.