Glasswall Desktop is a desktop application that provides multi file drag and drop rebuild workflow.
Avatar | Name | Role | Time Zone |
---|---|---|---|
Sudhidh Kumar @kumarsudhish | Delivery Manager/QA | IST | |
Sanchit Garg @rajmbcoderx | Member | IST | |
Mudit Gupta @gmuditdce | Member | IST | |
Nishant Swarup @nishantswarup | Member | IST |
Objective:
- Just drag and drop the files from your local hard disk, and the Glasswall Desktop will rebuild them using the Glasswall Rebuild API (currently hosted on Azure).
- To support different directory structures, give freedom to save the files at custom directory structure or at default location by maintaining the same directory as that of the parent folder.
- To support different platforms (Windows, MAC and Linux)
- To provide online and offline file-rebuild support. The online version to use glasswall-rebuild cloud hosting of rebuild engine to rebuild files. The offline version to use glasswall docker image to provide the ame functions offline.
Key Results:
- Build with Electron , react, it is aimed at providing multi file drag and drop rebuild workflow.
- It is a standalone application for MacOS, Windows and Linux operating systems.
Setup:
- Clone the repo to your local directory
- Navigate to the directory where package.json is placed
- Run
npm install
. This will install required packages for this project which has been mentioned in the package.json
Run:
- To build the source code
npm run build
. Build is requried to compile typescript - To start the application locally
npm run start
Distribution Package:
- To create distribution packages
npm run dist
. This will create the build binaries/exe to Mac, Windows, Linux platforms in the dist folder.
- If you are working on this project via Upwork, see also our Upwork Rules of Engagement
- If you are newcomer, then please check Glasswall newcomers checklist
Warning: This software is under active development. Use at your own risk.
Download the latest glasswall-desktop release.
Mac users will need to follow the below steps on the app when you first launch it, until we have code signing set up
- Step 1
- Step 2
- Step 3
TBD: Will automatically update when a new release is available.
Download the latest glasswall-desktop release
Windows users will need to follow the below steps to install and launch the application.
-
Step 1 Download the package from the above link, observe that .exe executable would be downloaded, glasswall-desktop-Setup-1.0.1.exe.
-
Step 2 Once executable has been downloaded, double click on the .exe and observe that installation starts.
- Step 3 Observe that once the installation is complete, app is launched successfully showcasing the Welcome page
- Step 4 Click on Get Started to navigate to the Rebuild Files page.
- Step 5
Rebuild offline with glasswall docker
-
Prerequisite - Ensure docker is installed on the machine running the rebuild with docker. Platform specific installation guides are avalaible at https://docs.docker.com/engine/install/
-
Click on the "Docker" icon in the sidebar menu.
-
Choose the files to rebuild and the target directory.
-
For first time installations, the application will pull the glasswallsolutions/evaluationsdk:1 docker image from docker-hub registry.
- For first time rebuild, the application will ask for user permission to share file systems with docker
Allow by clicking "Share It".
-
To avoid this notification in future, note the "temp" directory that the application asks to allow access to. Follow below steps to add this directory permanently in docker file sharing settings to avoid these notifications in the future
-
Open "Docker-Settings" from systemtray
- Open "File-Sharing" tab and click on the "+" icon
- Add the diectory noted above, for which the notification appears
Once added, further rebuilds will not prompt to allow sharing the directory each time when using docker to rebuild files.
Glasswall desktop is only available for 64-bit Linux systems. Download the latest glasswall-desktop release
Linux/Ubuntu users will need to follow the below steps on the app when you first launch it.
- Step 1 Install the snapd package if not present in the linux/ubuntu version you are using.
- Step 2 Once snapd package has been installed verify it has been installed successfully by running below command.
- Step 3 Unzip the downloaded desktop package and move inside the directory. And run below command to install the package
- Step 4 Run below command to launch the desktop application
- Clone the repo
- Open the command prompt (On windows) and terminal on (Ubuntu/Linux/MAC)
- Run
npm install
npm run build
npm run start
To configure the codebase clone or download the codebase from the git and install the Visual Studio Code
- Click on File in the Visul Studio tool bar.
- Select Open Folder option.
- Select the cloned glasswall-desktop folder.
- Observe that Project has been imported.
To release the linux version following steps are required
- Create Ubuntu One account on https://login.ubuntu.com/
- After creating Ubuntu One account login to https://snapcraft.io/ using account created in step 1
- Follow the instruction to register your app https://snapcraft.io/docs/registering-your-app-name app name will be "glasswall-desktop"
- After app name registration export the login credential using "snapcraft export-login --snaps SNAP_NAME --channels edge -" command.
- Copy the output of the command and add it as a github secret with name "snapcraft_token". Link on how to add secrets in github account https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
Please change DEBUG variable to true and restart the app to start the electron debugger for code debugging purposes.
- Rebuild App: Signed build needs to be created for rebuild desktop app.
- On selecting Hierarchy radio button, and uploading folder in single Hierarchy files are not getting saved in same Hierarchy format in target folder.
- Upgrade installer not working on MAC OS
- For Complete list of open issue can be found here Glasswall Desktop App Open Issues
Bug reports are welcome on GitHub at https://github.com/k8-proxy/glasswall-desktop
- MAC Application: Incase of cloud rebuild failure, follow below steps:
- Delete the config folder under this path /Users//Library/Application\Support/glasswall-desktop
- On command prompt run this command *rm -rf config ** to delete all the content in above path