Documentation map
Where everything lives, and where the retired GitHub Wiki content went.
This site
| Topic | Page |
|---|---|
| Product overview, positioning, use cases, ADAMANT adoption | What is Currencyinfo |
| Components, startup sequence, refresh cycle, storage model | Architecture |
| Docker-first first run | Quick start |
| Container image, source install, systemd, v1 migration | Installation |
| Backup, upgrade, rollback, index rebuild, database migration | Upgrade and rollback |
Pair direction, grouping, divergence, weights, strategies, minSources, rateLifetime, triangulation | Rate calculation |
| Snapshot semantics, collections, indexes, retention | Rate history |
| Slack, Discord, ADAMANT Messenger setup | Notifications |
| Reverse proxy, TLS, health checks, logs, resources | Operations |
| Credentials, validation, container hardening, scanning, disclosure | Security |
| Symptom-first diagnosis | Troubleshooting |
/get, /getHistory, /status | REST API reference |
| Every configuration option | Configuration reference |
| Every connector, quota, and terms | Rate sources |
| Contributor guide | Contributing |
| Versioning, channels, deprecations | Release notes |
Elsewhere
| Resource | Location |
|---|---|
| Landing page | currencyinfo.dev |
| Source code | github.com/Adamant-im/currencyinfo |
| Release notes | github.com/Adamant-im/currencyinfo/releases |
| Container image | ghcr.io/adamant-im/currencyinfo |
| Issue tracker | github.com/Adamant-im/currencyinfo/issues |
| Contributor guide in the repository | CONTRIBUTING.md |
| AI agent operating manual | AGENTS.md |
| Umbrella ADAMANT documentation | docs.adamant.im |
Retired GitHub Wiki
The GitHub Wiki is deprecated. Its content has been migrated here, corrected against the current code, and its pages now carry a notice pointing at the canonical destination so existing deep links keep working.
| Former wiki page | Canonical destination | What changed in migration |
|---|---|---|
Home | Documentation map | Split into this map, the upgrade guide, and the v1 migration section |
Installation | Installation | Node.js requirement corrected from v20 to v22; the published container image replaces build-from-source as the recommended path; the stale .github/CONTRIBUTING.md link corrected |
API-specification | REST API reference | Example port corrected from 36668 to the real default 36661; rateLiftime typo corrected to rateLifetime; versions in examples updated; validation errors, units, and pair-order guarantees added |
Saved-rates-format | Rate history and pair direction | Corrected: base_coins in the shipped template is a full list including USD, not "USD only by default"; snapshot and storage semantics added |
Dealing-with-Rate-Differences-from-Multiple-Sources | Rate calculation | Corrected: groupPercentage is the minimum relative distance between the two heaviest group weights, not "the share of sources a group must contain". Source names in examples updated to the current connector set |
Rate-life-time | Freshness | Corrected: the fallback applies while a quote is inside rateLifetime, and its interaction with the minSources gate is documented |
Notifications | Notifications | Secret-shaped examples replaced with unmistakably synthetic placeholders. Validation rules and the placeholder-detection behaviour added |
The wiki is kept as a tombstone so existing inbound links resolve. It receives no further updates; open a documentation issue or a pull request against docs/ instead.