Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Relocate extra examples to CLI.md, and link to CLI and Tutorial

Browse source 
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
This commit is contained in:
Vladimir Diaz 2018-01-26 11:16:21 -05:00
parent f4e2436ef5
commit d39870ca8f
No known key found for this signature in database
GPG key ID: 5DEE9B97B0E2289A
1 changed files with 10 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
docs/QUICKSTART.md
View file

@ -1,55 +1,31 @@
# Quickstart #
Note: A work in progress. Only examples are given here, for now.
Note: This is a work in progress. Only examples are given here, for now.
A full working example in four steps.
The following is a workflow example in four steps.
(1)
Step (1) - Create a repo
```Bash
$ repo.py --init
```
(2)
Step (2) - Add a target file
```Bash
$ repo.py --add foo.tar.gz
```
(3)
Step (3) - Serve the repo
```Bash
$ cd "repository/"
$ cd "repo/"
$ python -m SimpleHTTPServer 8001
```
(4)
Step (4) - Fetch a target file from repo
```Bash
$ cd "client/"
$ client.py --repo http://localhost:8001 foo.tar.gz
```
## Create a TUF repository.
Examples:
Create a TUF repository in the current working directory. A cryptographic key
is created and set for each top-level role. The Targets role does not sign for
any targets nor does it delegate trust to any roles.
```Bash
$ repo.py --init
```
Create a TUF repository at `./repository`.
```Bash
$ repo.py --init repository/
```
Create a TUF repository in the current working directory. A cryptographic key
is *not* created nor set for each top-level role.
```Bash
$ repo.py --init --bare True
```
```Bash
$ repo.py --init --consistent_snapshots True
```
See [CLI.md](CLI.md) for more examples. A [Tutorial](../tuf/README.md) is also
available, and designed for users that want more control over the creation
process.