ProxeusApp · dependabot · Nov 16, 2023 · Nov 18, 2023
diff --git a/.env.example b/.env.example
@@ -0,0 +1,16 @@
+PROXEUS_EMAIL_FROM=<Your valid Sender Email Address>
+
+PROXEUS_INFURA_API_KEY=<Your Infura project ID>
+
+PROXEUS_SPARKPOST_API_KEY=<Your SparkPost API Key>
+
+PROXEUS_ENCRYPTION_SECRET_KEY=<A 32-character random string>
+
+# Sepolia test-net
+PROXEUS_BLOCKCHAIN_CONTRACT_ADDRESS=0x9bc518Fd070BE3DBB07399261688015744a7FB02
+
+# For a local development environment without SSL
+PROXEUS_ALLOW_HTTP=true
+
+# To see additional debugging information
+PROXEUS_TEST_MODE=true
diff --git a/Makefile b/Makefile
@@ -79,12 +79,12 @@ all: ui server
 init:
 	@for d in $(dependencies); do (echo "Checking $$d is installed... " && which $$d ) || ( echo "Please install $$d before continuing" && exit 1 ); done
 	@go version
-	go install github.com/go-bindata/go-bindata/...
-	go install github.com/golang/mock/mockgen
-	go install github.com/wadey/gocovmerge
-	go install golang.org/x/tools/...
-	go install golang.org/x/tools/cmd/goimports
-	go install golang.org/x/tools/cmd/godoc
+	go install github.com/go-bindata/go-bindata/...@latest
+	go install github.com/golang/mock/mockgen@latest
+	go install github.com/wadey/gocovmerge@latest
+	go install golang.org/x/tools/...@latest
+	go install golang.org/x/tools/cmd/goimports@latest
+	go install golang.org/x/tools/cmd/godoc@latest
 
 .PHONY: update
 update:

