This repository is a template you can use to create your own registry that will work with Kasm Workspaces. A front end website is automatically generated for you and will look similar to the one below.

1. Create your own repository
   • Use this template
   • Configure repository
2. Check workflows are running
3. Edit the config variables
   • Modify next.config.js
   • Settings definitions
   • Commit changes
4. Set up GitHub pages
   • Initial setup
   • Visit the site
   • Check build progress
   • Checking it works
5. Creating Workspaces
   • Folder structure
   • Schema
   • New schema version
6. Discovery

1. Click on the green Use this template button.
2. Select Create a new repository from the dropdown.

Note If you set the Repository name to kasm-registry you wont have to make any changes to the baseUrl later, unless you want to use a (sub)domain.

1. Select a Repository name, this name will also be used later for the baseUrl,
2. Make sure it's set as a Public repository
3. Tick the Include all branches checkbox,
4. Click on the Create repository from template button.

Note If you see something in the table that looks similar to the above then it's working. If it needs enabling this section will probably be blank with a message about workflows needing to be enabled.

Click on the Actions tab in the top menu and check whether workflows need enabling, if they do, enable them, otherwise you should be good to go.

1. Go back to the Code tab
2. Click the site folder
3. Click on the next.config.js file
4. Click the edit button.
5. Fill in the env section with the relevant information and change the basePath if needed (details below).

1. Scroll down to the bottom of the page
2. Enter a commit message (You can also leave this blank)
3. Click the Commit changes button.

Note If you ticked the "Include all branches" checkbox in step 1, this should all be set up for you, if not, just follow the instructions below

1. Go to the Settings top menu tab
2. Click the Pages left menu item
3. In the Build and deployment section, under the Branch heading, make sure the dropdown is set to gh-pages, if not, set it and click Save.

If you see a message like the following:

Then congratulations, you should have a working site! Just click the Visit Site button. However, you changes may not have finished building yet, so before clicking the button it's advised to check the build process first.

If you don't see that button yet, then not to worry, it's likely that you are just too quick (also if you do see the button but it doesn't reflect the changes you made, this next bit is relevant as well)

Check on the CI progress in the Actions tab,

Once Page build and deployment is finished go back to Settings / Pages and you should have a live site. Click on the Visit Site button.

You should now have a working site which includes any workspaces you added or the default if you haven't made any changes yet

Note If you copy the url from the address bar instead of clicking the button, be sure to remove the branch version from the URL when adding to workspaces, otherwise it wont work.

1. Click on the Workspace Registry Link button, this will put the correct url in your clipboard.
2. Go to your Kasm Workspaces instance.
3. Navigate to the Workspaces Registry (Admin / Workspaces / Click on the Workspaces Registry button).
4. Click on Add new in the registries list.
5. Paste the URL into the text box and click Add Registry
6. Click on the mini icon under the registry name to filter by your registries workspaces

Once you are ready to upload your workspaces, head back to the Code tab. You can either continue using the online editor or you might find it easier to clone the repository and work on a local copy, it's up to you. For this example we will continue with the online editor.

All workspaces reside in the workspaces folder

You will need to create a folder and the necessary files using the following format:

Workspace Name
- workspace.json
- workspace-name.png

Folder name - The folder name can be whatever it needs to be. You probably want to stay clear of special characters to be on the safe side, but spaces should be fine.

workspace.json - This is a JSON file with all the parameters you want to be sent to Kasm Workspaces when it builds the container. You can see the valid paramaters in the schema section and whether they are required or not.

{
  "description": "Visual Studio Code is a code editor redefined and optimized for building and debugging modern web and cloud applications.",
  "docker_registry": "https://index.docker.io/v1/",
  "name": "kasmweb/vs-code:develop",
  "image_src": "vs-code.png",
  "categories": [
    "Development"
  ],
  "friendly_name": "Visual Studio Code",
  "architecture": [
    "amd64",
    "arm64"
  ],
  "compatibility": [
    "1.13.x"
  ],
  "uncompressed_size_mb": 2170
}

Image file - The image can be .png or .svg and ideally will be square and at least 50 x 50px. If you use the workspace builder on your registry store front it will try to normalise everything to make it simpler.

Don't forget to commit your changes!

Version 1.0

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

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.

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

KASM-REGISTRY-DISCOVERY-IDENTIFIER