swrup/mte
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Swrup 2026-09-02 04:42:13 +02:00
parent 78f70f3b4d
commit b1f2904df9
1 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -81,12 +81,24 @@ make vendors
## Assets, configuration file and keys
Create a `keys/` folder, generate a fresh master key for the server (and also a file with the required postgres_password to connect to the database).
Create a `assets/` folder containing default terms of use files and a default configuration file (incomplete).
```
make assets
```
Create a `keys/` folder and generate a fresh master key for the server.
```
make keys
```
Write a `keys/postgres_password` file with the required database password.
```
make postgres_password
```
Create `keys/secmod.fat` file that will be the FAT block storage given to MTE.
MTE will use it to store it's signatures and denominations keys.
@ -94,12 +106,6 @@ MTE will use it to store it's signatures and denominations keys.
make secmod.fat
```
Create a `assets/` folder containing default terms of use files and a default configuration file.
```
make assets
```
Complete the configuration file by writing master public key of the server we previously generated into it.
```
@ -128,7 +134,7 @@ dune runtest
This will run tests for various utility functions, binary formats and cryptographic functions.
It also test that MTE's binary formats and cryptographic signature on the various fields of `/keys` API are consistent with the reference implementation.
It is also possible to run a test scenario of the `/management` API with the `/test/management.sh` script.
It is also possible to run a test scenario of the `/management` API with the `./test/management.sh` script.
It uses `mte-offline-tool` executable to produce various keys, signatures and JSON objects used in the `/management` API.
Note that this script assumes a server is already running at `http://10.0.0.2:3434`, and that it will write changes to the database.
Note that this script assumes a server is already running on `http://10.0.0.2:3434`, and that it will write changes to the database.