Merge pull request #1 from ZKStats/add-depolying-infra

Add local deployment docs

Author: exfinen

docs/getting-started/deployment.md

@@ -0,0 +1,7 @@
+{
+  "label": "Depolying the Infrastructure",
+  "link": {
+    "type": "generated-index"
+  }
+}
+

docs/getting-started/deployment/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "On a Local Server",
+  "link": {
+    "type": "generated-index"
+  }
+}
+

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

@@ -0,0 +1,83 @@
+---
+title: "Manually"
+sidebar_position: 2
+---
+
+# Manual Deployment
+
+## Procedure
+1. Install Poetry by following the instructions [here](https://python-poetry.org/docs/#installation).
+
+2. Clone the repository and cd to the repository root:
+   ```bash
+   git clone https://github.com/ZKStats/mpc-demo-infra.git
+   cd mpc-demo-infra
+   ```
+
+3. Install the dependencies:
+   Ubuntu:
+   ```bash
+   ./setup_env.sh --setup-mpspdz
+   ```
+   Other environments:
+   (TO BE ADDED)
+
+4. Create the following configuration files at the repository root:
+   - `.env.coord`
+     ```
+     PORT=8005
+     PARTY_HOSTS=["localhost", "localhost", "localhost"]
+     PARTY_PORTS=[8006, 8007, 8008]
+     PARTY_API_KEY=81f47c24b9fbe22421ea3ae92a9cc8f6
+     PARTY_WEB_PROTOCOL=http
+     PROHIBIT_MULTIPLE_CONTRIBUTIONS=False
+     USER_QUEUE_HEAD_TIMEOUT=60
+     FREE_PORTS_START=8010
+     FREE_PORTS_END=8100
+     ```
+   - `.env.party`
+     ```
+     COORDINATION_SERVER_URL=http://localhost:8005
+     PARTY_API_KEY=81f47c24b9fbe22421ea3ae92a9cc8f6
+     PARTY_HOSTS=["localhost", "localhost", "localhost"]
+     PARTY_PORTS=[8006, 8007, 8008]
+     PARTY_WEB_PROTOCOL=http
+     MAX_DATA_PROVIDERS=1000
+     PERFORM_COMMITMENT_CHECK=False
+     ```
+   - `.env.consumer_api`
+     ```
+     COORDINATION_SERVER_URL=http://localhost:8005
+     CERTS_PATH=certs
+     PARTY_HOSTS=["localhost", "localhost", "localhost"]
+     PARTY_PORTS=["8006","8007","8008"]
+     PARTY_WEB_PROTOCOL=http
+     PORT=8004
+     ```
+
+5. Start the Coordination Server
+   ```bash
+   poetry run coord-run
+   ```
+
+6. Start the Computation Party Servers
+   1. Open a new terminal, start party-0:
+   ```bash
+   PORT=8006 PARTY_ID=0 poetry run party-run
+   ```
+
+   2. Open a new terminal and run party-1:
+   ```bash
+   PORT=8007 PARTY_ID=1 poetry run party-run
+   ```
+
+   3. Open a new terminal and run party-2:
+   ```bash
+   PORT=8008 PARTY_ID=2 poetry run party-run
+   ```
+
+7. Start the Data Consumer API Server
+   ```bash
+   poetry run consumet-api-run
+   ```
+

docs/getting-started/deployment/local/manually.md

@@ -0,0 +1,15 @@
+---
+title: "Using Docker"
+sidebar_position: 1
+---
+
+# Docker Deployment
+
+1. Install `Docker` by following the instructions [here](https://docs.docker.com/engine/install/).
+1. Install `Docker Compose` by following the instructions [here](https://docs.docker.com/compose/install/).
+1. Build and start all servers with:
+   ```bash
+   ./configure.py
+   docker-compose up --build
+   ```
+

docs/getting-started/deployment/local/using_docker.md

@@ -0,0 +1,7 @@
+{
+  "label": "On Remote Servers",
+  "link": {
+    "type": "generated-index"
+  }
+}
+

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

@@ -0,0 +1,8 @@
+---
+title: "Manually"
+sidebar_position: 2
+---
+
+# Manual Deployment
+
+

docs/getting-started/deployment/remote/manually.md

@@ -0,0 +1,7 @@
+---
+title: "Using Docker"
+sidebar_position: 1
+---
+
+# Docker Deployment
+