Proxeus Core

Proxeus combines a powerful automation tool with a form builder, document generator and blockchain connection - enabling you to digitize, secure, and tap into the value of data flows. Access the full source code of available modules and extensions @ProxeusApp.

User Guides

Get help to make the most of the platform in the User Handbook.

To learn more about Smart Contracts using Solidity, see the documentation in the proxeus-contract.

For detailed information about token setup, check the XES-Payment project. Software architecture and other details are in the Developer Manual.

Installation

Proxeus is primarily a Web application, intended for access with a web browser. The Proxeus Association maintains a demo instances you can use to test the product, and can recommend a service provider to help you or your business get set up. There is also a prototype desktop application.

In addition to the developer guidelines below, several "one-click" deployment configurations are available for select cloud platforms:

• Docker Compose
• Linode StackScript
• DigitalOcean Droplet

Join the Discussions if you are interested in seeing additional providers on this list.

If you wish to build the project form the source code, follow the instructions in Build all.

Please read the Developer Manual to learn more about the Proxeus platform.

Infura and SparkPost

The Proxeus platform currently depends on Infura 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 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 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 engaging in insightful discussions. Especially, we are looking forward to receiving contributions for external workflow nodes.

See the Contributing Guide for further directions.

Security Issues

If you find a vulnerability that may affect live or testnet deployments please DO NOT file a public issue - send your report privately to [email protected]

License

Licensed under the GNU GENERAL PUBLIC LICENSE. You may read a copy of the License here.

Acknowledgements

Like so many projects, this effort has roots in many places. The list can be found in ACKNOWLEDGEMENTS.

Supported Chains

Ethereum

• mainnet
• sepolia
• goerli

Polygon

• mainnet
• mumbai