diff --git a/website/docs/gateway/1-getting-started.md b/website/docs/gateway/1-getting-started.md index 8731ff5d4fb972ba9a2601bfef9cbdf0e0906735..ee34f0f70bb70f8280d4e3206dcfb9fb88a970a2 100644 --- a/website/docs/gateway/1-getting-started.md +++ b/website/docs/gateway/1-getting-started.md @@ -1,5 +1,7 @@ --- sidebar_position: 1 +title: 1. Getting Started +keywords: [xx network, cmixx, xxchain, gateway, setup, installation, getting started] --- # 1. Getting Started diff --git a/website/docs/gateway/10-gateway-config.md b/website/docs/gateway/10-gateway-config.md index 1439492660d03baf3937698444e28b539490e516..797be79b5f66a44b9ace2855425a6da07551d3b6 100644 --- a/website/docs/gateway/10-gateway-config.md +++ b/website/docs/gateway/10-gateway-config.md @@ -1,5 +1,7 @@ --- sidebar_position: 10 +title: 10. cMixx Configuration File +keywords: [xx network, cmixx, gateway, setup, installation, yaml, nano, configuration] --- # 10. Gateway Configuration File diff --git a/website/docs/gateway/11-gateway-services-config.md b/website/docs/gateway/11-gateway-services-config.md index 81bfb91bc3cf413434ba203190cd99c90e66f159..5d65d0f15effa5323886e3029981425295ef2685 100644 --- a/website/docs/gateway/11-gateway-services-config.md +++ b/website/docs/gateway/11-gateway-services-config.md @@ -1,5 +1,7 @@ --- sidebar_position: 11 +title: 11. Node System Services +keywords: [xx network, cmixx, gateway, setup, installation, systemctl, service, systemd] --- # 11. Gateway System Services diff --git a/website/docs/gateway/2-software-dependencies.md b/website/docs/gateway/2-software-dependencies.md index e2350b272095a024c4f0184fc87427ec1dc4ab86..af3ee617e98b133f454c6a4dbfca1c863b5974a1 100644 --- a/website/docs/gateway/2-software-dependencies.md +++ b/website/docs/gateway/2-software-dependencies.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +title: 2. Software Dependencies +keywords: [xx network, cmixx, xxchain, gateway, setup, installation, software, dependencies] --- # 2. Software Dependencies diff --git a/website/docs/gateway/3-gateway-firewall.md b/website/docs/gateway/3-gateway-firewall.md index 9d238081452b69fee1f7d0e22140e7a2e2b3ed14..91644a8f285efb0178e578d3a7ea8087e4467f20 100644 --- a/website/docs/gateway/3-gateway-firewall.md +++ b/website/docs/gateway/3-gateway-firewall.md @@ -1,5 +1,7 @@ --- sidebar_position: 3 +title: 3. Firewall (UFW) +keywords: [xx network, cmixx, gateway, setup, installation, firewall, ufw] --- # 3. Firewall (UFW) diff --git a/website/docs/gateway/4-gateway-port-forwarding.md b/website/docs/gateway/4-gateway-port-forwarding.md index 82bc47d6a88022f8a8de4d7e74738c342b2b3520..0516095ccfeca8b9bb798c789746a473f5ac45b9 100644 --- a/website/docs/gateway/4-gateway-port-forwarding.md +++ b/website/docs/gateway/4-gateway-port-forwarding.md @@ -1,5 +1,7 @@ --- sidebar_position: 4 +title: 4. Port Forwarding +keywords: [xx network, cmixx, gateway, setup, installation, port forwarding] --- # 4. Port Forwarding diff --git a/website/docs/gateway/5-clock-syncronization.md b/website/docs/gateway/5-clock-syncronization.md index 71151fb75c2af77f2d100cd046c64cdab46409a7..a0ad4c50cccecf1049af4c378ac02f823fa535ad 100644 --- a/website/docs/gateway/5-clock-syncronization.md +++ b/website/docs/gateway/5-clock-syncronization.md @@ -1,5 +1,7 @@ --- sidebar_position: 5 +title: 5. Clock Syncronization +keywords: [xx network, cmixx, gateway, setup, installation, ntp, syncronize] --- # 5. Clock Synchronization diff --git a/website/docs/gateway/6-tcp-settings.md b/website/docs/gateway/6-tcp-settings.md index dd87e452a28789af9b280c7ad711cdc712204c02..d24cb980e266bd4bad3c240be9320896e1e498a8 100644 --- a/website/docs/gateway/6-tcp-settings.md +++ b/website/docs/gateway/6-tcp-settings.md @@ -1,5 +1,7 @@ --- sidebar_position: 6 +title: 6. TCP Network Settings +keywords: [xx network, cmixx, gateway, setup, installation, sysctl, bbr, tcp] --- # 6. TCP Network Settings diff --git a/website/docs/gateway/7-gateway-database.md b/website/docs/gateway/7-gateway-database.md index ee032235f251940c821698ac5ea0c66dd7c54229..40d1a3c3f58aeb74cb274bdb57d22fef7ed02dba 100644 --- a/website/docs/gateway/7-gateway-database.md +++ b/website/docs/gateway/7-gateway-database.md @@ -1,5 +1,7 @@ --- sidebar_position: 7 +title: 7. PostgreSQL Database +keywords: [xx network, cmixx, gateway, setup, installation, database, postgresql, psql] --- # 7. PostgreSQL Database diff --git a/website/docs/gateway/8-gateway-tarballs.md b/website/docs/gateway/8-gateway-tarballs.md index 961185685f78e08ae29a583868e20b4229b939bc..019ad9ed9c751248d0fc604eaf70b9d204631a7d 100644 --- a/website/docs/gateway/8-gateway-tarballs.md +++ b/website/docs/gateway/8-gateway-tarballs.md @@ -1,5 +1,7 @@ --- sidebar_position: 8 +title: 8. Tarballs +keywords: [xx network, cmixx, gateway, setup, installation, tarball, software, tar] --- # 8. Software Tarball diff --git a/website/docs/gateway/9-transfer-creds.md b/website/docs/gateway/9-transfer-creds.md index 71c8d4de3d70601da78769dc13d1cc4c4f1cb729..7cb55e9933c1ec36a98b435b264eb06fc0a05300 100644 --- a/website/docs/gateway/9-transfer-creds.md +++ b/website/docs/gateway/9-transfer-creds.md @@ -1,5 +1,7 @@ --- sidebar_position: 9 +title: 9. Transfer TLS Credentials +keywords: [xx network, cmixx, gateway, setup, installation, scp, tls, crt, key] --- # 9. Transfer TLS Credentials diff --git a/website/docs/gateway/_category_.json b/website/docs/gateway/_category_.json index 9619e91e2746754584e4aa37582fde17f964bbd6..251cc8c2b44993e05db9ca3fa62e203c0e57cc81 100644 --- a/website/docs/gateway/_category_.json +++ b/website/docs/gateway/_category_.json @@ -3,6 +3,6 @@ "position": 4, "link": { "type": "generated-index", - "description": "Gateway" + "description": "Instructions for configuring the Gateway computer." } } diff --git a/website/docs/intro.md b/website/docs/intro.md index 94e087958d78206b94788954e97b244c39cd66c5..f32594f97a62cf4d417c487c8a1641a56bce1b69 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -1,6 +1,9 @@ --- sidebar_position: 1 slug: / +title: Introduction +description: The xx network Node Runner's Handbook +keywords: [xx network, cmixx, xxchain, documentation, installation, node, gateway] --- # Introduction diff --git a/website/docs/linux/_category_.json b/website/docs/linux/_category_.json index 65be149eb6b8e5eb8bd68d3a0268243d116e386c..e420f3fcaa88d59a05953680ebd070079ee5e0e9 100644 --- a/website/docs/linux/_category_.json +++ b/website/docs/linux/_category_.json @@ -3,6 +3,6 @@ "position": 6, "link": { "type": "generated-index", - "description": "Linux Help" + "description": "General Linux help for Node Runners" } } diff --git a/website/docs/linux/add-user-account.md b/website/docs/linux/add-user-account.md index e58d85832d2b1cbde835c2ebf26656f3617551b0..8850c5e52c7ee6caffa64bdb3109f35bf08feb5b 100644 --- a/website/docs/linux/add-user-account.md +++ b/website/docs/linux/add-user-account.md @@ -1,3 +1,10 @@ +--- +sidebar_position: 1 +title: Add User Account +description: How to add a new user. +keywords: [xx network, node, gateway, adduser, usermod, sudo, root] +--- + # Add User Account The following steps will create a new user named *ubuntu* that can run commands with elevated privileges. diff --git a/website/docs/linux/change-timezone.md b/website/docs/linux/change-timezone.md index 5e120b4574ba6466fde77562582ea359a9cd08da..85955dfff561b7df9aec4c60ca8eec833c36286d 100644 --- a/website/docs/linux/change-timezone.md +++ b/website/docs/linux/change-timezone.md @@ -1,3 +1,10 @@ +--- +sidebar_position: 5 +title: Change Time Zone +description: How to change the time zone of a computer. +keywords: [xx network, node, gateway, ntp, timedatectl, time zone] +--- + # Change Time Zone If you wish to change the *Time zone* of the computer, you can do so with the following. diff --git a/website/docs/linux/get-ids.md b/website/docs/linux/get-ids.md index 25b6d1121e882019dc52a8588a4612e5e9893386..91aa3474413c17426892cebb0d1d11a978ac4d9b 100644 --- a/website/docs/linux/get-ids.md +++ b/website/docs/linux/get-ids.md @@ -1,3 +1,10 @@ +--- +sidebar_position: 3 +title: cMixx IDs +description: How to view the xx network related cMixx IDs. +keywords: [xx network, node, cmix-idf.json, idf, id] +--- + # Get cMixx IDs There will be times when you need to get the IDs associated with you cMixx node. diff --git a/website/docs/linux/get-ips.md b/website/docs/linux/get-ips.md index 695e4d27eec8904cd6f34064ccec893f81cef226..798ef0a8d171c4be4c65dd0cd83ca0e5f36da853 100644 --- a/website/docs/linux/get-ips.md +++ b/website/docs/linux/get-ips.md @@ -1,3 +1,10 @@ +--- +sidebar_position: 4 +title: IP addresses +description: How to view the IP addresses of a computer. +keywords: [xx network, node, gateway, ip address, local, public] +--- + # Get IPs There will be times when you need to get the IP addresses assigned to the computer you are logged in to. diff --git a/website/docs/linux/logs.md b/website/docs/linux/logs.md index 8297b7c53cee34f6e5a4605efaa53f049376eb3c..da901a8bbc36e63333debccd0aaa13f7bdf41f23 100644 --- a/website/docs/linux/logs.md +++ b/website/docs/linux/logs.md @@ -1,3 +1,10 @@ +--- +sidebar_position: 2 +title: xx network Logs +description: How to view the xx network related logs. +keywords: [xx network, node, gateway, validator, cmix.log, gateway.log, chain.log, tail] +--- + # xx network Logs ## Log Location diff --git a/website/docs/linux/ufw.md b/website/docs/linux/ufw.md index 51bc7d75a633e0f30204f8ca98cfe85c39517421..3632ab15fc4fe835835c689b353447d3eacd6731 100644 --- a/website/docs/linux/ufw.md +++ b/website/docs/linux/ufw.md @@ -1,3 +1,10 @@ +--- +sidebar_position: 6 +title: UFW Cheat Sheet +description: A cheat sheet for working with UFW. +keywords: [xx network, node, gateway, ufw, firewall, add rule, delete rule, rule] +--- + # UFW Cheat Sheet *ufw*, the Uncomplicated Firewall, is one of many programs available for managing a netfilter firewall. diff --git a/website/docs/node/1-getting-started.md b/website/docs/node/1-getting-started.md index 3fb2e25496e6f48180aadd20f65a1be55c0805b9..b2479238bde87892d72e4e1a44c5aa5636b173a7 100644 --- a/website/docs/node/1-getting-started.md +++ b/website/docs/node/1-getting-started.md @@ -1,5 +1,7 @@ --- sidebar_position: 1 +title: 1. Getting Started +keywords: [xx network, cmixx, xxchain, node, setup, installation, getting started] --- # 1. Getting Started diff --git a/website/docs/node/10-node-config.md b/website/docs/node/10-node-config.md index 1427ab8b65f28880dc4c09d9cc2cb02550af1e7f..e261fec16e69a5997c97b547141af765fdeb4fbb 100644 --- a/website/docs/node/10-node-config.md +++ b/website/docs/node/10-node-config.md @@ -1,5 +1,7 @@ --- sidebar_position: 10 +title: 10. cMixx Configuration File +keywords: [xx network, cmixx, node, setup, installation, yaml, nano, configuration] --- # 10. cMixx Configuration File diff --git a/website/docs/node/11-node-services-config.md b/website/docs/node/11-node-services-config.md index 3d37e062f9422dc64b785f4cdf6446d9a052efe3..19c53da60b4458775b4d27373b5ceed22f2c4c6d 100644 --- a/website/docs/node/11-node-services-config.md +++ b/website/docs/node/11-node-services-config.md @@ -1,5 +1,7 @@ --- sidebar_position: 11 +title: 11. Node System Services +keywords: [xx network, cmixx, node, setup, installation, systemctl, service, systemd] --- # 11. Node System Services diff --git a/website/docs/node/2-software-dependencies.md b/website/docs/node/2-software-dependencies.md index 5624251732d93a10b5f8113fbe07e36f3724a219..70e1569cefbbf11d94e9b7f0e1693e1dc481a5d8 100644 --- a/website/docs/node/2-software-dependencies.md +++ b/website/docs/node/2-software-dependencies.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +title: 2. Software Dependencies +keywords: [xx network, cmixx, xxchain, node, setup, installation, software, dependencies] --- # 2. Software Dependencies diff --git a/website/docs/node/3-node-firewall.md b/website/docs/node/3-node-firewall.md index 2b119f04cc605b84bb65a6c7558962e66c386d70..53f7b16443cc8048b092cccae6a30f0883e73c84 100644 --- a/website/docs/node/3-node-firewall.md +++ b/website/docs/node/3-node-firewall.md @@ -1,5 +1,7 @@ --- sidebar_position: 3 +title: 3. Firewall (UFW) +keywords: [xx network, cmixx, node, setup, installation, firewall, ufw] --- # 3. Firewall (UFW) diff --git a/website/docs/node/4-node-port-forwarding.md b/website/docs/node/4-node-port-forwarding.md index 0bf1e5bf0ff1b8f00d1ee80e5fb37e5136ab8bcb..bc364467320eb2103246fdc4565c48a38f4a22d7 100644 --- a/website/docs/node/4-node-port-forwarding.md +++ b/website/docs/node/4-node-port-forwarding.md @@ -1,5 +1,7 @@ --- sidebar_position: 4 +title: 4. Port Forwarding +keywords: [xx network, cmixx, node, setup, installation, port forwarding] --- # 4. Port Forwarding diff --git a/website/docs/node/5-clock-syncronization.md b/website/docs/node/5-clock-syncronization.md index c54cef7b68ffcd9a0b510b8825c7f8d1d6f767ce..f33c4f70d761efd96869059cf9ff232512e98adf 100644 --- a/website/docs/node/5-clock-syncronization.md +++ b/website/docs/node/5-clock-syncronization.md @@ -1,5 +1,7 @@ --- sidebar_position: 5 +title: 5. Clock Syncronization +keywords: [xx network, cmixx, node, setup, installation, ntp, syncronize] --- # 5. Clock Synchronization diff --git a/website/docs/node/6-tcp-settings.md b/website/docs/node/6-tcp-settings.md index 7e2e1ffe0ae663dce4b6a2dcfb6dadbda264e596..c68f6c2e75d695e51f9a8d1b195553db3346950b 100644 --- a/website/docs/node/6-tcp-settings.md +++ b/website/docs/node/6-tcp-settings.md @@ -1,5 +1,7 @@ --- sidebar_position: 6 +title: 6. TCP Network Settings +keywords: [xx network, cmixx, node, setup, installation, sysctl, bbr, tcp] --- # 6. TCP Network Settings diff --git a/website/docs/node/7-node-database.md b/website/docs/node/7-node-database.md index 52efdbd96d77875d2e2333abe30d70051819d92a..c79fe48d5faa3428a4feeeaffbcd4fa733609fd8 100644 --- a/website/docs/node/7-node-database.md +++ b/website/docs/node/7-node-database.md @@ -1,5 +1,7 @@ --- sidebar_position: 7 +title: 7. PostgreSQL Database +keywords: [xx network, cmixx, node, setup, installation, database, postgresql, psql] --- # 7. PostgreSQL Database diff --git a/website/docs/node/8-node-tarballs.md b/website/docs/node/8-node-tarballs.md index 0ba8e2e00ec2b9f4344c7eac57202b8b9b537c7d..4b8b34bb87b56b752fdc7f02398223ce68efdb03 100644 --- a/website/docs/node/8-node-tarballs.md +++ b/website/docs/node/8-node-tarballs.md @@ -1,5 +1,7 @@ --- sidebar_position: 8 +title: 8. Tarballs +keywords: [xx network, cmixx, node, setup, installation, tarball, software, tar] --- # 8. Software Tarball diff --git a/website/docs/node/9-generate-creds.md b/website/docs/node/9-generate-creds.md index 970e635972aaa778e952d803666a43e269f6dfd5..f3f0e6e8a13eb2dfbcd98e79c9eaaa6f7da0dfaa 100644 --- a/website/docs/node/9-generate-creds.md +++ b/website/docs/node/9-generate-creds.md @@ -1,5 +1,7 @@ --- sidebar_position: 9 +title: 9. cMixx TLS Credentials +keywords: [xx network, cmixx, node, setup, installation, generate, tls, crt, key] --- # 9. cMixx TLS Credentials diff --git a/website/docs/node/_category_.json b/website/docs/node/_category_.json index 084aa81997b83c0e16569511aeb6528d990af994..d451bd8daef749699a8157e58adb945cc7a52a1a 100644 --- a/website/docs/node/_category_.json +++ b/website/docs/node/_category_.json @@ -3,6 +3,6 @@ "position": 3, "link": { "type": "generated-index", - "description": "Node" + "description": "Instructions for configuring the Node computer." } } diff --git a/website/docs/specifications.md b/website/docs/specifications.md index 67d014d1c50d1ff4b61c20fa666dbab792188ba7..4a98901f98d3fc1b60c000d184e0e169c5a86693 100644 --- a/website/docs/specifications.md +++ b/website/docs/specifications.md @@ -1,5 +1,8 @@ --- sidebar_position: 2 +title: Specifications +description: Node and Gateway Computer Specifications +keywords: [xx network, cmixx, xxchain, documentation, node, gateway, specs, specifications, hardware] --- # Specifications @@ -11,7 +14,7 @@ Each xx Node is comprised of two computers, a NODE computer and a GATEWAY comput ### Tested and Supported * Ubuntu Server 20.04 LTS * Ubuntu Server 22.04 LTS - * Ubunti Server 24.04 LTS + * Ubuntu Server 24.04 LTS :::info This is not to say that the xx Network software can only be run on the recommended OSs, but it may not be fully compatible due to the various versions of software that are installed by default by the OS maintainer. diff --git a/website/docs/staking/1-getting-started.md b/website/docs/staking/1-getting-started.md index fe69e53b128202373c795053d6492e2e50b9c116..6b0cdc1c120417bb5fa8de798c096d3c0cb56ceb 100644 --- a/website/docs/staking/1-getting-started.md +++ b/website/docs/staking/1-getting-started.md @@ -1,5 +1,7 @@ --- sidebar_position: 1 +title: 1. Getting Started +keywords: [xx network, xxchain, node, getting started, staking, validator] --- # 1. Getting Started diff --git a/website/docs/staking/2-validator-status.md b/website/docs/staking/2-validator-status.md index 2681c13e7407f7dc95b752837c61be521e67cae8..112ab507015dbb0101c441449ccf10f42fa4e6ca 100644 --- a/website/docs/staking/2-validator-status.md +++ b/website/docs/staking/2-validator-status.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +title: 2. Validator Status +keywords: [xx network, xxchain, node, validator, sync, tail, chain.log] --- # 2. Validator Sync State diff --git a/website/docs/staking/3-accounts.md b/website/docs/staking/3-accounts.md index c3a7c72cd709b10a70992b53cc665b0ab64a5f44..2e416fefbf37736f398a9a477a35d3033e5bbe2e 100644 --- a/website/docs/staking/3-accounts.md +++ b/website/docs/staking/3-accounts.md @@ -1,5 +1,7 @@ --- sidebar_position: 3 +title: 3. Stash and Controller Accounts +keywords: [xx network, xxchain, node, validator, stash, controller, account] --- # 3. Stash and Controller Accounts diff --git a/website/docs/staking/4-session-keys.md b/website/docs/staking/4-session-keys.md index 2496e9ee82516c0dbef17e96c28a588c1e12b16a..3e1adeeae24ac05a711012ead10cf39243a8b495 100644 --- a/website/docs/staking/4-session-keys.md +++ b/website/docs/staking/4-session-keys.md @@ -1,5 +1,7 @@ --- sidebar_position: 4 +title: 4. Validator Session Keys +keywords: [xx network, xxchain, node, validator, session keys, generate] --- # 4. hexNodeID and Session Keys diff --git a/website/docs/staking/5-add-validator.md b/website/docs/staking/5-add-validator.md index 9059f5ac0f7971d4143599fbbb369bae061c8dcf..f79f21553dfac2b62522c6a3aa1ea345eb0b4fb3 100644 --- a/website/docs/staking/5-add-validator.md +++ b/website/docs/staking/5-add-validator.md @@ -1,5 +1,7 @@ --- sidebar_position: 5 +title: 5. Add and Setup the Validator +keywords: [xx network, xxchain, node, validator, stash, controller, session keys, wallet] --- # 5. Add and Setup the Validator diff --git a/website/docs/staking/6-on-chain-id.md b/website/docs/staking/6-on-chain-id.md index b9c4b022c09a6a19cd46750690a037151672e1ca..88eb162420d4e16cf059c4f62e9c2b1f469c3595 100644 --- a/website/docs/staking/6-on-chain-id.md +++ b/website/docs/staking/6-on-chain-id.md @@ -1,5 +1,7 @@ --- sidebar_position: 6 +title: 6. On-Chain Identity (Optional) +keywords: [xx network, xxchain, node, validator, wallet, on-chain identity, cmixx node id, validator address] --- # 6. On-Chain Identity (Optional) diff --git a/website/docs/staking/_category_.json b/website/docs/staking/_category_.json index d2fb7be7a4aedae83f5bec3ea2d21db55daef5c8..bedd91465c57068795180725eeca647812673877 100644 --- a/website/docs/staking/_category_.json +++ b/website/docs/staking/_category_.json @@ -3,6 +3,6 @@ "position": 5, "link": { "type": "generated-index", - "description": "Validator" + "description": "Instructions for staking the Validator." } }