Skip to content

Kasm Registry Version 1.0.0r1

Latest
Latest
Compare
Choose a tag to compare
@doctorfree doctorfree released this 22 Dec 01:58
· 12 commits to 1.0 since this release
v1.0.0r1
b5b0a10

Logo

Record Technologies Workspace Registry

The repository at https://github.com/doctorfree/kasm-registry is home to the Record Technologies Kasm Workspaces registry. A front end website is automatically generated for the registry looking similar to:

Registry

Table of Contents

Record Technologies Workspaces

This registry primarily serves as the distribution mechanism for Kasm workspaces generated from Doctorfree Open Source Projects.

Currently available workspaces in this registry include:

  • AppImage: Customized Ubuntu 22.04 desktop with AppImage Launcher
  • Asciiville: Ascii art, utilities, games, more
  • CloudStorage: Utilizes rclone, a command-line program to manage files on cloud storage
  • Deluxe: Asciiville, Neovim, Spiderfoot, Wing and more all in one workspace
  • LM Studio: Customized Ubuntu 22.04 desktop with LM Studio
  • Neovim: Neovim, neovide, lazyman, much more
  • Open-Source Intelligence: Reconnaissance tool, forensics, link analyzer, ...
  • Project Jupyter: Jupyter notebooks
  • Spiderfoot: A reconnaissance tool that automatically queries public data sources to gather intelligence
  • Ubuntu desktops: Customized Ubuntu Focal and Jammy desktops
  • Wing cloud programming language: Wing programming language, examples, and editors
  • WingPlus: The Wing workspace with the Neovim hyper-extensible text editor
  • More to come ...

Workspace features

Record Technologies workspaces all include customized desktops with several productivity and development packages preconfigured for ease of use. In addition to the rich feature set provided by the base images upon which these workspaces are built, Record Technologies workspaces provide advanced configuration and integration of many additional components including:

  • Bat: A cat(1) clone with wings
  • Btop: Resource monitor
  • Cheat Sheets: Cheat sheets Obsidian vault
    • Integrated with ranger and glow for terminal/console viewing
  • Fzf: A command-line fuzzy finder
  • Glow: Markdown previewer
  • Go: A modern version of the Go programming language is installed
  • Kitty: The fast, feature-rich, GPU based terminal emulator
  • Lsd: The next generation ls command
  • Neofetch: System information tool
  • Node: Node version 20
    • Nvm: Node version manager
  • Nerd Fonts: Large number of extra glyphs and icons
  • Obsidian: Markdown based personal knowledge base and note-taking application
  • Ranger: A Vim-inspired file manager for the terminal
    • Extensive configuration for the Ranger file executor/opener rifle
    • Integration with Glow, AppImage, Wing, and more for execution/opening of selections
  • Vim: Preconfigured vim text editor with plugins, keymaps, theme, etc
  • Xfce4: Customized Xfce desktop environment
  • Zoxide: Smart cd command
  • Zsh: Features from bash, ksh, tcsh, and more

The Wing workspaces include Visual Studio Code with the Wing extension; the Neovim workspaces include Neovide and Lazyman - the Neovim Configuration Manager, several workspaces include the Ranger File Manager with customized launch configurations and the Btop++ system monitor with customized configuration and theme.

In most Record Technologies workspaces the Kitty terminal emulator is installed along with the JetBrains Mono Nerd Font. Kitty is preconfigured and Kitty sessions are tailored for each use case.

Where appropriate Record Technologies workspaces perform a postinstall which installs and configures many additional utilities in the Kasm user's home directory. When used in conjunction with Kasm persistent profiles this feature enables a rich persistent user runtime environment across workspace sessions.

Workspace deployment

All Record Technologies workspaces are designed for deployment using Kasm Workspaces. The Docker images can be deployed directly with Docker but they will not provide persistent user profiles and thus will not be as usable, requiring initialization on every start. The use of Kasm Workspaces for deployment is strongly encouraged.

To deploy using Kasm Workspaces, add the Record Technologies registry to your Kasm deployment by visiting the Record Technologies workspace registry and clicking on the Workspace Registry Link. This will copy https://doctorfree.github.io/kasm-registry/ to your clipboard.

