README
¶
PaySuper Document Signer
PaySuper Document Signer is a gRPC or HTTP service to sign legal documents using HelloSign’s API.
Features
- All signatures are 100% legal and all info is stored securely.
Table of Contents
Usage
The application handles all configuration from the environment variables:
Environment variables:
| Name | Required | Default | Description |
|---|---|---|---|
| METRICS_PORT | - | 8087 | Http server port |
| MICRO_SELECTOR | - | "" | Registry selector for go-micro package |
| HELLO_SIGN_API_URL_CREATE_EMBEDDED | - | https://api.hellosign.com/v3/signature_request/create_embedded | HelloSign API URL for creating signature request with some file(s) |
| HELLO_SIGN_API_URL_EMBEDDED_SIGN | - | https://api.hellosign.com/v3/embedded/sign_url/<signature_id> | HelloSign API URL for get signing url for place into client side |
| HELLO_SIGN_API_URL_CREATE_EMBEDDED_WITH_TEMPLATE | - | https://api.hellosign.com/v3/signature_request/create_embedded_with_template | HelloSign API URL for creating signature request with prepared template |
| HELLO_SIGN_API_URL_WEBSITE | - | https://api.hellosign.com/v3/signature_request/send | HelloSign API URL for creating signature request with website |
| HELLO_SIGN_API_KEY | true | HelloSign API secret key | |
| HELLO_SIGN_DEFAULT_SUBJECT | - | The agreement signing we talked about | Subject to signature request to HelloSign API |
| HELLO_SIGN_DEFAULT_TITLE | - | Agreement with company | Title to signature request to HelloSign API |
| HELLO_SIGN_DEFAULT_MESSAGE | - | Please sign this agreement and then we can discuss more. Let me know if you have any questions. | Message to signature request to HelloSign API |
| HELLO_SIGN_TEST_MODE | - | true | HelloSign API request will send in test mode |
| CENTRIFUGO_URL | true | - | Centrifugo API URL |
| CENTRIFUGO_API_SECRET | true | - | Centrifugo API secret key |
| CENTRIFUGO_ADMIN_CHANNEL | - | paysuper:admin | Centrifugo channel name to send messages to admins |
| 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 |
| AWS_ACCESS_KEY_ID_REPORT | - | eu-west-1 | AWS access key identifier for reports storage |
| AWS_SECRET_ACCESS_KEY_REPORT | - | eu-west-1 | AWS access secret key for reports storage |
| AWS_BUCKET_REPORT | - | eu-west-1 | AWS bucket name for reports storage |
| AWS_REGION_REPORT | - | eu-west-1 | AWS region for reports storage |
| HELLO_SIGN_LOGIN | true | - | User login to authorize in HelloSign control panel |
| HELLO_SIGN_PASSWORD | true | - | User password to authorize in HelloSign control panel |
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories