https://github.com/block-foundation/docker-algorand-indexer
Algorand Indexer Docker Image
https://github.com/block-foundation/docker-algorand-indexer
algo algod algorand blockchain blockfoundation docker indexer postgres
Last synced: 5 months ago
JSON representation
Algorand Indexer Docker Image
- Host: GitHub
- URL: https://github.com/block-foundation/docker-algorand-indexer
- Owner: block-foundation
- License: cc-by-sa-4.0
- Created: 2023-07-20T13:24:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T15:16:00.000Z (about 2 years ago)
- Last Synced: 2025-09-04T19:48:37.161Z (9 months ago)
- Topics: algo, algod, algorand, blockchain, blockfoundation, docker, indexer, postgres
- Language: Shell
- Homepage: https://hub.docker.com/orgs/blockfoundation
- Size: 659 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: CODEOWNERS
- Security: .github/SECURITY.md
- Authors: AUTHORS
Awesome Lists containing this project
README
[](https://github.com/block-foundation/brand/blob/main/LICENSE)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/block-foundation/brand)
[](https://hub.docker.com/r/blockfoundation/algorand-indexer)
[](https://hub.docker.com/r/blockfoundation/algorand-indexer)
[](https://hub.docker.com/r/blockfoundation/algorand-indexer/tags)
[](https://hub.docker.com/r/blockfoundation/algorand-indexer)
---
Algorand Indexer
Block Foundation Docker Containers
---
### Contents
- [Introduction](#introduction)
- [Colophon](#colophon)
---
[](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=bug_report.yml)
[](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=feature_request.yml)
[](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=question.yml)
[](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=suggestion.yml)
[](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=discussion.yml)
**The primary purpose of this Indexer is to provide a REST API interface of API calls to support searching the Algorand Blockchain. The Indexer REST APIs retrieve the blockchain data from a PostgreSQL compatible database that must be populated. This database is populated using the same indexer instance or a separate instance of the indexer which must connect to the algod process of a running Algorand node to read block data. This node must also be an Archival node to make searching the entire blockchain possible.**
## Introduction
In the context of the Algorand blockchain network, an Indexer is a tool that reads data from the Algorand blockchain and maintains a database of transactions and accounts that are searchable and indexed. On the other hand, Docker is a widely-used platform that simplifies the deployment, scaling, and management of applications. By merging these two technologies, we provide an easy-to-use and scalable way to interact with the Algorand network.
Our Docker image for the Algorand Indexer has been meticulously designed for accessibility, dependability, and security. It provides a preconfigured environment that's ready for use, thus reducing the hassle of manual setup. It is an ideal resource for developers keen on exploring the Algorand network, as well as those looking to contribute to the network by running an indexer.
Within this repository, you'll find comprehensive instructions on how to use the Docker image, alongside the source code of the image itself. We warmly encourage our community to utilize this Docker image, provide feedback, and join us in continually enhancing this resource.
As with all our projects, this Docker image stands as a testament to our commitment to transparency, collaboration, and democratization of technology. We are thrilled to share this resource with you and can't wait to see how it supports your endeavours in the blockchain space.
## Network
``` mermaid
stateDiagram
Blockchain --> Node
Node --> Blockchain
Node --> Indexer
state Indexer {
Service --> Database
Database --> Service
}
Indexer --> SDK
state SDK {
Python
JavaScript
Go
Java
}
```
## Resources
- https://hub.docker.com/r/algorand/indexer/tags
### Algorand
- [Algorand](https://www.algorand.com/)
- [Algorand | Developer](https://developer.algorand.org/)
#### Algorand SDK
- [Algorand SDK | Docs](https://py-algorand-sdk.readthedocs.io/en/latest/)
- [Algorand SDK | GitHub](https://github.com/algorand/py-algorand-sdk/)
#### Algorand Go
- [Algorand Go | GitHub](https://github.com/algorand/go-algorand)
#### AlgoDjango
- [AlgoDjango | Tutorial](https://developer.algorand.org/solutions/getting-started-with-python-algorand-sdk-and-django/)
- [AlgoDjango | GitHub](https://github.com/ipaleka/algodjango)
#### Algorand PyTeal
- [Algorand PyTeal](https://github.com/algorand/pyteal)
- [Algorand PyTeal | Utils](https://github.com/algorand/pyteal-utils)
- [Algorand PyTeal | Course](https://github.com/algorand-devrel/pyteal-course)
#### Algorand Sandbox
- [Algorand Sandbox](https://github.com/algorand/sandbox)
---
## Colophon
### Authors
This is an open-source project by the **[Block Foundation](https://www.blockfoundation.io "Block Foundation website")**.
The Block Foundation mission is enabling architects to take back initiative and contribute in solving the mismatch in housing through blockchain technology. Therefore the Block Foundation seeks to unschackle the traditional constraints and construct middle ground between rent and the rigidity of traditional mortgages.
website: [www.blockfoundation.io](https://www.blockfoundation.io "Block Foundation website")
### Development Resources
#### Contributing
We'd love for you to contribute and to make this project even better than it is today!
Please refer to the [contribution guidelines](.github/CONTRIBUTING.md) for information.
### Legal Information
#### Copyright
Copyright © 2023 [Stichting Block Foundation](https://www.blockfoundation.io/ "Block Foundation website"). All Rights Reserved.
#### License
Except as otherwise noted, the content in this repository is licensed under the
[Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/), and
code samples are licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).
Also see [LICENSE](https://github.com/block-foundation/community/blob/master/src/LICENSE) and [LICENSE-CODE](https://github.com/block-foundation/community/blob/master/src/LICENSE-CODE).
#### Disclaimer
**THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**