q3aql/ks-tools
q3aql/ks-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
q3aql 2023-03-11 15:46:16 +01:00
parent 438afccf7a
commit 1dc9297491
8 changed files with 79 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/ks-upa.md
View File

@ -9,6 +9,7 @@ $ ks-upa -g - Create configuration
$ ks-upa -r - Remove configuration $ ks-upa -r - Remove configuration
$ ks-upa -c - Show configuration $ ks-upa -c - Show configuration
$ ks-upa -e - Edit configuration $ ks-upa -e - Edit configuration
$ ks-upa -p - Generate certificate
$ ks-upa -v - Show version $ ks-upa -v - Show version
$ ks-upa -h - Show help $ ks-upa -h - Show help
``` ```
@ -25,10 +26,12 @@ $ ks-upa -h - Show help
```shell ```shell
* Enter the server user: anonymous * Enter the server user: anonymous
* Enter the server key: ******* * Enter the server password (type 'pem' for use pem certificate): *******
* Enter the server URL: mypersonaldomain.es * Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous * Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos * 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 the audios and upload them to the server directory. * Once the connection data has been entered, the local directory will be scanned to detect the audios and upload them to the server directory.
@ -53,7 +56,7 @@ $ ks-upa -h - Show help
```shell ```shell
* Server User: anonymous * Server User: anonymous
* Server Password: ******* * Server Password/PEM: *******
* URL (or IP) Server: mypersonaldomain.es * URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous * Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos * Scan Path (Local): /home/local/videos
@ -73,7 +76,7 @@ $ ks-upa -h - Show help
```shell ```shell
1 - Edit User (anonymous) 1 - Edit User (anonymous)
2 - Edit Password (*******) 2 - Edit Password/PEM (*******)
3 - Edit Server (mypersonaldomain.es) 3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous) 4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos) 5 - Edit Local Path (/home/local/videos)
@ -85,6 +88,16 @@ $ ks-upa -h - Show help
* Choose an option: * Choose an option:
```` ````
### Generate certificate (on remote machine):
* To generate certificate for connect to remote machine, run the following command:
```shell
$ ks-upa -p
````
* Copy the file [user]-[hostname].pem to your machine.
### Show version: ### Show version:
* You can check the version with the command: * You can check the version with the command:

19
doc/ks-upf.md
View File

@ -9,6 +9,7 @@ $ ks-upf -g - Create configuration
$ ks-upf -r - Remove configuration $ ks-upf -r - Remove configuration
$ ks-upf -c - Show configuration $ ks-upf -c - Show configuration
$ ks-upf -e - Edit configuration $ ks-upf -e - Edit configuration
$ ks-upf -p - Generate certificate
$ ks-upf -v - Show version $ ks-upf -v - Show version
$ ks-upf -h - Show help $ ks-upf -h - Show help
``` ```
@ -25,10 +26,12 @@ $ ks-upf -h - Show help
```shell ```shell
* Enter the server user: anonymous * Enter the server user: anonymous
* Enter the server key: ******* * Enter the server password (type 'pem' for use pem certificate): *******
* Enter the server URL: mypersonaldomain.es * Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous * Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos * 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. * Once the connection data has been entered, the local directory will be scanned to detect file(s) and upload them to the server directory.
@ -53,7 +56,7 @@ $ ks-upf -h - Show help
```shell ```shell
* Server User: anonymous * Server User: anonymous
* Server Password: ******* * Server Password/PEM: *******
* URL (or IP) Server: mypersonaldomain.es * URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous * Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos * Scan Path (Local): /home/local/videos
@ -73,7 +76,7 @@ $ ks-upf -h - Show help
```shell ```shell
1 - Edit User (anonymous) 1 - Edit User (anonymous)
2 - Edit Password (*******) 2 - Edit Password/PEM (*******)
3 - Edit Server (mypersonaldomain.es) 3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous) 4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos) 5 - Edit Local Path (/home/local/videos)
@ -85,6 +88,16 @@ $ ks-upf -h - Show help
* Choose an option: * 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: ### Show version:
* You can check the version with the command: * You can check the version with the command:

21
doc/ks-upr.md
View File

@ -9,6 +9,7 @@ $ ks-upr -g - Create configuration
$ ks-upr -r - Remove configuration $ ks-upr -r - Remove configuration
$ ks-upr -c - Show configuration $ ks-upr -c - Show configuration
$ ks-upr -e - Edit configuration $ ks-upr -e - Edit configuration
$ ks-upr -p - Generate certificate
$ ks-upr -v - Show version $ ks-upr -v - Show version
$ ks-upr -h - Show help $ ks-upr -h - Show help
``` ```
@ -25,10 +26,12 @@ $ ks-upr -h - Show help
```shell ```shell
* Enter the server user: anonymous * Enter the server user: anonymous
* Enter the server key: ******* * Enter the server password (type 'pem' for use pem certificate): *******
* Enter the server URL: mypersonaldomain.es * Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous * Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos * 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 upload recursively them to the server directory. * Once the connection data has been entered, the local directory will be scanned to upload recursively them to the server directory.
@ -53,7 +56,7 @@ $ ks-upr -h - Show help
```shell ```shell
* Server User: anonymous * Server User: anonymous
* Server Password: ******* * Server Password/PEM: *******
* URL (or IP) Server: mypersonaldomain.es * URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous * Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos * Scan Path (Local): /home/local/videos
@ -73,18 +76,28 @@ $ ks-upr -h - Show help
```shell ```shell
1 - Edit User (anonymous) 1 - Edit User (anonymous)
2 - Edit Password (*******) 2 - Edit Password/PEM (*******)
3 - Edit Server (mypersonaldomain.es) 3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous) 4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos) 5 - Edit Local Path (/home/local/videos)
6 - Edit Upload Tool (scp) 6 - Edit Upload Tool (scp)
7 - Edit Port Connection (22) 7 - Edit Port Connection (22))
8 - Exit 8 - Exit
* Choose an option: * Choose an option:
```` ````
### Generate certificate (on remote machine):
* To generate certificate for connect to remote machine, run the following command:
```shell
$ ks-upr -p
````
* Copy the file [user]-[hostname].pem to your machine.
### Show version: ### Show version:
* You can check the version with the command: * You can check the version with the command:

