Merge pull request #8 from ProxeusApp/fix-readme-and-doc-links

Updates documentation and fix broken links

README.md

@@ -31,6 +31,59 @@ For your convenience, a demo smart contract is deployed on the Ropsten network a
 0x1d3e5c81bf4bc60d41a8fbbb3d1bae6f03a75f71
 ```
 
+### Create a docker-compose.yml file 
+
+**Note: Please make sure that you always pull Docker images from the official `proxeus` DockerHub repository and that you are using the latest version.**
+
+User the example below as your `docker-compose.yml` file:
+
+```
+version: '3.7'
+
+networks:
+  xes-platform-network:
+    name: xes-platform-network
+
+services:
+  platform:
+    image: proxeus/proxeus-core:latest
+    container_name: xes_platform
+    depends_on:
+      - document-service
+    networks:
+      - xes-platform-network
+    restart: unless-stopped
+    environment:
+      TZ: Europe/Zurich
+      DataDir: "/data/hosted"
+      DocumentServiceUrl: "http://document-service:2115/"
+      InfuraApiKey: "${PROXEUS_INFURA_KEY}"
+      SparkpostApiKey: "${PROXEUS_SPARKPOST_KEY}"
+      BlockchainContractAddress: "${PROXEUS_CONTRACT_ADDRESS}"
+      EmailFrom: "${PROXEUS_EMAIL_FROM:-no-reply@proxeus.com}"
+      AirdropWalletfile: "${PROXEUS_AIRDROP_WALLET_FILE:-./data/proxeus-platform/settings/airdropwallet.json}"
+      AirdropWalletkey: "${PROXEUS_AIRDROP_WALLET_KEY:-./data/proxeus-platform/settings/airdropwallet.key}"
+    ports:
+      - "1323:1323"
+    volumes:
+      - ${PROXEUS_DATA_DIR:-./data}/proxeus-platform/data:/data/hosted
+      - ${PROXEUS_DATA_DIR:-./data}/proxeus-platform/settings:/root/.proxeus/settings
+
+  document-service:
+    image: proxeus/document-service:latest
+    container_name: xes_document_service
+    networks:
+      - xes-platform-network
+    restart: unless-stopped
+    environment:
+      TZ: Europe/Zurich
+    ports:
+      - "2115:2115"
+    volumes:
+      - ${PROXEUS_DATA_DIR:-./data}/document-service/logs:/document-service/logs
+      - ${PROXEUS_DATA_DIR:-./data}/document-service/fonts:/document-service/fonts
+```
+
 ### Start Proxeus
 
 Run the following command (Linux and OSX):
@@ -51,8 +104,8 @@ If you are a developer and want to build the project form the source code follow
 
 ## Developer manual
 
-Please read the [Developer Manual](docs/_sidebar.md) to learn more about the 
-Proxeus platform. *TODO: link to the github pages documentation site when ready*
+Please read the [Developer Manual](https://doc.proxeus.com) to learn more about the 
+Proxeus platform. 
 
 ## User manual
 

README.md-e

@@ -31,6 +31,59 @@ For your convenience, a demo smart contract is deployed on the Ropsten network a
 0x1d3e5c81bf4bc60d41a8fbbb3d1bae6f03a75f71
 ```
 
+### Create a docker-compose.yml file 
+
+**Note: Please make sure that you always pull Docker images from the official `proxeus` DockerHub repository and that you are using the latest version.**
+
+User the example below as your `docker-compose.yml` file:
+
+```
+version: '3.7'
+
+networks:
+  xes-platform-network:
+    name: xes-platform-network
+
+services:
+  platform:
+    image: proxeus/proxeus-core:latest
+    container_name: xes_platform
+    depends_on:
+      - document-service
+    networks:
+      - xes-platform-network
+    restart: unless-stopped
+    environment:
+      TZ: Europe/Zurich
+      DataDir: "/data/hosted"
+      DocumentServiceUrl: "http://document-service:2115/"
+      InfuraApiKey: "${PROXEUS_INFURA_KEY}"
+      SparkpostApiKey: "${PROXEUS_SPARKPOST_KEY}"
+      BlockchainContractAddress: "${PROXEUS_CONTRACT_ADDRESS}"
+      EmailFrom: "${PROXEUS_EMAIL_FROM:-no-reply@proxeus.com}"
+      AirdropWalletfile: "${PROXEUS_AIRDROP_WALLET_FILE:-./data/proxeus-platform/settings/airdropwallet.json}"
+      AirdropWalletkey: "${PROXEUS_AIRDROP_WALLET_KEY:-./data/proxeus-platform/settings/airdropwallet.key}"
+    ports:
+      - "1323:1323"
+    volumes:
+      - ${PROXEUS_DATA_DIR:-./data}/proxeus-platform/data:/data/hosted
+      - ${PROXEUS_DATA_DIR:-./data}/proxeus-platform/settings:/root/.proxeus/settings
+
+  document-service:
+    image: proxeus/document-service:latest
+    container_name: xes_document_service
+    networks:
+      - xes-platform-network
+    restart: unless-stopped
+    environment:
+      TZ: Europe/Zurich
+    ports:
+      - "2115:2115"
+    volumes:
+      - ${PROXEUS_DATA_DIR:-./data}/document-service/logs:/document-service/logs
+      - ${PROXEUS_DATA_DIR:-./data}/document-service/fonts:/document-service/fonts
+```
+
 ### Start Proxeus
 
 Run the following command (Linux and OSX):
