From a7c9c67938fbc179b354b6b8b0b49011ccf50d50 Mon Sep 17 00:00:00 2001 From: Levi Neely <141506390+lneely@users.noreply.github.com> Date: Thu, 27 Jun 2024 23:18:00 +0200 Subject: [PATCH] Update README.md --- README.md | 115 ++++++++++++++++++++++-------------------------------- 1 file changed, 47 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 587cf02..8dba02b 100644 --- a/README.md +++ b/README.md @@ -20,99 +20,78 @@ This version of pcloudcc is independently maintained by me, whose only affiliati Also requires [CMake](https://cmake.org/) build system. -On Ubuntu you can run the following command: -> sudo apt-get install cmake zlib1g-dev libboost-system-dev libboost-program-options-dev libpthread-stubs0-dev libfuse-dev libudev-dev ## Build steps -> sudo apt-get install cmake zlib1g-dev libboost-system-dev libboost-program-options-dev libpthread-stubs0-dev libfuse-dev libudev-dev fuse build-essential git -> mkdir console-client -> git clone https://github.com/pcloudcom/console-client.git ./console-client/ -> cd ./console-client/pCloudCC/ -> cd lib/pclsync/ -> make clean -> make fs -> cd ../mbedtls/ -> cmake . -> make clean -> make -> cd ../.. -> cmake . -> make -> sudo make install -> sudo ldconfig -> pcloudcc -u username -p +> make ## Usage Terminal command is pcloudcc and -h option prints short options description. -> ./pcloudcc -h -> pCloud console client v.2.0.1 ->Allowed options: -> -h [ --help ] produce help message -> -u [ --username ] arg pCloud account name -> -p [ --password ] pCloud account password -> -c [ --crypto ] arg Crypto password -> -y [ --passascrypto ] arg Use user password as crypto password also. -> -d [ --daemonize ] Daemonize the process. -> -o [ --commands ] Parent stays alive and processes commands. -> -m [ --mountpoint ] arg Mount point where drive to be mounted. -> -k [ --commands_only ] Daemon already started pass only commands. -> -n [ --newuser ] Switch if this is a new user to be registered. -> -s [ --savepassword ] Save password in database. - +> pcloudcc -h Also there are several commands that the running service can execute. Commands are passed using > pcloudcc -k -or starting the daemon with -o. +or starting the daemon with -o to run a command prompt after starting the daemon. +> pcloudcc -o -Available commands are : startcrypto , stopcrypto, finalize, q, quit -- startcrypto - starts cripto using given password. -- stopcrypto – stops the crypto. -- finalize – stops the running daemon. -- quit, q - exits the current client. Daemon stays alive. +## Command Prompt + +> startcrypto - use your password to unlock the crypto folder +> stopcrypto – lock the crypto folder +> finalize – stops the running daemon. +> quit, q - exits the command prompt, daemon continues running in background + +### First Use + +Start the service in the foreground using the -p switch to enter your +password, and the -s switch to save the password to the +database. Verify that file system starts and mounts normally after the + +> pcloudcc -u example@myemail.com -p -s -Example usage scenario: -- Start the service manually +### Registration -> pcloudcc -u example@myemail.com -p -s - -Enter password and use -s switch to save the password. - -- Verify that file system starts and mounts normally. If you don't have existing user use -n switch to register new user: +If you don't have existing user use -n switch to register new user: > pcloudcc -u example@myemail.com -p -s -n -Notice that a new user may take a while to mount. Please, be patient. +Notice that a new user may take a while to mount. Please, be patient. -- Start the daemon service: +### Run as Daemon -> pcloudcc -u example@myemail.com -d +If you have saved your password, then you can run pcloudcc as a +background daemon. Verify the filesystem is mounted when the daemon +starts. -- Verify file system is mounted. +> pcloudcc -u example@myemail.com -d -- At that point you can test passing some commands. +### Command Prompt -> pcloudcc -u example@myemail.com -k +Use the command prompt to interact with a running daemon. -Or starting the daemon with -o. Test unlocking and locking crypto if you have subscription for it. +> pcloudcc -u example@myemail.com -k -- Quit the client. Congratulations, your pcloud console client works properly. You can now add “pcloudcc -u example@myemail.com -d” command in you startup scripts and thous mount the file system on startup. +Test unlocking and locking crypto if you have subscription for it. -**Notice that stopping daemon will break pending background transfers!** +> startcrypto {yourpassword} +> stopcrypto +> quit -Current version of `pcloudcc` doesn't support command to check if threre are pending transfers. -Locally cached files are located under `~/.pcloud/Cache` dir. When there is only one file `~/.pcloud/Cache/cached` (ususally big sized) this mean that transfers are completed. +### Startup -## Debian -To create a debian package form the source use: -> debuild -i -us -uc -b +When everything is configured, you can run pcloudcc as a daemon on +system startup by adding the following command to your startup scripts +(distribution-specific): + +> pcloudcc -u example@myemail.com -d + +## Warning + +**Stopping daemon will break pending background transfers!** +`pcloudcc` does not currently provide a command to check for pending +transfers. You can currently check this by ensuring there is only one +file named `cached` in `~/.pcloud/Cache`. Usually this is a large +file. -## Older pre-built packages (no EU server supprt) -- Ubuntu 18.04 64 bit - [pcloudcc_2.1.0-1_amd64_ubuntu.18.04.deb](https://my.pcloud.com/publink/show?code=XZvLyi7Zsz7t1H0aYIFiawL4LSgN3uxLBUJX) -- Debian 9.9 64 bit - [pcloudcc_2.1.0-1_amd64_debian.9.9.deb](https://my.pcloud.com/publink/show?code=XZYVyi7ZseHyB89XXK0lVAdyy0AwQYl7osU7) -- Debian 9.9 32 bit - [pcloudcc_2.1.0-1_i386_debian.9.9.deb](https://my.pcloud.com/publink/show?code=XZuVyi7ZLevxTwQKGrSrxp8uIrQodBwDfX67)