Skip to content

Commit

Permalink
Merge pull request #696 from autonomys/revert_cli-tips_changes
Browse files Browse the repository at this point in the history
Revert PR #685
  • Loading branch information
EmilFattakhov authored Oct 21, 2024
2 parents 7e598f0 + f19154c commit 65d721a
Show file tree
Hide file tree
Showing 6 changed files with 179 additions and 384 deletions.
459 changes: 132 additions & 327 deletions docs/farming-&-staking/farming/advanced-cli/cli-tips.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Troubleshooting
sidebar_position: 5
description: How to run an Autonomys Network Farmer with the Substrate CLI
slug: /farming/advanced-cli/troubleshooting
keywords:
- Farmer
- Farming
- CLI
- Binaries
- Docker
---

## Troubleshooting

If you are facing issues with your node/farmer you can try a few of the following things below, if you are unable to get your issue resolved please check our [Forum](https://forum.autonomys.xyz/c/support/5) to see if your issue may have been solved, if its a new one feel free to post it! You can also join our [Discord](https://autonomys.xyz/discord) and use one of the dedicated channels #farmer-support and #farmer-chat for additional Peer to Peer help.

:::info
We have included a few tutorials below that may help you in your support journey, this is not an all inclusive list and we welcome contributions
:::


### Enable Rust Backtrace

When running the Autonomys Network Farmer & Node, you might encounter an error message indicating the need for a Rust backtrace to diagnose issues:

```text
Backtrace omitted. Run with RUST_BACKTRACE=1 environment variable to display it.
```

This message suggests that Rust, the programming language used in the Autonomys Network Farmer & Node, has encountered a problem. By default, the backtrace is not displayed. To enable the `RUST_BACKTRACE` environment variable and view detailed error information, use the following commands based on your operating system:

- **🖼️ Windows** (PowerShell): Enter `$Env:RUST_BACKTRACE=1` in PowerShell and rerun the application.
- **🍎 macOS**: Type `export RUST_BACKTRACE=1` in the terminal and rerun the application.
- **🐧 Ubuntu**: Enter `export RUST_BACKTRACE=1` in the terminal and rerun the application.
- **⚙ Service (Linux)**: For services, use `sudo systemctl edit subspace-node` or `sudo systemctl edit subspace-farmer`, add `[Service]` and `Environment=RUST_BACKTRACE=1` between the warning comments, reload with `sudo systemctl daemon-reload`, and restart services using `sudo systemctl restart subspace-{node,farmer}`.

By enabling `RUST_BACKTRACE`, you can obtain additional diagnostic information to help resolve any errors encountered during operation.

### Common Problems

Looking for solutions to other common issues?

Check out our Common Problems page. This resource covers a range of frequently encountered challenges, offering practical solutions to help you overcome them. Please note that while this page addresses many common issues, it is not an all-inclusive list. For issues not covered, you can visit our forums or Discord for additional support.
2 changes: 1 addition & 1 deletion docs/farming-&-staking/farming/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ SSD storage is required. High end models are not necessary and a mid range SSD f

:::caution File Descriptor Limit

Linux systems may have a default file descriptor limit, which can vary based on distribuition. Exceeding this limit could cause errors. For detailed information, visit our [Tips & Tricks](/farming/advanced-cli/tips#open-files-limit) guide.
Linux systems may have a default file descriptor limit, which can vary based on distribuition. Exceeding this limit could cause errors. For detailed information, visit our [Tips & Tricks](/farming/advanced-cli/tips#changing-number-of-open-files-limit-linux) guide.

:::

Expand Down
3 changes: 2 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ const config = {
{ to: '/farming/space-acres/translate', from: ['/docs/farming-&-staking/farming/space-acres/translate_space_acres'] },
{ to: '/farming/advanced-cli/install', from: ['/docs/farming-&-staking/farming/advanced-cli/cli-install', '/docs/protocol/cli/', '/docs/protocol/substrate-cli/', '/docs/Farming%20&%20Staking/Farming/Advanced-Cli/cli-install', '/docs/category/advanced-cli-recommended', '/docs/category/advanced-cli', '/docs/farming-&-staking/farming/advanced-cli/cli-install'] },
{ to: '/farming/advanced-cli/cluster', from: ['/docs/farming-&-staking/farming/advanced-cli/cli-farming-cluster'] },
{ to: '/farming/advanced-cli/tips', from: ['/docs/farming-&-staking/farming/advanced-cli/cli-tips', '/docs/farming-&-staking/farming/advanced-cli/cli-troubleshooting'] },
{ to: '/farming/advanced-cli/tips', from: ['/docs/farming-&-staking/farming/advanced-cli/cli-tips'] },
{ to: '/farming/advanced-cli/troubleshooting', from: ['/docs/farming-&-staking/farming/advanced-cli/cli-troubleshooting'] },
{ to: '/farming/common-problems', from: ['/docs/farming-&-staking/farming/common_problems'] },
{ to: '/farming/guides/gpu-plotter', from: ['/docs/farming-&-staking/farming/additional-guides/gpu-plotter'] },
{ to: '/farming/guides/port-config', from: ['/docs/farming-&-staking/farming/additional-guides/port-config'] },
Expand Down
46 changes: 0 additions & 46 deletions src/components/Button/index.js

This file was deleted.

9 changes: 0 additions & 9 deletions src/theme/MDXComponents.js

This file was deleted.

0 comments on commit 65d721a

Please sign in to comment.