Skip to content

Commit 3809ad1

Browse files
author
Alexandra Tran
committed
Merge branch 'main' of github.com:hyperledger/besu-docs
2 parents 6fe59f1 + 10ece28 commit 3809ad1

File tree

5 files changed

+234
-6
lines changed

5 files changed

+234
-6
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
- uses: actions/checkout@v4
1414

1515
- name: Build
16-
uses: ConsenSys/docs-gha/build@main
16+
uses: ConsenSys/github-actions/docs-build@main
1717
with:
1818
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1919

.github/workflows/links.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ jobs:
1414
steps:
1515
- uses: actions/checkout@v4
1616
- name: LinkCheck
17-
uses: ConsenSys/docs-gha/linkcheck@main
17+
uses: ConsenSys/github-actions/docs-link-check@main
1818
with:
1919
FILE_EXTENSION: ${{ matrix.file-extensions }}

.github/workflows/lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414
- uses: actions/checkout@v4
1515

1616
- name: Lint
17-
uses: ConsenSys/docs-gha/lint@main
17+
uses: ConsenSys/github-actions/docs-lint-all@main

docs/public-networks/reference/cli/options.md

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1412,6 +1412,233 @@ graphql-http-port="6175"
14121412

14131413
The port (TCP) on which GraphQL HTTP listens. The default is `8547`. Ports must be [exposed appropriately](../../how-to/connect/configure-ports.md).
14141414

