docs: fix markdown lint issues in backend docs

This commit is contained in:
albertony committed 2025-08-26 12:04:00 +02:00
1 parent 2e02d49578
commit 091ccb649c
71 files changed
+2663 -1646

No files matched your search

+19 -16
View File
@@ -23,14 +23,15 @@ network (e.g. a NAS). Please follow the [Get started](https://sia.tech/get-start
guide and install one.
rclone interacts with Sia network by talking to the Sia daemon via [HTTP API](https://sia.tech/docs/)
which is usually available on port _9980_. By default you will run the daemon
which is usually available on port *9980*. By default you will run the daemon
locally on the same computer so it's safe to leave the API password blank
(the API URL will be `http://127.0.0.1:9980` making external access impossible).
However, if you want to access Sia daemon running on another node, for example
due to memory constraints or because you want to share single daemon between
several rclone and Sia-UI instances, you'll need to make a few more provisions:
- Ensure you have _Sia daemon_ installed directly or in
- Ensure you have *Sia daemon* installed directly or in
a [docker container](https://github.com/SiaFoundation/siad/pkgs/container/siad)
because Sia-UI does not support this mode natively.
- Run it on externally accessible port, for example provide `--api-addr :9980`
@@ -39,8 +40,8 @@ several rclone and Sia-UI instances, you'll need to make a few more provisions:
`SIA_API_PASSWORD` or text file named `apipassword` in the daemon directory.
- Set rclone backend option `api_password` taking it from above locations.
Notes:
1. If your wallet is locked, rclone cannot unlock it automatically.
You should either unlock it in advance by using Sia-UI or via command line
`siac wallet unlock`.
@@ -60,11 +61,13 @@ Notes:
Here is an example of how to make a `sia` remote called `mySia`.
First, run:
rclone config
```sh
rclone config
```
This will guide you through an interactive setup process:
```
```text
No remotes found, make a new one?
n) New remote
s) Set configuration password
@@ -114,21 +117,21 @@ Once configured, you can then use `rclone` like this:
- List directories in top level of your Sia storage
```
rclone lsd mySia:
```
```sh
rclone lsd mySia:
```
- List all the files in your Sia storage
```
rclone ls mySia:
```
```sh
rclone ls mySia:
```
- Upload a local directory to the Sia directory called _backup_
- Upload a local directory to the Sia directory called *backup*
```
rclone copy /home/source mySia:backup
```
```sh
rclone copy /home/source mySia:backup
```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sia/sia.go then run make backenddocs" >}}
### Standard options
@@ -212,7 +215,7 @@ Properties:
- Modification times not supported
- Checksums not supported
- `rclone about` not supported
- rclone can work only with _Siad_ or _Sia-UI_ at the moment,
- rclone can work only with *Siad* or *Sia-UI* at the moment,
the **SkyNet daemon is not supported yet.**
- Sia does not allow control characters or symbols like question and pound
signs in file names. rclone will transparently [encode](/overview/#encoding)