Merge pull request #70 from internxt/fix/readme-webdav-instructions

[]: Fix/readme webdav instructions

.env.template

@@ -1,11 +1,11 @@
-DRIVE_URL=
-DRIVE_API_URL=
-DRIVE_NEW_API_URL=
-PAYMENTS_API_URL=
-PHOTOS_API_URL=
-NETWORK_URL=
-APP_CRYPTO_SECRET=
-APP_CRYPTO_SECRET2=
-APP_MAGIC_IV=
-APP_MAGIC_SALT=
-WEBDAV_SERVER_PORT=
+DRIVE_URL=https://drive.internxt.com
+DRIVE_API_URL=https://drive.internxt.com/api
+DRIVE_NEW_API_URL=https://api.internxt.com/drive
+PAYMENTS_API_URL=https://api.internxt.com/payments
+PHOTOS_API_URL=https://photos.internxt.com/api
+NETWORK_URL=https://api.internxt.com
+APP_CRYPTO_SECRET=6KYQBP847D4ATSFA
+APP_CRYPTO_SECRET2=8Q8VMUE3BJZV87GT
+APP_MAGIC_IV=d139cb9a2cd17092e79e1861cf9d7023
+APP_MAGIC_SALT=38dce0391b49efba88dbc8c39ebf868f0267eb110bb0012ab27dc52a528d61b1d1ed9d76f400ff58e3240028442b1eab9bb84e111d9dadd997982dbde9dbd25e
+WEBDAV_SERVER_PORT=3005

README.md

@@ -14,18 +14,14 @@ A CLI tool to interact with yout Internxt encrypted files
 
 # Installation
 
-Binaries and specific installers are available in the latest release:
-
-[View Internxt CLI latest release here](https://github.com/internxt/cli/releases/latest)
-
-You can install the Internxt CLI in different ways:
-
-### NPM
+You can install the Internxt CLI by using NPM:
 
 Requires Node >= 20.0.0
 
 `npm i -g @internxt/cli`
 
+[View Internxt CLI latest release here](https://www.npmjs.com/package/@internxt/cli)
+
 # Usage
 
 <!-- usage -->
@@ -310,3 +306,7 @@ EXAMPLES
 
 _See code: [src/commands/whoami.ts](https://github.com/internxt/cli/blob/v0.1.19/src/commands/whoami.ts)_
 <!-- commandsstop -->
+
+# Current Limitations
+
+- We currently have a 5GB size upload limitation per file for both, CLI and WebDAV

WEBDAV.md

@@ -4,6 +4,8 @@ The Internxt CLI comes with built in WebDav support.
 
 ## How it works
 
+When you login with Internxt CLI, your auth tokens and your decrypted mnemonic are stored in your local home folder. These data will be used for both the CLI and WebDAV. Restarting the computer or uninstalling the CLI will not erase this configuration. The only way to properly clean up this configuration is by explicitly using the logout command or by removing the '.internxt-cli' folder located in your home directory.
+
 The WebDav feature works by exposing a local only server in your machine when enabled.
 
 - When you download a file, the WebDav local server decrypts your data and sends it to the WebDav client
@@ -13,13 +15,14 @@ No plain data is being sent or is being pulled from the Internxt servers, you ca
 
 ![image](https://raw.githubusercontent.com/internxt/cli/main/public/webdav-how-it-works.png)
 
+*We currently have a 5GB size upload limitation per file for both, CLI and WebDAV*
+
 ## Officially supported WebDav clients
 
 Below you can find a list of WebDav clients that we officially support in the Internxt CLI
 
 |                       | Supported |
 | --------------------- | --------- |
-| Windows Explorer      | ✅        |
 | MacOS Finder          | ✅        |
 | CyberDuck for Windows | ✅        |
 | CyberDuck for MacOS   | ✅        |
@@ -42,12 +45,22 @@ Find below the methods that are supported in the latest version of the Internxt
 | PROPPATCH | ❌        |
 | MKCOL     | ❌        |
 | COPY      | ❌        |
+| MOVE      | ❌        |
+
+## Requisites
+
+- Installed Node >= v20.0.0
+- Internxt CLI is installed on its latest version
 
 ## Usage
 
+- Log into your account with `internxt login`
 - Enable WebDav with `internxt webdav enable`
+- Access your files via WebDAV with any of our supported clients by using https://webdav.local.internxt.com:3005 or https://127.0.0.1:3005
 - Disable WebDav with `internxt webdav disable`
 
 ## Known issues
 
 - We use selfsigned certificates, so all the requests to the WebDav local server are encrypted, since the certificates are selfsigned, many WebDav clients will complain about the certificates trust. You can safely ignore this warning.
+
+- You may encounter issues with the DNS resolution of webdav.local.internxt.com. In such cases, you can safely replace this address with 127.0.0.1, or the corresponding IP where you have deployed the webdav server if you are connecting from another location.

package.json

@@ -12,6 +12,7 @@
     "test:unit": "nyc --reporter=lcov --reporter=text mocha \"test/**/*.test.ts\" --exit",
     "dev:webdav": "nodemon -e ts --exec ts-node src/webdav/index.ts",
     "version": "oclif readme && git add README.md",
+    "pack:win": "oclif pack win",
     "migrate": "sequelize db:migrate",
     "migrate:undo": "sequelize db:migrate:undo",
     "publish:npm": "npm run build && npm publish --scope=@internxt --registry=https://registry.npmjs.org/ --access public",