paysuper-reporter

README

PaySuper Reporter

PaySuper Reporter is a gRPC service for creating printable reports.

---

Features

• Creating printable reports as a dataset or printable form:
  • Royalty Reports
  • VATs
  • Transactions
  • Payouts, etc.

Table of Contents

• Usage
• Contributing
• License

Usage

Application can be launched with Kubernetes and handles all configuration from the environment variables:

Environment variables:

Name	Required	Default	Description
METRICS_PORT	-	8086	Http server port for health and metrics request
MICRO_SELECTOR	-	static	Type of selector for Micro service
MONGO_DSN	true	-	MongoBD DSN connection string
MONGO_DIAL_TIMEOUT	-	10	MongoBD dial timeout in seconds
MONGO_MODE	-	4	Consistency mode for the MongoDB session
BROKER_ADDRESS	-	amqp://127.0.0.1:5672	RabbitMQ url address
AWS_ACCESS_KEY_ID	true
AWS_SECRET_ACCESS_KEY	true
AWS_BUCKET	true
AWS_REGION	true
AWS_ACCESS_KEY_ID_AGREEMENT	true	-	AWS access key identifier for agreements storage
AWS_SECRET_ACCESS_KEY_AGREEMENT	true	-	AWS access secret key for agreements storage
AWS_BUCKET_AGREEMENT	true	-	AWS bucket name for agreements storage
AWS_REGION_AGREEMENT	-	eu-west-1	AWS region for agreements storage
CENTRIFUGO_API_SECRET	true	-	Centrifugo API secret key
CENTRIFUGO_URL	-	http://127.0.0.1:8000	Centrifugo API gateway
CENTRIFUGO_USER_CHANNEL	-	paysuper:user#%s	Centrifugo channel name to send notifications to user
DOCGEN_API_URL	-	http://127.0.0.1:5488	URL of document generation service
DOCGEN_API_TIMEOUT	-	180	Timeout for waiting for a response from the document generation service
DOCGEN_USERNAME	-		Username for authenticate
DOCGEN_PASSWORD	-		Password for authenticate
DOCGEN_ROYALTY_TEMPLATE	true		ID of template in the JSReport for royalty report
DOCGEN_ROYALTY_TRANSACTIONS_TEMPLATE	true		ID of template in the JSReport for royalty transactions report
DOCGEN_VAT_TEMPLATE	true		ID of template in the JSReport for vat report
DOCGEN_VAT_TRANSACTIONS_TEMPLATE	true		ID of template in the JSReport for vat transactions report
DOCGEN_TRANSACTIONS_TEMPLATE	true		ID of template in the JSReport for find transactions report
DOCGEN_PAYOUT_TEMPLATE	true		ID of template in the JSReport for payout report
DOCGEN_AGREEMENT_TEMPLATE	true		ID of template in the JSReport for merchant agreement license
DOCUMENT_RETENTION_TIME	-	604800	Time to live the document in the S3 and DB storage

Contributing, Feature Requests and Support

If you like this project then you can put a ⭐ on it. It means a lot to us.

If you have an idea of how to improve PaySuper (or any of the product parts) or have general feedback, you're welcome to submit a feature request.

Chances are, you like what we have already but you may require a custom integration, a special license or something else big and specific to your needs. We're generally open to such conversations.

If you have a question and can't find the answer yourself, you can raise an issue and describe what exactly you're trying to do. We'll do our best to reply in a meaningful time.

We feel that a welcoming community is important and we ask that you follow PaySuper's Open Source Code of Conduct in all interactions with the community.

PaySuper welcomes contributions from anyone and everyone. Please refer to our contribution guide to learn more.

License

The project is available as open source under the terms of the GPL v3 License.