19
doc/ks-upv.md
View File

@ -9,6 +9,7 @@ $ ks-upv -g - Create configuration
$ ks-upv -r - Remove configuration $ ks-upv -r - Remove configuration
$ ks-upv -c - Show configuration $ ks-upv -c - Show configuration
$ ks-upv -e - Edit configuration $ ks-upv -e - Edit configuration
$ ks-upv -p - Generate certificate
$ ks-upv -v - Show version $ ks-upv -v - Show version
$ ks-upv -h - Show help $ ks-upv -h - Show help
``` ```
@ -25,10 +26,12 @@ $ ks-upv -h - Show help
```shell ```shell
* Enter the server user: anonymous * Enter the server user: anonymous
* Enter the server key: ******* * Enter the server password (type 'pem' for use pem certificate): *******
* Enter the server URL: mypersonaldomain.es * Enter the server URL: mypersonaldomain.es
* Enter the path on the server: /home/anonymous * Enter the path on the server: /home/anonymous
* Enter the local path to scan: /home/local/videos * 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 the videos and upload them to the server directory. * Once the connection data has been entered, the local directory will be scanned to detect the videos and upload them to the server directory.
@ -53,7 +56,7 @@ $ ks-upv -h - Show help
```shell ```shell
* Server User: anonymous * Server User: anonymous
* Server Password: ******* * Server Password/PEM: *******
* URL (or IP) Server: mypersonaldomain.es * URL (or IP) Server: mypersonaldomain.es
* Destination Path (Server): /home/anonymous * Destination Path (Server): /home/anonymous
* Scan Path (Local): /home/local/videos * Scan Path (Local): /home/local/videos
@ -73,7 +76,7 @@ $ ks-upv -h - Show help
```shell ```shell
1 - Edit User (anonymous) 1 - Edit User (anonymous)
2 - Edit Password (*******) 2 - Edit Password/PEM (*******)
3 - Edit Server (mypersonaldomain.es) 3 - Edit Server (mypersonaldomain.es)
4 - Edit Dest. Path (/home/anonymous) 4 - Edit Dest. Path (/home/anonymous)
5 - Edit Local Path (/home/local/videos) 5 - Edit Local Path (/home/local/videos)
@ -85,6 +88,16 @@ $ ks-upv -h - Show help
* Choose an option: * Choose an option:
```` ````
### Generate certificate (on remote machine):
* To generate certificate for connect to remote machine, run the following command:
```shell
$ ks-upv -p
````
* Copy the file [user]-[hostname].pem to your machine.
### Show version: ### Show version:
* You can check the version with the command: * You can check the version with the command:

2
src/ks-upa
View File

@ -478,7 +478,7 @@ function showConfig() {
showPassword="${showPassword}*" showPassword="${showPassword}*"
totalchars=$(expr ${totalchars} + 1) totalchars=$(expr ${totalchars} + 1)
done done
echo "- Server Password: ${showPassword}" echo "- Server Password/PEM: ${showPassword}"
configAvailable=1 configAvailable=1
fi fi
if [ -f ${dirConfig}/ks-upload-server ] ; then if [ -f ${dirConfig}/ks-upload-server ] ; then

2
src/ks-upf
View File

@ -505,7 +505,7 @@ function showConfig() {
showPassword="${showPassword}*" showPassword="${showPassword}*"
totalchars=$(expr ${totalchars} + 1) totalchars=$(expr ${totalchars} + 1)
done done
echo "- Server Password: ${showPassword}" echo "- Server Password/PEM: ${showPassword}"
configAvailable=1 configAvailable=1
fi fi
if [ -f ${dirConfig}/ks-upload-server ] ; then if [ -f ${dirConfig}/ks-upload-server ] ; then

22
src/ks-upr
View File

@ -364,7 +364,7 @@ function showConfig() {
showPassword="${showPassword}*" showPassword="${showPassword}*"
totalchars=$(expr ${totalchars} + 1) totalchars=$(expr ${totalchars} + 1)
done done
echo "- Server Password: ${showPassword}" echo "- Server Password/PEM: ${showPassword}"
configAvailable=1 configAvailable=1
fi fi
if [ -f ${dirConfig}/ks-upload-server ] ; then if [ -f ${dirConfig}/ks-upload-server ] ; then
@ -420,7 +420,7 @@ function editConfig() {
editUpvTool=$(cat ${dirConfig}/ks-upload-tool 2> /dev/null) editUpvTool=$(cat ${dirConfig}/ks-upload-tool 2> /dev/null)
editUpvPort=$(cat ${dirConfig}/ks-upload-port 2> /dev/null) editUpvPort=$(cat ${dirConfig}/ks-upload-port 2> /dev/null)
echo "" echo ""
echo "* ks-upv (ks-tools) v${VERSION} (${M_DATE})" echo "* ks-upr (ks-tools) v${VERSION} (${M_DATE})"
echo "" echo ""
echo "+ Config: ${dirConfig}/ks-upload-*" echo "+ Config: ${dirConfig}/ks-upload-*"
echo "" echo ""
@ -530,12 +530,12 @@ function createConfig() {
# Start script # Start script
clear clear
echo "" echo ""
echo "* ks-upv (ks-tools) v${VERSION} (${M_DATE})" echo "* ks-upr (ks-tools) v${VERSION} (${M_DATE})"
echo "" echo ""
checkDependencies checkDependencies
# Ask the user and if it exists, read it from the config. # Ask the user and if it exists, read it from the config.
if [ -f ${dirConfig}/ks-upload-user ] ; then if [ -f ${dirConfig}/ks-upload-user ] ; then
echo "+ The USER configuration already exists (Use: 'ks-upv -e' for edit)" echo "+ The USER configuration already exists (Use: 'ks-upr -e' for edit)"
else else
echo -n "* Enter the server user: " ; read USER echo -n "* Enter the server user: " ; read USER
user=${USER} user=${USER}
@ -543,7 +543,7 @@ function createConfig() {
fi fi
# Ask the password and if it exists, read it from the config. # Ask the password and if it exists, read it from the config.
if [ -f ${dirConfig}/ks-upload-pass ] ; then if [ -f ${dirConfig}/ks-upload-pass ] ; then
echo "+ The PASSWORD/PEM configuration already exists (Use: 'ks-upv -e' for edit)" echo "+ The PASSWORD/PEM configuration already exists (Use: 'ks-upr -e' for edit)"
else else
echo -n "* Enter the server password (type 'pem' for use pem certificate): " ; read PASS echo -n "* Enter the server password (type 'pem' for use pem certificate): " ; read PASS
if [ "${PASS}" == "pem" ] ; then if [ "${PASS}" == "pem" ] ; then
@ -565,7 +565,7 @@ function createConfig() {
fi fi
# Ask the server URL and if it exists, read it from the config. # Ask the server URL and if it exists, read it from the config.
if [ -f ${dirConfig}/ks-upload-server ] ; then if [ -f ${dirConfig}/ks-upload-server ] ; then
echo "+ The SERVER configuration already exists (Use: 'ks-upv -e' for edit)" echo "+ The SERVER configuration already exists (Use: 'ks-upr -e' for edit)"
else else
echo -n "* Enter the server URL: " ; read SERVER echo -n "* Enter the server URL: " ; read SERVER
server=${SERVER} server=${SERVER}
@ -573,7 +573,7 @@ function createConfig() {
fi fi
# Ask the path on the server and if it exists, read it from the config. # Ask the path on the server and if it exists, read it from the config.
if [ -f ${dirConfig}/ks-upload-dirserver ] ; then if [ -f ${dirConfig}/ks-upload-dirserver ] ; then
echo "+ The SERVER PATH configuration already exists (Use: 'ks-upv -e' for edit)" echo "+ The SERVER PATH configuration already exists (Use: 'ks-upr -e' for edit)"
else else
echo -n "* Enter the path on the server: " ; read DIR_SERVER echo -n "* Enter the path on the server: " ; read DIR_SERVER
dirServer=${DIR_SERVER} dirServer=${DIR_SERVER}
@ -581,7 +581,7 @@ function createConfig() {
fi fi
# Ask the local path and if it exists, read it from the config. # Ask the local path and if it exists, read it from the config.
if [ -f ${dirConfig}/ks-upload-dirlocal ] ; then if [ -f ${dirConfig}/ks-upload-dirlocal ] ; then
echo "+ The LOCAL PATH configuration already exists (Use: 'ks-upv -e' for edit)" echo "+ The LOCAL PATH configuration already exists (Use: 'ks-upr -e' for edit)"
else else
echo -n "* Enter the local path to scan: " ; read DIR echo -n "* Enter the local path to scan: " ; read DIR
dirLocal=${DIR} dirLocal=${DIR}
@ -589,14 +589,14 @@ function createConfig() {
fi fi
# Configure upload tool by default # Configure upload tool by default
if [ -f ${dirConfig}/ks-upload-tool ] ; then if [ -f ${dirConfig}/ks-upload-tool ] ; then
echo "+ The UPLOAD TOOL configuration already exists (Use: 'ks-upv -e' for edit)" echo "+ The UPLOAD TOOL configuration already exists (Use: 'ks-upr -e' for edit)"
else else
echo "* Setting 'scp' as the default tool" echo "* Setting 'scp' as the default tool"
echo "scp" > ${dirConfig}/ks-upload-tool echo "scp" > ${dirConfig}/ks-upload-tool
fi fi
# Configure port by default # Configure port by default
if [ -f ${dirConfig}/ks-upload-port ] ; then if [ -f ${dirConfig}/ks-upload-port ] ; then
echo "+ The PORT configuration already exists (Use: 'ks-upv -e' for edit)" echo "+ The PORT configuration already exists (Use: 'ks-upr -e' for edit)"
else else
echo "* Setting port 22 as the default port" echo "* Setting port 22 as the default port"
echo "22" > ${dirConfig}/ks-upload-port echo "22" > ${dirConfig}/ks-upload-port
@ -628,7 +628,7 @@ function showHelp() {
echo " $ ks-upr -r - Remove configuration" echo " $ ks-upr -r - Remove configuration"
echo " $ ks-upr -c - Show configuration" echo " $ ks-upr -c - Show configuration"
echo " $ ks-upr -e - Edit configuration" echo " $ ks-upr -e - Edit configuration"
echo " $ ks-upv -p - Generate certificate" echo " $ ks-upr -p - Generate certificate"
echo " $ ks-upr -v - Show version" echo " $ ks-upr -v - Show version"
echo " $ ks-upr -h - Show help" echo " $ ks-upr -h - Show help"
echo "" echo ""

2
src/ks-upv
View File

@ -478,7 +478,7 @@ function showConfig() {
showPassword="${showPassword}*" showPassword="${showPassword}*"
totalchars=$(expr ${totalchars} + 1) totalchars=$(expr ${totalchars} + 1)
done done
echo "- Server Password: ${showPassword}" echo "- Server Password/PEM: ${showPassword}"
configAvailable=1 configAvailable=1
fi fi
if [ -f ${dirConfig}/ks-upload-server ] ; then if [ -f ${dirConfig}/ks-upload-server ] ; then