opencode-skills-collection 3.1.12 → 3.1.14

package/bundled-skills/rclone-cli/references/providers/sia.md

@@ -0,0 +1,223 @@
+---
+title: "Sia"
+description: "Remote for Sia Decentralized Cloud"
+versionIntroduced: "v1.57"
+date: "2019-10-02"
+---
+
+> **Official documentation:** [https://rclone.org/sia/](https://rclone.org/sia/)
+# Sia
+
+Sia ([sia.tech](https://sia.tech/)) is a decentralized cloud storage platform
+based on the [blockchain](https://wikipedia.org/wiki/Blockchain) technology.
+With rclone you can use it like any other remote filesystem or mount Sia folders
+locally. The technology behind it involves a number of new concepts such as
+Siacoins and Wallet, Blockchain and Consensus, Renting and Hosting, and so on.
+If you are new to it, you'd better first familiarize yourself using their
+excellent [support documentation](https://support.sia.tech/).
+
+## Introduction
+
+Before you can use rclone with Sia, you will need to have a running copy of
+`Sia-UI` or `siad` (the Sia daemon) locally on your computer or on local
+network (e.g. a NAS). Please follow the [Get started](https://sia.tech/get-started)
+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
+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
+  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`
+  and `--disable-api-security` arguments on the daemon command line.
+- Enforce API password for the `siad` daemon via environment variable
+  `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`.
+   Alternatively you can make `siad` unlock your wallet automatically upon
+   startup by running it with environment variable `SIA_WALLET_PASSWORD`.
+2. If `siad` cannot find the `SIA_API_PASSWORD` variable or the `apipassword` file
+   in the `SIA_DIR` directory, it will generate a random password and store in the
+   text file named `apipassword` under `YOUR_HOME/.sia/` directory on Unix
+   or `C:\Users\YOUR_HOME\AppData\Local\Sia\apipassword` on Windows.
+   Remember this when you configure password in rclone.
+3. The only way to use `siad` without API password is to run it **on localhost**
+   with command line argument `--authorize-api=false`, but this is insecure and
+   **strongly discouraged**.
+
+## Configuration
+
+Here is an example of how to make a `sia` remote called `mySia`.
+First, run:
+
+```console
+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
+q) Quit config
+n/s/q> n
+name> mySia
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+...
+29 / Sia Decentralized Cloud
+   \ "sia"
+...
+Storage> sia
+Sia daemon API URL, like http://sia.daemon.host:9980.
+Note that siad must run with --disable-api-security to open API port for other hosts (not recommended).
+Keep default if Sia daemon runs on localhost.
+Enter a string value. Press Enter for the default ("http://127.0.0.1:9980").
+api_url> http://127.0.0.1:9980
+Sia Daemon API Password.
+Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.
+y) Yes type in my own password
+g) Generate random password
+n) No leave this optional password blank (default)
+y/g/n> y
+Enter the password:
+password:
+Confirm the password:
+password:
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n> n
+--------------------
+[mySia]
+type = sia
+api_url = http://127.0.0.1:9980
+api_password = *** ENCRYPTED ***
+--------------------
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+```
+
+Once configured, you can then use `rclone` like this:
+
+- List directories in top level of your Sia storage
+
+  ```console
+  rclone lsd mySia:
+  ```
+
+- List all the files in your Sia storage
+
+  ```console
+  rclone ls mySia:
+  ```
+
+- Upload a local directory to the Sia directory called *backup*
+
+  ```console
+  rclone copy /home/source mySia:backup
+  ```
+
+<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sia/sia.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
+### Standard options
+
+Here are the Standard options specific to sia (Sia Decentralized Cloud).
+
+#### --sia-api-url
+
+Sia daemon API URL, like http://sia.daemon.host:9980.
+
+Note that siad must run with --disable-api-security to open API port for other hosts (not recommended).
+Keep default if Sia daemon runs on localhost.
+
+Properties:
+
+- Config:      api_url
+- Env Var:     RCLONE_SIA_API_URL
+- Type:        string
+- Default:     "http://127.0.0.1:9980"
+
+#### --sia-api-password
+
+Sia Daemon API Password.
+
+Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.
+
+**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
+
+Properties:
+
+- Config:      api_password
+- Env Var:     RCLONE_SIA_API_PASSWORD
+- Type:        string
+- Required:    false
+
+### Advanced options
+
+Here are the Advanced options specific to sia (Sia Decentralized Cloud).
+
+#### --sia-user-agent
+
+Siad User Agent
+
+Sia daemon requires the 'Sia-Agent' user agent by default for security
+
+Properties:
+
+- Config:      user_agent
+- Env Var:     RCLONE_SIA_USER_AGENT
+- Type:        string
+- Default:     "Sia-Agent"
+
+#### --sia-encoding
+
+The encoding for the backend.
+
+See the [encoding section in the overview](/overview/#encoding) for more info.
+
+Properties:
+
+- Config:      encoding
+- Env Var:     RCLONE_SIA_ENCODING
+- Type:        Encoding
+- Default:     Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot
+
+#### --sia-description
+
+Description of the remote.
+
+Properties:
+
+- Config:      description
+- Env Var:     RCLONE_SIA_DESCRIPTION
+- Type:        string
+- Required:    false
+
+<!-- autogenerated options stop -->
+
+## Limitations
+
+- Modification times not supported
+- Checksums not supported
+- `rclone about` not supported
+- 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)
+  them for you, but you'd better be aware

package/bundled-skills/rclone-cli/references/providers/smb.md

@@ -0,0 +1,309 @@
+---
+title: "SMB / CIFS"
+description: "Rclone docs for SMB backend"
+versionIntroduced: "v1.60"
+---
+
+> **Official documentation:** [https://rclone.org/smb/](https://rclone.org/smb/)
+# SMB
+
+SMB is [a communication protocol to share files over network](https://en.wikipedia.org/wiki/Server_Message_Block).
+
+This relies on [go-smb2 library](https://github.com/CloudSoda/go-smb2/) for
+communication with SMB protocol.
+
+Paths are specified as `remote:sharename` (or `remote:` for the `lsd`
+command.)  You may put subdirectories in too, e.g. `remote:item/path/to/dir`.
+
+## Notes
+
+The first path segment must be the name of the share, which you entered when
+you started to share on Windows. On smbd, it's the section title in `smb.conf`
+(usually in `/etc/samba/`) file.
+You can find shares by querying the root if you're unsure (e.g. `rclone lsd remote:`).
+
+You can't access the shared printers from rclone, obviously.
+
+You can't use Anonymous access for logging in. You have to use the `guest` user
+with an empty password instead. The rclone client tries to avoid 8.3 names when
+uploading files by encoding trailing spaces and periods. Alternatively,
+[the local backend](/local/#paths-on-windows) on Windows can access SMB servers
+using UNC paths, by `\\server\share`. This doesn't apply to non-Windows OSes,
+such as Linux and macOS.
+
+## Configuration
+
+Here is an example of making a SMB configuration.
+
+First run
+
+```console
+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
+q) Quit config
+n/s/q> n
+name> remote
+Option Storage.
+Type of storage to configure.
+Choose a number from below, or type in your own value.
+XX / SMB / CIFS
+   \ (smb)
+Storage> smb
+
+Option host.
+Samba hostname to connect to.
+E.g. "example.com".
+Enter a value.
+host> localhost
+
+Option user.
+Samba username.
+Enter a string value. Press Enter for the default (lesmi).
+user> guest
+
+Option port.
+Samba port number.
+Enter a signed integer. Press Enter for the default (445).
+port>
+
+Option pass.
+Samba password.
+Choose an alternative below. Press Enter for the default (n).
+y) Yes, type in my own password
+g) Generate random password
+n) No, leave this optional password blank (default)
+y/g/n> g
+Password strength in bits.
+64 is just about memorable
+128 is secure
+1024 is the maximum
+Bits> 64
+Your password is: XXXX
+Use this password? Please note that an obscured version of this
+password (and not the password itself) will be stored under your
+configuration file, so keep this generated password in a safe place.
+y) Yes (default)
+n) No
+y/n> y
+
+Option domain.
+Domain name for NTLM authentication.
+Enter a string value. Press Enter for the default (WORKGROUP).
+domain>
+
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n> n
+
+Configuration complete.
+Options:
+- type: samba
+- host: localhost
+- user: guest
+- pass: *** ENCRYPTED ***
+Keep this "remote" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> d
+```
+
+<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/smb/smb.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
+### Standard options
+
+Here are the Standard options specific to smb (SMB / CIFS).
+
+#### --smb-host
+
+SMB server hostname to connect to.
+
+E.g. "example.com".
+
+Properties:
+
+- Config:      host
+- Env Var:     RCLONE_SMB_HOST
+- Type:        string
+- Required:    true
+
+#### --smb-user
+
+SMB username.
+
+Properties:
+
+- Config:      user
+- Env Var:     RCLONE_SMB_USER
+- Type:        string
+- Default:     "$USER"
+
+#### --smb-port
+
+SMB port number.
+
+Properties:
+
+- Config:      port
+- Env Var:     RCLONE_SMB_PORT
+- Type:        int
+- Default:     445
+
+#### --smb-pass
+
+SMB password.
+
+**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
+
+Properties:
+
+- Config:      pass
+- Env Var:     RCLONE_SMB_PASS
+- Type:        string
+- Required:    false
+
+#### --smb-domain
+
+Domain name for NTLM authentication.
+
+Properties:
+
+- Config:      domain
+- Env Var:     RCLONE_SMB_DOMAIN
+- Type:        string
+- Default:     "WORKGROUP"
+
+#### --smb-spn
+
+Service principal name.
+
+Rclone presents this name to the server. Some servers use this as further
+authentication, and it often needs to be set for clusters. For example:
+
+    cifs/remotehost:1020
+
+Leave blank if not sure.
+
+
+Properties:
+
+- Config:      spn
+- Env Var:     RCLONE_SMB_SPN
+- Type:        string
+- Required:    false
+
+#### --smb-use-kerberos
+
+Use Kerberos authentication.
+
+If set, rclone will use Kerberos authentication instead of NTLM. This
+requires a valid Kerberos configuration and credentials cache to be
+available, either in the default locations or as specified by the
+KRB5_CONFIG and KRB5CCNAME environment variables.
+
+
+Properties:
+
+- Config:      use_kerberos
+- Env Var:     RCLONE_SMB_USE_KERBEROS
+- Type:        bool
+- Default:     false
+
+### Advanced options
+
+Here are the Advanced options specific to smb (SMB / CIFS).
+
+#### --smb-idle-timeout
+
+Max time before closing idle connections.
+
+If no connections have been returned to the connection pool in the time
+given, rclone will empty the connection pool.
+
+Set to 0 to keep connections indefinitely.
+
+
+Properties:
+
+- Config:      idle_timeout
+- Env Var:     RCLONE_SMB_IDLE_TIMEOUT
+- Type:        Duration
+- Default:     1m0s
+
+#### --smb-hide-special-share
+
+Hide special shares (e.g. print$) which users aren't supposed to access.
+
+Properties:
+
+- Config:      hide_special_share
+- Env Var:     RCLONE_SMB_HIDE_SPECIAL_SHARE
+- Type:        bool
+- Default:     true
+
+#### --smb-case-insensitive
+
+Whether the server is configured to be case-insensitive.
+
+Always true on Windows shares.
+
+Properties:
+
+- Config:      case_insensitive
+- Env Var:     RCLONE_SMB_CASE_INSENSITIVE
+- Type:        bool
+- Default:     true
+
+#### --smb-kerberos-ccache
+
+Path to the Kerberos credential cache (krb5cc).
+
+Overrides the default KRB5CCNAME environment variable and allows this
+instance of the SMB backend to use a different Kerberos cache file.
+This is useful when mounting multiple SMB with different credentials
+or running in multi-user environments.
+
+Supported formats:
+  - FILE:/path/to/ccache   – Use the specified file.
+  - DIR:/path/to/ccachedir – Use the primary file inside the specified directory.
+  - /path/to/ccache        – Interpreted as a file path.
+
+Properties:
+
+- Config:      kerberos_ccache
+- Env Var:     RCLONE_SMB_KERBEROS_CCACHE
+- Type:        string
+- Required:    false
+
+#### --smb-encoding
+
+The encoding for the backend.
+
+See the [encoding section in the overview](/overview/#encoding) for more info.
+
+Properties:
+
+- Config:      encoding
+- Env Var:     RCLONE_SMB_ENCODING
+- Type:        Encoding
+- Default:     Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
+
+#### --smb-description
+
+Description of the remote.
+
+Properties:
+
+- Config:      description
+- Env Var:     RCLONE_SMB_DESCRIPTION
+- Type:        string
+- Required:    false
+
+<!-- autogenerated options stop -->