diff --git a/README.md b/README.md
@@ -31,24 +31,6 @@ If you wish to build the project form the source code, follow the instructions i
 
 Please read the [Developer Manual](https://doc.proxeus.com) to learn more about the Proxeus platform.
 
-### Infura and SparkPost
-
-The Proxeus platform currently depends on [Infura](https://infura.io/) for blockchain services. Supported chains include:
-
-- ethereum: sepolia
-- ethereum: goerli
-- ethereum: mainnet
-- polygon: mumbai
-- polygon: mainnet
-
-Create an account to get an API Keys. These keys need to be added to corresponding environment variables, or entered when deploying a "one-click" instance.
-
-Proxeus works best with [SparkPost](https://www.sparkpost.com/) for email integration. 
-
-Please note that the domain you set up on SparkPost MUST match the **reply-to** e-mail address that you configure in the next step in order to create accounts and receive e-mails on your instance.
-
-If all goes well, Proxeus should be available at http://localhost:1323. The next step will be to [configure](docs/configure.md) your instance for the first time.
-
 ## Contributing
 
 As an open-source project, we welcome any kind of community involvement, whether that is by contributing code, reporting issues or

diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,7 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please use our public [Issue Tracker](https://github.com/ProxeusApp/proxeus-core/issues) to open improvement and bug tickets.
+
+If you find a **Security Issue** - a vulnerability that may affect live or testnet deployments please send your report privately to info@proxeus.org - Please DO NOT file a public issue in this case.
diff --git a/docker-compose-example.override.yml b/docker-compose-example.override.yml
@@ -0,0 +1,21 @@
+---
+# This file is an override and needs to be used like this:
+#
+#  docker-compose -f docker-compose.yml -f docker-compose-example.override.yml up
+
+version: '3.7'
+
+services:
+  node-crypto-forex-rates:
+    networks:
+      - reverse-proxy
+    labels:
+      com.centurylinklabs.watchtower.enable: "true"
+    environment:
+      # Replace values for reverse-proxy
+      VIRTUAL_HOST: ${NODE_CRYPTO_FOREX_RATES_VIRTUAL_HOST:-proxeus.example.com}
+      VIRTUAL_PORT: 8011
+      # Replace values for letsencrypt
+      LETSENCRYPT_HOST: ${NODE_CRYPTO_FOREX_RATES_VIRTUAL_HOST:-proxeus.example.com}
+      LETSENCRYPT_EMAIL: ${LETSENCRYPT_EMAIL:-admin@example.com}
+    restart: unless-stopped
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -4,27 +4,26 @@
 
     - [Quick start](quickstart.md)
     - [User handbook](handbook.md)
+    - [Formulas guide](formulas.md)
+    - [F.A.Q.](faq.md)
 
 - Build and Run
 
+    - [Docker](build_docker.md)
     - [Build All](build_all.md)
     - [Configure Sever](configure.md)
-    - [Test](test.md)
     - [Front End Only](build_frontend.md)
     - [Back End Only](build_backend.md)
-    - [Docker](build_docker.md)
+    - [Test](test.md)
 
 - Development
 
     - [Software Architecture](architecture.md)
+    - [Components](components.md)
     - [Back End](backend.md)
     - [Front End](frontend.md)
-
-- Deployment
-
-    - [Components](components.md)
-    - [Docker](docker.md)
-    - [Smart Contract](contract_deployment.md)
+    - [Database](database.md)
+    - [Smart Contracts](contract_deployment.md)
 
 - API
 
@@ -33,18 +32,10 @@
         - [List All Workflows](api_list_all_workflows.md)
         - [Get Workflow Schema](api_get_workflow_schema.md)
         - [Execute Workflow](api_execute_workflow.md)
-
-
-- Workflow Extension
-
     - [External Workflow Nodes](external_workflow_nodes.md)
 
-- [Database](database.md)
-
 - [Contributing](contributing.md)
     - [Code of Conduct](code_of_conduct.md)
     - [Coding Style](coding_style.md)
 
-- [FAQ](faq.md)
-
 - [License](license.md)
diff --git a/docs/build_docker.md b/docs/build_docker.md
@@ -1,5 +1,38 @@
 # Docker
 
+Please make sure that you always pull Docker images from the official `proxeus` DockerHub repository and that you are using the latest version.
+
+## Start Proxeus
+
+Run the following command in the directory containing your `docker-compose.yml` file (Linux and OSX):
+```
+export PROXEUS_EMAIL_FROM=<Your valid Sender Email Address>
+export PROXEUS_INFURA_API_KEY=<Your Infura project ID>
+export PROXEUS_SPARKPOST_API_KEY=<Your SparkPost API Key>
+export PROXEUS_ENCRYPTION_SECRET_KEY=<A 32-character random string>
+export PROXEUS_BLOCKCHAIN_CONTRACT_ADDRESS=0x1d3e5c81bf4bc60d41a8fbbb3d1bae6f03a75f71
+export PROXEUS_ALLOW_HTTP=true
+docker-compose up
+```
+
+You can also put these settings into an `.env` file in the same folder as the application.
+
+See [Configuration settings](configure.md) for more details.
+
+## Tweak your Docker setup
+
+Besides the basic Docker Compose configuration, you can extend your installation as follows:
+
+- `docker-compose-cloud.override` for cloud installations, which includes Nginx and Let's Encrypt
+- `docker-compose-example.override` shows how to add another Proxeus Node to your installation
+- `docker-compose-extra.override` includes all officially supported Proxeus Nodes
+- `docker-compose-local.override` if you want to use your local Docker image (details below)
+
+To use one or more of these overrides, start Proxeus as follows:
+
+`docker-compose -f docker-compose.yml -f docker-compose-example.override.yml up`
+
+(you always have to first include `docker-compose.yml`)
 
 ## Build a Docker image
 
@@ -42,7 +75,11 @@ docker-compose restart
 This will build the proxeus-core image based on your current project and use a deployed image
 for the document service.
 
-## Using Docker for the build
+## Tips
+
+Having an issue with Go? Make sure it's in your path, e.g.:
+
+`export PATH=$PATH:/usr/local/go/bin`
 
 If you're having trouble, try a clean full Docker build, specifying each of the configuration files:
 
@@ -60,10 +97,11 @@ For deployment, a `docker-compose-cloud.override.yml` file is provided which inc
 docker-compose -f docker-compose.yml -f docker-compose-cloud.override.yml up
 ```
 
-You may also want to include custom nodes. There is a sample configuration which can be started like this:
+You may also want to include custom nodes. There is a sample configuration which can be started like this (also possibly in combination with `docker-compose-cloud`):
 
 ```
-docker-compose -f docker-compose.yml -f docker-compose-cloud.override.yml -f docker-compose-cnode.override.yml up
+docker-compose -f docker-compose.yml -f docker-compose-example.override.yml up
+
 ```
 
 See `docker-compose-extra.override.yml` for examples with several other nodes.
diff --git a/docs/configure.md b/docs/configure.md
@@ -5,15 +5,17 @@ When starting the server for the first time, you will need to configure it.
 Open http://localhost:1323/init to configure your server.  Use the
 configuration below as an example.
 
-## Document Service URL
-```
-https://dev-ds.proxeus.com/
-```
+**Note:** that your system configuration at this point will be reflected in the local configuration database under `data/proxeus-platform/settings/main.json`. Any future changes to the configuration must be made here - the environment variables will not be propagated, unless you delete this file to reset the deployment.
 
 ## Infura API Key
-Generate a  [infura API Key](https://infura.io)
+
+Generate an [Infura API Key](https://infura.io)
 
 ## Blockchain File Storage contract address 
+
+You can switch between the networks using the environment configuration `PROXEUS_BLOCKCHAIN_NET`.
+For your convenience, a smart contract is deployed on several networks at the following addresses:
+
 ### Sepolia
 ```
 0x9bc518Fd070BE3DBB07399261688015744a7FB02
@@ -46,15 +48,15 @@ Generate a  [infura API Key](https://infura.io)
 ```
 [Verify on Etherscan](https://polygonscan.com/address/0x60970BeFda93464A105DD21Dc6a30B69C5B5c6e4)
 
-
-
 Alternatively: deploy your own smart contract from [ProxeusFS.sol](https://github.com/ProxeusApp/storage-app/blob/master/spp/eth/solidity/ProxeusFS.sol)
 
 
 ## Email from
+
 ```
 no-reply@proxeus.com
 ```
+
 ## Sparkpost API Key
 
 Set up a free account on [SparkPost](https://www.sparkpost.com)
@@ -70,6 +72,12 @@ youremail@address.com
 
 This is a salt to hash your user's passwords in the database. You can use any value, with preference to hard generated strings. Make sure that it is exactly 32 characters long. Do not change the key on a running instance. This can only be set using an environment variable.
 
+## Document Service URL
+
+This only needs to be changed if you are running the service on a separate machine. See the documentation at https://github.com/ProxeusApp/document-service
+
+---
+
 # Full Configuration
 
 You can get the full list of configuration parameters using the `-h` parameter:

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,4 +1,4 @@
-# FAQ
+# Frequently Asked Questions
 
 To see new tips from the community, or if you have other questions, please visit our [Community Discussions](https://github.com/orgs/ProxeusApp/discussions).
 
@@ -7,12 +7,14 @@ To see new tips from the community, or if you have other questions, please visit
 **Q:** Can I build it on on Windows?
 
 **A:** There's no support for Windows yet; the whole init, build system has been tested on Linux and Mac only.
-##
+
+---
 
 **Q:** I'm getting an error when trying to run the frontend.
 
 **A:** Make sure you have NodeJS v8 and yarn 1.12. It hasn't been tested with superior versions yet.
-##
+
+---
 
 ## Settings
 
@@ -21,11 +23,12 @@ To see new tips from the community, or if you have other questions, please visit
 **A:** Yes, pretty much all the are changeable through the Internationalization settings. A SUPERADMIN or higher user can change that.
 That menu item should be shown on the sidebar in the backend or under `/admin/i18n`
 
-##
+---
 
 ## Forms
 
 **Q:** Why the name field is red?
 
 **A:** Components need to be unique and only a-z, A-Z, 0-9 is allowed. Do not use special characters and spaces for the naming of components.
-##
+
+---