ks-tools/doc/ks-upf.md
2024-05-01 11:26:47 +02:00

113 lines
2.8 KiB
Markdown

ks-upf - Upload common file(s) to server with scp or rsync.
===========================================================
### Syntax:
```shell
$ ks-upf -i - Start upload
$ ks-upf -g - Create configuration
$ ks-upf -r - Remove configuration
$ ks-upf -c - Show configuration
$ ks-upf -e - Edit configuration
$ ks-upf -p - Generate certificate
$ ks-upf -v - Show version
$ ks-upf -h - Show help
```
### Initialize common file(s) upload:
* For initialize file(s) upload only run the following command:
```shell
$ ks-upf -i
````
* The first time you run the command, you will be asked for the necessary connection information:
```shell
* Enter the server user: anonymous
* Enter the server password (type 'pem' for use pem certificate): *******
* Enter the server URL (or IP): mypersonaldomain.es
* Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos
* Setting 'scp' as the default tool
* Setting port 22 as the default port
````
* Once the connection data has been entered, the local directory will be scanned to detect file(s) and upload them to the server directory.
### Remove configuration:
* If you want to clear the connection settings, you just need to run the following command:
```shell
$ ks-upf -r
````
### Show configuration:
* You can check the configuration with the following command:
```shell
$ ks-upf -c
````
* When consulting the configuration, we will see something like this:
```shell
* Server User: anonymous
* Server Password/PEM: *******
* URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos
* Upload Tool: scp
* Port Connection: 22
````
### Edit configuration:
* To edit any section of the configuration, the following command would be executed:
```shell
$ ks-upf -e
````
* After its execution, we will see a menu like the following one to be able to edit the desired section:
```shell
1 - Edit User (anonymous)
2 - Edit Password/PEM (*******)
3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos)
6 - Edit Upload Tool (scp)
7 - Edit Port Connection (22)
8 - Exit
* Choose an option:
````
### Generate certificate (on remote machine):
* To generate certificate for connect to remote machine, run the following command:
```shell
$ ks-upf -p
````
* Copy the file [user]-[hostname].pem to your machine.
### Show version:
* You can check the version with the command:
```shell
$ ks-upf -v
````
### Back to README.md
* [Go back](https://git.q3aql.dev/q3aql/ks-tools/src/branch/main/README.md)