Skip to content

Commit

Permalink
Feat/DF-20068 por indexer readme (#3386)
Browse files Browse the repository at this point in the history
* DF-20068 add por-indexer service deployment doc to por-indexer EA readme

* add changeset

* update readme
  • Loading branch information
mmcallister-cll authored Aug 14, 2024
1 parent 34908c5 commit d704dc5
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/great-cars-collect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@chainlink/por-indexer-adapter': patch
---

update readme doc with dependency section
6 changes: 6 additions & 0 deletions packages/sources/por-indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ This document was generated automatically. Please see [README Generator](../../s

## Known Issues

### Dependencies

The `por-indexer` external adapter is strongly dependent on a synced `bitcoin-por-indexer` service and will not be functional without it.

Follow [this deployment documentation](https://chainlink.notion.site/Bitcoin-Proof-of-Reserves-v2-e670b124e429466bbb31988c6836a9da) to set up a `bitcoin-por-indexer` service. Note that sync time may take weeks in certain cases.

### MAX_PAYLOAD_SIZE_LIMIT configuration

The `MAX_PAYLOAD_SIZE_LIMIT` environment variable is used for controlling the maximum size of the incoming request body that the EA can handle. If you decide to customize this value it's essential to ensure that any reverse proxy or web server in front of the EA, such as Nginx, is also configured with a corresponding limit. This alignment prevents scenarios where Nginx rejects a request for exceeding its payload size limit before it reaches the EA.
Expand Down
6 changes: 6 additions & 0 deletions packages/sources/por-indexer/docs/known-issues.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Known Issues

### Dependencies

The `por-indexer` external adapter is strongly dependent on a synced `bitcoin-por-indexer` service and will not be functional without it.

Follow [this deployment documentation](https://chainlink.notion.site/Bitcoin-Proof-of-Reserves-v2-e670b124e429466bbb31988c6836a9da) to set up a `bitcoin-por-indexer` service. Note that sync time may take weeks in certain cases.

### MAX_PAYLOAD_SIZE_LIMIT configuration

The `MAX_PAYLOAD_SIZE_LIMIT` environment variable is used for controlling the maximum size of the incoming request body that the EA can handle. If you decide to customize this value it's essential to ensure that any reverse proxy or web server in front of the EA, such as Nginx, is also configured with a corresponding limit. This alignment prevents scenarios where Nginx rejects a request for exceeding its payload size limit before it reaches the EA.

0 comments on commit d704dc5

Please sign in to comment.