Once you have the Workspace Registry Link for Record Technologies, in Kasm as an administrator click on Workspaces -> Registry -> Registries. Click Add new and enter the Record Technologies registry link copied above. Click ADD REGISTRY and you should now see the Record Technologies workspaces in Kasm.

After adding a 3rd party workspace registry to Kasm, clicking on Workspaces -> Registry should now show the new registry under Available Workspaces. Clicking on Record Technologies will filter the available workspaces and display only those workspaces available from Record Technologies.

Click on any of the Record Technologies workspaces and then click Install to install that workspace. Once installed go to Workspaces -> Workspaces and click the right arrow button on the right hand side of the newly installed workspace then click the pencil icon to edit the workspace. Adjust any of the settings you like but most importantly scroll down to the Persistent Profile Path and add a path to save changes users make to their workspace. I use the following setting for a persistent profile:

/u/kasm_profiles/{image_id}/{user_id}

Where the /u/kasm_profiles/ folder has been created on the Kasm host. Note that this folder can grow quite large depending on how many workspaces are configured to use it and how many users are active. I place this folder along with any volume mappings and the Docker library folders on a large second drive using XFS.

Docker deployment

These images are designed for use as streaming containers in Kasm. However, they can be run using docker. For example, to run the Wing workspace:

# Pull the image from Docker Hub
docker pull doctorwhen/kasm:wing
myip=`ip addr show | awk '$1 == "inet" && $3 == "brd" { sub (/\/.*/,""); print $2 }' | head -1`

printf "\n\nThe Wing container is now accessible via a browser : https://${myip}:6901"
printf "\n\tUser : kasm_user"
printf "\n\tPassword: password\n"

docker run --rm  -it --shm-size=512m -p 3000:3000 -p 6901:6901 -e VNC_PW=password doctorwhen/kasm:wing

NOTE: Several of the Record Technologies Kasm workspaces perform extensive post-installation configuration. For this reason they are not well suited for use with docker run ... since each time they are run in this manner they will perform the time consuming initialization. The recommended use for these images is as Kasm Workspaces streamed containers with a persistent profile configured.

Repository template

This repository was created from the registry repository template at https://github.com/kasmtech/workspaces_registry_template.

Schema

Version 1.0

Property Required Type Description
friendly_name True String The name to show
name True String The docker image to use
description True String A short description of the workspace
image_src True String The name of the workspace icon used
architecture True Array Json list containing either "amd64", "arm64" or both
compatability True Array A list of Kasm versions the workspace should work with
uncompressed_size_mb True Integer Integer of the approximate size of the workspace when it's uncompressed in MB. This doesn't take into account layers. For example if an image is 2.46GB you would enter 2460
categories False Array Json list containing the categories the workspace belongs too. This should be limited to a max of 3.
docker_registry False String Which docker registry to use
run_config False Object Any additional parameters to add to the run config
exec_config False Object Any additional parameters to add to the exec config
notes False String Notes about running the workspace, such as if it requires libseccomp.
cores False Integer Specify the amount of cores to use for this workspace
memory False Integer Specify the amount of memory to use for this workspace
gpu_count False Integer Specify the amount of GPUs to use for this workspace
cpu_allocation_method False String What CPU allocation method to use for this workspace. Can be either "Inherit", "Quotas" or "Shares"

Head to the Actions tab to check your progress and once Page build and deployment is complete, your site should be ready.

New schema version

When a new schema version comes out, you just need to create a new branch that refrlects the new schema, for example 1.1 and make it the default branch.

In the new branch, make any updates that are needed, when the changes are committed a new version will be built.

Kasm Workspaces will automatically pull the version of the schema that it understands.

 

Discovery

The tag below will hopefully make it easier for people to find your Workspace Registry by clicking on this github search link. If you want to make it harder to find your repository for some reason, just remove this section.

If you are the one doing the searching, click on the site folder, then click on next.config.js and the url can be found under env.listUrl

search-600

Assets 2
Loading