@@ -51,8 +104,8 @@ If you are a developer and want to build the project form the source code follow
 
 ## Developer manual
 
-Please read the [Developer Manual](docs/_sidebar.md) to learn more about the 
-Proxeus platform. *TODO: link to the github pages documentation site when ready*
+Please read the [Developer Manual](https://doc.proxeus.com) to learn more about the 
+Proxeus platform. 
 
 ## User manual
 

docs/api_start_workflow.md

@@ -1,6 +1,6 @@
 # Start Workflow using the API
 
-**Note**: Call to the API must be [autenticated](api_auth.md).
+**Note**: Call to the API must be [authenticated](api_auth.md).
 
 It is possible to start a workflow programmatically using the API.  This is a 
 three step process:

docs/api_start_workflow.md-e

@@ -1,6 +1,6 @@
 # Start Workflow using the API
 
-**Note**: Call to the API must be [autenticated](api_auth.md).
+**Note**: Call to the API must be [authenticated](api_auth.md).
 
 It is possible to start a workflow programmatically using the API.  This is a 
 three step process:

docs/configure.md

@@ -24,7 +24,7 @@ Generate a  [infura API Key](https://infura.io)
 no-reply@proxeus.com
 ```
 ## sparkpost api key
-setup a free account on https://www.sparkpost.com
+setup a free account on [SparkPost](https://www.sparkpost.com)
 
 ## Initial Email
 Use your email address for the root user and choose a secure password.

docs/configure.md-e

@@ -24,7 +24,7 @@ Generate a  [infura API Key](https://infura.io)
 no-reply@proxeus.com
 ```
 ## sparkpost api key
-setup a free account on https://www.sparkpost.com
+setup a free account on [SparkPost](https://www.sparkpost.com)
 
 ## Initial Email
 Use your email address for the root user and choose a secure password.

docs/custom_workflow_nodes.md

@@ -1,5 +1,9 @@
 # Custom Workflow Nodes
 
+**Note: Creating custom workflow nodes requires access to the source code and will be available at a later time
+when the Proxeus github repositories will be publicly accessible**
+
+
 Custom workflow nodes are the primary method to extend Proxeus workflow to any use cases.
 
 They are written in Golang and can
@@ -24,18 +28,21 @@ NodeIF interface {
 	}
 ```
 
-
-
 ## Workflow Context
 
 Each workflow node must have access to the `DocumentFlowInstance` context which gives full access to workflow data.
 
+
+
+<!--
 ## Examples
+
 You can find implementation example of this interface in the Proxeus repository under the [proxeus-core/main/app](https://github.com/ProxeusApp/proxeus-core/tree/master/main/app)
 directory:
 
 * [mail_sender.go](https://github.com/ProxeusApp/proxeus-core/tree/master/main/app/mail_sender.go) shows how to read data from the workflow,
 * [price_retriever.go](https://github.com/ProxeusApp/proxeus-core/tree/master/main/app/price_retriever.go) shows how to update workflow data.
+-->
 
 
 

docs/custom_workflow_nodes.md-e

@@ -1,5 +1,9 @@
 # Custom Workflow Nodes
 
+**Note: Creating custom workflow nodes requires access to the source code and will be available at a later time
+when the Proxeus github repositories will be publicly accessible**
+
+
 Custom workflow nodes are the primary method to extend Proxeus workflow to any use cases.
 
 They are written in Golang and can
@@ -24,18 +28,21 @@ NodeIF interface {
 	}
 ```
 
-
-
 ## Workflow Context
 
 Each workflow node must have access to the `DocumentFlowInstance` context which gives full access to workflow data.
 
+
+
+<!--
 ## Examples
+
 You can find implementation example of this interface in the Proxeus repository under the [proxeus-core/main/app](https://github.com/ProxeusApp/proxeus-core/tree/master/main/app)
 directory:
 
 * [mail_sender.go](https://github.com/ProxeusApp/proxeus-core/tree/master/main/app/mail_sender.go) shows how to read data from the workflow,
 * [price_retriever.go](https://github.com/ProxeusApp/proxeus-core/tree/master/main/app/price_retriever.go) shows how to update workflow data.
+-->