-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix broken links to config options (#30)
Nested README.md files are not linked correctly, so we rename them to index.md.
- Loading branch information
Showing
6 changed files
with
45 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1 @@ | ||
# Options | ||
|
||
Otterscan can be customized in many different ways. | ||
|
||
- [Branding](./branding.md) | ||
|
||
If your chain is an Optimism L2 Superchain, you can wire that Otterscan instance with an L1 one. | ||
|
||
- [Optimism](./optimism.md) | ||
|
||
Price resolvers can be customized as well. | ||
|
||
- [Price oracles](./oracles.md) | ||
|
||
If you are running Otterscan against a non-standard chain, but you are sure Erigon can run it, you can explicitly specify the configuration. | ||
|
||
- [Recognizing nonstandard chains](./chains.md) | ||
|
||
In case you are running your own Sourcify instance, that's configurable as well. | ||
|
||
- [Alternative Sourcify sources](./sourcify.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Options | ||
|
||
Otterscan can be customized in many different ways. | ||
|
||
- [Branding](./branding.md) | ||
|
||
If your chain is an Optimism L2 Superchain, you can wire that Otterscan instance with an L1 one. | ||
|
||
- [Optimism](./optimism.md) | ||
|
||
Price resolvers can be customized as well. | ||
|
||
- [Price oracles](./oracles.md) | ||
|
||
If you are running Otterscan against a non-standard chain, but you are sure Erigon can run it, you can explicitly specify the configuration. | ||
|
||
- [Recognizing nonstandard chains](./chains.md) | ||
|
||
In case you are running your own Sourcify instance, that's configurable as well. | ||
|
||
- [Alternative Sourcify sources](./sourcify.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1 @@ | ||
# Specifying the configuration | ||
|
||
There are multiple ways to configure Otterscan base settings, depending on how you want to run it. | ||
|
||
## Static hardcoded node/chain ID | ||
|
||
Define a `VITE_CONFIG_JSON` environment variable containing a JSON string with the entire config. | ||
|
||
- [During development time](./devel.md) | ||
- [For production](./prod.md) | ||
|
||
## Fetch config from server | ||
|
||
If you don't specify a `VITE_CONFIG_JSON` variable, the dapp will fetch a `<your-domain>/config.json` file on page load. | ||
|
||
That file can be overwritten server-side and changes will be reflected when users refresh the page. | ||
|
||
You are free to define the best way to do that depending on how you package your Otterscan distribution. | ||
|
||
For reference, our official Docker image accepts initialization parameters that overwrite that file when the container is initialized. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Specifying the configuration | ||
|
||
There are multiple ways to configure Otterscan base settings, depending on how you want to run it. | ||
|
||
## Static hardcoded node/chain ID | ||
|
||
Define a `VITE_CONFIG_JSON` environment variable containing a JSON string with the entire config. | ||
|
||
- [During development time](./devel.md) | ||
- [For production](./prod.md) | ||
|
||
## Fetch config from server | ||
|
||
If you don't specify a `VITE_CONFIG_JSON` variable, the dapp will fetch a `<your-domain>/config.json` file on page load. | ||
|
||
That file can be overwritten server-side and changes will be reflected when users refresh the page. | ||
|
||
You are free to define the best way to do that depending on how you package your Otterscan distribution. | ||
|
||
For reference, our official Docker image accepts initialization parameters that overwrite that file when the container is initialized. |