1415+
### `graphql-mtls-enabled`
1416+
1417+
<Tabs>
1418+
<TabItem value="Syntax">
1419+
1420+
```bash
1421+
--graphql-mtls-enabled[=<true|false>]
1422+
```
1423+
1424+
</TabItem>
1425+
<TabItem value="Example">
1426+
1427+
```bash
1428+
--graphql-mtls-enabled=true
1429+
```
1430+
1431+
</TabItem>
1432+
<TabItem value="Environment variable">
1433+
1434+
```bash
1435+
BESU_GRAPHQL_MTLS_ENABLED=true
1436+
```
1437+
1438+
</TabItem>
1439+
<TabItem value="Configuration file">
1440+
1441+
```bash
1442+
graphql-mtls-enabled=true
1443+
```
1444+
1445+
</TabItem>
1446+
</Tabs>
1447+
1448+
Enables or disables mTLS for the GraphQL HTTP service.
1449+
The default is `false`.
1450+
1451+
:::note
1452+
[`--graphql-http-enabled`](#graphql-http-enabled) must be enabled.
1453+
:::
1454+
1455+
### `graphql-tls-enabled`
1456+
1457+
<Tabs>
1458+
<TabItem value="Syntax">
1459+
1460+
```bash
1461+
--graphql-tls-enabled[=<true|false>]
1462+
```
1463+
1464+
</TabItem>
1465+
<TabItem value="Example">
1466+
1467+
```bash
1468+
--graphql-tls-enabled=true
1469+
```
1470+
1471+
</TabItem>
1472+
<TabItem value="Environment variable">
1473+
1474+
```bash
1475+
BESU_GRAPHQL_TLS_ENABLED=true
1476+
```
1477+
1478+
</TabItem>
1479+
<TabItem value="Configuration file">
1480+
1481+
```bash
1482+
graphql-tls-enabled=true
1483+
```
1484+
1485+
</TabItem>
1486+
</Tabs>
1487+
1488+
Enables or disables TLS for the GraphQL HTTP service.
1489+
The default is `false`.
1490+
1491+
:::note
1492+
[`--graphql-http-enabled`](#graphql-http-enabled) must be enabled.
1493+
:::
1494+
1495+
### `graphql-tls-keystore-file`
1496+
1497+
<Tabs>
1498+
<TabItem value="Syntax">
1499+
1500+
```bash
1501+
--graphql-tls-keystore-file=<FILE>
1502+
```
1503+
1504+
</TabItem>
1505+
<TabItem value="Example">
1506+
1507+
```bash
1508+
--graphql-tls-keystore-file=/home/me/me_node/keystore.pfx
1509+
```
1510+
1511+
</TabItem>
1512+
<TabItem value="Environment variable">
1513+
1514+
```bash
1515+
BESU_GRAPHQL_TLS_KEYSTORE_FILE=/home/me/me_node/keystore.pfx
1516+
```
1517+
1518+
</TabItem>
1519+
<TabItem value="Configuration file">
1520+
1521+
```bash
1522+
graphql-tls-keystore-file="/home/me/me_node/keystore.pfx"
1523+
```
1524+
1525+
</TabItem>
1526+
</Tabs>
1527+
1528+
Path to the keystore file when enabling TLS for the GraphQL HTTP service.
1529+
The keystore file contains the private key and certificate presented to the client during authentication.
1530+
1531+
Specify the keystore password file using [`--graphql-tls-keystore-password-file`](#graphql-tls-keystore-password-file).
1532+
1533+
### `graphql-tls-keystore-password-file`
1534+
1535+
<Tabs>
1536+
<TabItem value="Syntax">
1537+
1538+
```bash
1539+
--graphql-tls-keystore-password-file=<FILE>
1540+
```
1541+
1542+
</TabItem>
1543+
<TabItem value="Example">
1544+
1545+
```bash
1546+
--graphql-tls-keystore-password-file=/home/me/me_node/password
1547+
```
1548+
1549+
</TabItem>
1550+
<TabItem value="Environment variable">
1551+
1552+
```bash
1553+
BESU_GRAPHQL_TLS_KEYSTORE_PASSWORD_FILE=/home/me/me_node/password
1554+
```
1555+
1556+
</TabItem>
1557+
<TabItem value="Configuration file">
1558+
1559+
```bash
1560+
graphql-tls-keystore-password-file="/home/me/me_node/password"
1561+
```
1562+
1563+
</TabItem>
1564+
</Tabs>
1565+
1566+
Path to the file containing the password for the keystore specified in [`--graphql-tls-keystore-file`](#graphql-tls-keystore-file),
1567+
when enabling TLS for the GraphQL HTTP service.
1568+
1569+
### `graphql-tls-truststore-file`
1570+
1571+
<Tabs>
1572+
<TabItem value="Syntax">
1573+
1574+
```bash
1575+
--graphql-tls-truststore-file=<FILE>
1576+
```
1577+
1578+
</TabItem>
1579+
<TabItem value="Example">
1580+
1581+
```bash
1582+
--graphql-tls-truststore-file=/home/me/me_node/truststore.pfx
1583+
```
1584+
1585+
</TabItem>
1586+
<TabItem value="Environment variable">
1587+
1588+
```bash
1589+
BESU_GRAPHQL_TLS_TRUSTSTORE_FILE=/home/me/me_node/truststore.pfx
1590+
```
1591+
1592+
</TabItem>
1593+
<TabItem value="Configuration file">
1594+
1595+
```bash
1596+
graphql-tls-truststore-file="/home/me/me_node/truststore.pfx"
1597+
```
1598+
1599+
</TabItem>
1600+
</Tabs>
1601+
1602+
Path to the truststore file when enabling TLS for the GraphQL HTTP service.
1603+
1604+
Specify the truststore password file using [`--graphql-tls-truststore-password-file`](#graphql-tls-truststore-password-file).
1605+
1606+
### `graphql-tls-truststore-password-file`
1607+
1608+
<Tabs>
1609+
<TabItem value="Syntax">
1610+
1611+
```bash
1612+
--graphql-tls-truststore-password-file=<FILE>
1613+
```
1614+
1615+
</TabItem>
1616+
<TabItem value="Example">
1617+
1618+
```bash
1619+
--graphql-tls-truststore-password-file=/home/me/me_node/password
1620+
```
1621+
1622+
</TabItem>
1623+
<TabItem value="Environment variable">
1624+
1625+
```bash
1626+
BESU_GRAPHQL_TLS_TRUSTSTORE_PASSWORD_FILE=/home/me/me_node/password
1627+
```
1628+
1629+
</TabItem>
1630+
<TabItem value="Configuration file">
1631+
1632+
```bash
1633+
graphql-tls-truststore-password-file="/home/me/me_node/password"
1634+
```
1635+
1636+
</TabItem>
1637+
</Tabs>
1638+
1639+
Path to the file containing the password for the truststore specified in [`--graphql-tls-truststore-file`](#graphql-tls-truststore-file),
1640+
when enabling TLS for the GraphQL HTTP service.
1641+
14151642
### `help`
14161643

14171644
<Tabs>

package-lock.json

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)