forked from Consensys/doc.ethsigner
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
128 lines (123 loc) · 4.83 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
# Copyright 2020 ConsenSys Software Inc.
#
# 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: EthSigner
site_url: https://docs.ethsigner.consensys.net/
site_description: EthSigner Transaction Signer documentation.
site_author: EthSigner community
copyright: EthSigner and its documentation are licensed under Apache 2.0 license
#extra project info and template customisation
extra:
logo_is_text: true
latest_version_warning:
url_contains: /latest/
text: 'You are reading EthSigner development version documentation and
some displayed features may not be available in the stable release.
You can switch to stable version using the version box at screen bottom.'
support:
tool: Discord
channel: https://discord.gg/5U9Jwp7
email: [email protected]
website: https://consensys.net/quorum/developers
company: Consensys
issues: https://github.com/ConsenSys/ethsigner/issues
faq: https://consensys.net/quorum/faq
google:
site_verification: 'za1cLzyS6LXDGO-pMzvfQdYTZ0Zc67uZtY0asA4YXZ0'
tag_manager: 'GTM-5VXGSDM'
# Software Repository
repo_name: ConsenSys/EthSigner
repo_url: https://github.com/ConsenSys/ethsigner
theme:
name: material
custom_dir: common/custom_theme
palette:
primary: orange
accent: teal
logo: 'images/logo.svg'
favicon: 'images/favicon.svg'
nav:
- How to:
- Get started with EthSigner:
- Install binary distribution: HowTo/Get-Started/Install-Binaries.md
- Run EthSigner from Docker image: HowTo/Get-Started/Use-Docker.md
- Build from source: HowTo/Get-Started/Build-From-Source.md
- Use a single signing key: HowTo/Use-Single-Signer.md
- Use multiple signing keys: HowTo/Use-Multiple-Signers.md
- Make transactions: HowTo/Transactions/Make-Transactions.md
- Store keys externally:
- Use Hashicorp Vault: HowTo/Store-Keys/Use-Hashicorp.md
- Use Azure Key Vault: HowTo/Store-Keys/Use-Azure.md
- Use a configuration file: HowTo/Use-Configuration-File.md
- Configure TLS: HowTo/Configure-TLS.md
- Monitor nodes:
- Use metrics: HowTo/Monitor-Nodes/Metrics.md
- Create external signers: HowTo/Extending-EthSigner/Add-Signer.md
- Tutorials:
- Start EthSigner with a single signer: Tutorials/Start-EthSigner.md
- Start EthSigner with multiple signers: Tutorials/Multifile.md
- Quorum Developer Quickstart: Tutorials/Quorum-Dev-Quickstart.md
- Concepts:
- Overview: Concepts/Overview.md
- TLS communication: Concepts/TLS.md
- Reference:
- Command line:
- Options: Reference/CLI/CLI-Syntax.md
- Subcommands: Reference/CLI/CLI-Subcommands.md
- API methods: Reference/API-Methods.md
- Multikey TOML parameters: Reference/Multikey-Parameters.md
- Security disclosure policy: Reference/Responsible-Disclosure.md
markdown_extensions:
- toc:
permalink:
toc_depth: 4
- codehilite
- pymdownx.tabbed
- pymdownx.superfences
- 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.tasklist:
custom_checkbox: true
- pymdownx.tilde
- meta
- smarty
plugins:
- search:
lang: 'en'
separator: '[\s]+'
- markdownextradata
- redirects:
redirect_maps:
# Configure redirects using key:value pairs:
# old_path.md: new_path.md
# you can't use an already redirected path as an old_path.
# new_path can be a file inside the docs/ folder or any URL (http://...)
Reference/EthSigner-CLI.md: Reference/CLI/CLI-Syntax.md
Extending-EthSigner/Adding-Signer.md: HowTo/Extending-EthSigner/Add-Signer.md
Using-EthSigner/Azure.md: HowTo/Store-Keys/Use-Azure.md
Using-EthSigner/Hashicorp.md: HowTo/Store-Keys/Use-Hashicorp.md
Using-EthSigner/Using-EthSigner.md: HowTo/Transactions/Make-Transactions.md
Using-EthSigner/Getting-Started.md: Tutorials/Start-EthSigner.md
Installation/Build-From-Source.md: HowTo/Get-Started/Build-From-Source.md
Installation/Install-Binaries.md: HowTo/Get-Started/Install-Binaries.md