forked from PegaSysEng/pantheon
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
147 lines (141 loc) · 6.23 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# Copyright 2018 ConsenSys AG.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.
# Project information
site_name: Pantheon
site_url: https://docs.pantheon.pegasys.tech/en/stable/
site_description: Pantheon Java Ethereum client documentation.
site_author: Pantheon community
copyright: Pantheon and its documentation are licensed under Apache 2.0 license /
This <a href="https://readthedocs.org/">Readthedocs.org</a> documentation is maintained with love by <a href="https://pegasys.tech/">PegaSys</a>.
#extra project info and template customisation
extra:
support:
gitter: https://gitter.im/PegaSysEng/pantheon
email: support@pegasys.tech
pegasys_website: https://pegasys.tech/
issues: https://pegasys1.atlassian.net/secure/Dashboard.jspa?selectPageId=10000
google:
site_verification: 'za1cLzyS6LXDGO-pMzvfQdYTZ0Zc67uZtY0asA4YXZ0'
tag_manager: 'GTM-5B7N84J'
hotjar:
site_id: '1161123'
# Repository
repo_name: PegaSysEng/pantheon
repo_url: https://github.com/PegaSysEng/pantheon/
theme:
name: material
custom_dir: docs/custom_theme
palette:
primary: blue-grey
accent: teal
favicon: favicon.ico
logo:
icon: account_balance
nav:
- Installation:
- Installation Overview: Installation/Overview.md
- Install Binary Distribution: Installation/Install-Binaries.md
- Build from Source: Installation/Build-From-Source.md
- Architecture:
- Overview: Architecture/Overview.md
- Getting Started:
- Getting Started Overview: Getting-Started/Getting-Started.md
- Starting Pantheon: Getting-Started/Starting-Pantheon.md
- Running Pantheon from Docker Image: Getting-Started/Run-Docker-Image.md
- Tutorials:
- Private Network Quickstart: Tutorials/Private-Network-Quickstart.md
- Private Network Quickstart On Azure: Tutorials/Azure/Azure-Private-Network-Quickstart.md
- Create a Private Network using Ethash (Pow): Tutorials/Create-Private-Network.md
- Create a Private Network using Clique (PoA): Tutorials/Create-Private-Clique-Network.md
- Create a Private Network using IBFT 2.0 (PoA): Tutorials/Create-IBFT-Network.md
- Create a Permissioned Network: Tutorials/Create-Permissioned-Network.md
- Consensus Protocols:
- Pantheon Consensus Protocols: Consensus-Protocols/Overview-Consensus.md
- Comparing PoA Consensus Protocols: Consensus-Protocols/Comparing-PoA.md
- Clique: Consensus-Protocols/Clique.md
- IBFT 2.0: Consensus-Protocols/IBFT.md
- Quorum IBFT 1.0: Consensus-Protocols/QuorumIBFT.md
- JSON-RPC API:
- Overview: JSON-RPC-API/JSON-RPC-API.md
- Using the JSON-RPC API: JSON-RPC-API/Using-JSON-RPC-API.md
- Authentication: JSON-RPC-API/Authentication.md
- Configuring Pantheon:
- Network vs Node Configuration: Configuring-Pantheon/Network-vs-Node.md
- Configuration File: Configuring-Pantheon/Using-Configuration-File.md
- Network ID and Chain ID: Configuring-Pantheon/NetworkID-And-ChainID.md
- Free Gas Networks: Configuring-Pantheon/FreeGas.md
- Contracts in Genesis: Configuring-Pantheon/Contracts-in-Genesis.md
- Node Keys: Configuring-Pantheon/Node-Keys.md
- Accounts for Testing: Configuring-Pantheon/Accounts-for-Testing.md
- Logging: Configuring-Pantheon/Logging.md
- Passing JVM Options: Configuring-Pantheon/Passing-JVM-Options.md
- Networking:
- Bootnodes: Configuring-Pantheon/Networking/Bootnodes.md
- Configuring Ports: Configuring-Pantheon/Networking/Configuring-Ports.md
- Managing Peers: Configuring-Pantheon/Networking/Managing-Peers.md
- Privacy:
- Overview: Privacy/Privacy-Overview.md
- Processing Private Transactions: Privacy/Private-Transaction-Processing.md
- Configuring a Privacy-Enabled Network: Privacy/Configuring-Privacy.md
- Permissions:
- Overview: Permissions/Permissioning-Overview.md
- Local Permissions: Permissions/Local-Permissioning.md
- Using Pantheon:
- Transactions:
- Creating and Sending Transactions: Using-Pantheon/Transactions/Transactions.md
- Transaction Pool: Using-Pantheon/Transactions/Transaction-Pool.md
- Using Truffle with Panthen: Using-Pantheon/Truffle.md
- Events and Logs:
- Overview: Using-Pantheon/Events-and-Logs.md
- Accessing Logs Using JSON-RPC API: Using-Pantheon/Accessing-Logs-Using-JSON-RPC.md
- Using Wallets for Account Management: Using-Pantheon/Account-Management.md
- Mining: Using-Pantheon/Mining.md
- RPC Pub/Sub: Using-Pantheon/RPC-PubSub.md
- Debugging Pantheon: Using-Pantheon/Debugging.md
- Monitoring Pantheon:
- EthStats:
- Overview: EthStats/Overview.md
- Lite Block Explorer: EthStats/Lite-Block-Explorer.md
- Lite Network Health Monitor: EthStats/Lite-Network-Health-Monitor.md
- Reference:
- Pantheon Command Line: Reference/Pantheon-CLI-Syntax.md
- JSON-RPC API Methods: Reference/JSON-RPC-API-Methods.md
- JSON-RPC API Objects: Reference/JSON-RPC-API-Objects.md
- Resources:
- Blog Posts and Webinars: Resources/Resources.md
markdown_extensions:
- toc:
permalink:
toc_depth: 3
- codehilite
- markdown_include.include:
base_path: docs
- admonition
- footnotes
- def_list
- abbr
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.keys
- pymdownx.details
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- meta
- smarty
plugins:
- search