Merge pull request #10 from ZKStats/fix-6

Add dependencies and configuration

Author: exfinen

docs/dependencies.md

@@ -0,0 +1,15 @@
+# Dependencies
+
+- python 3
+- poetry
+- cargo
+- [TLSN](https://github.com/ZKStats/tlsn)
+  - branch: `mpspdz-compat`
+  - clone it as `../tlsn`
+- [MP-SPDZ](https://github.com/ZKStats/MP-SPDZ) (only required for computation party server)
+  - branch: `demo_client`
+  - clone it as `../MP-SPDZ`
+  - need to add `MOD = -DGFP_MOD_SZ=5 -DRING_SIZE=257` to `CONFIG.mine`
+  - install: `make setup`
+  - build vm: `make replicated-ring-party.x`
+

docs/getting-started/deployment/client.md

@@ -1,5 +1,6 @@
 ---
 title: "Client"
+sidebar_position: 1
 ---
 
 # Client CLI Deployment

docs/getting-started/deployment/configuration.md

@@ -0,0 +1,28 @@
+---
+sidebar_position: 3
+---
+
+# Configuration
+
+## Default Configuration
+- [Coordination Server](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/coordination_server/config.py)
+- [Computation Party Server](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/computation_party_server/config.py)
+- [Data Consumer API Server](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/data_consumer_api/config.py)
+- [Client CLI](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/client_cli/config.py)
+
+## Overriding Default Configuration
+You can create the following configuration files at the repository root to override the default configuration.
+
+| Server | Configuration File Name |
+| --- | --- |
+| Coordination Server | `.env.coord` |
+| Computation Party Server | `.env.party` |
+| Data Consumer API Server | `.env.consumer_api` |
+| Client CLI | `.env.client_cli` |
+
+
+### Example Configuration Files
+- [.env.coord](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.coord.example)
+- [.env.party](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.party.example)
+- [.env.consumer_api](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.consumer_api.example)
+- [.env.client_cli](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.client_cli.example)

docs/getting-started/deployment/servers/_category_.json

@@ -2,6 +2,7 @@
   "label": "Servers",
   "link": {
     "type": "generated-index"
-  }
+  },
+  "position": 2
 }
 

docs/getting-started/deployment/troubleshooting.md

@@ -1,5 +1,6 @@
 ---
 title: "Troubleshooting"
+sidebar_position: 4
 ---
 
 # Troubleshooting and Support